Class for working with primitive mesh which represents like corethread prim. More...

#include <SCoreThreadPrim.h>

Public Types
enum	Mode
	Operations with meshes. More...

Public Member Functions
	CoreThreadPrim ()
	Constructor for creating of core thread primitive. More...

cthpm_t *	cthpm_t_ptr () const
	Converts the pointer to base class to a pointer to this class. More...

float	Length () const
	Gets the length of core thread primitive. More...

CoreThreadPrim &	Length (const float &L)
	Sets the length of core thread primitive. More...

virtual float	Diameter () const
	Gets the diameter of core thread. More...

virtual CoreThreadPrim &	Diameter (const float &D)
	Sets the diameter of core thread. More...

float	BottomDiameter () const
	Gets the bottom diameter of core thread. More...

CoreThreadPrim &	BottomDiameter (const float &D)
	Sets the bottom diameter of core thread. More...

float	ThreadLength () const
	Gets the length of core thread. More...

CoreThreadPrim &	ThreadLength (const float &L)
	Sets the length of core thread. More...

bool	UseThread () const
	Gets the use thread flag. More...

CoreThreadPrim &	UseThread (const bool &b)
	Sets the use thread flag. More...

virtual ProfileType	Profile () const
	Gets the type of profile for thread. More...

virtual CoreThreadPrim &	Profile (const ProfileType &prof)
	Sets the type of profile for thread. More...

virtual float	Pitch () const
	Gets the pitch value for thread. More...

virtual CoreThreadPrim &	Pitch (const float &pitch)
	Sets the pitch value for thread. More...

virtual float	Height () const
	Gets the height of core thread. More...

virtual CoreThreadPrim &	Height (const float &h)
	Sets the height of core thread. More...

bool	UseCone () const
	Gets the use cone flag. More...

CoreThreadPrim &	UseCone (const bool &b)
	Sets the use cone flag. More...

fstn_prm_t *	fstn_prm_ptr () const
	Converts the pointer to base class. More...

virtual void	update ()
	Update parameters. More...

void	UpdateModel ()
	Update model on click to place action. More...

void	StoreFP (FPRec &fp)
	Store of the scale radius, clickToPlace and positions More...

void	RestoreFP (const FPRec &fp)
	Restore of the scale radius, clickToPlace and positions More...

virtual CoreThreadPrim &	Position (const Vec3 &c)
	Setter for object position. More...

virtual Vec3	Position () const
	Getter for object position. More...

virtual CoreThreadPrim &	Position2 (const Vec3 &c)
	Sets the position2 for object. More...

virtual Vec3	Position2 () const
	Gets the position2 for object. More...

virtual CoreThreadPrim &	ScaleRadius (const float &r)
	Sets the scale radius. More...

virtual float	ScaleRadius () const
	Gets the scale radius. More...

virtual CoreThreadPrim &	ClickToPlace (const float &brushRadius)
	Click to place. More...

virtual CoreThreadPrim &	ResetSize ()
	Reset the size object. More...

virtual CoreThreadPrim &	ResetPosition ()
	Reset the position object. More...

virtual CoreThreadPrim &	ResetAxis ()
	Reset the axies. More...

CoreThreadPrim &	AxisX (const Vec3 &ax)
	Setter for Axis X. More...

Vec3	AxisX () const
	Getter for Axis X. More...

CoreThreadPrim &	AxisY (const Vec3 &ay)
	Setter for Axis Y. More...

Vec3	AxisY () const
	Getter for Axis Y. More...

CoreThreadPrim &	AxisZ (const Vec3 &az)
	Setter for Axis Z. More...

Vec3	AxisZ () const
	Getter for Axis Z. More...

Detailed Description

Class for working with primitive mesh which represents like corethread prim.

See Also: CoreThreadPrim for notes.

Since: 5.0.0

Inheritance diagram for coat::scripto::CoreThreadPrim:

Member Enumeration Documentation

enum coat::scripto::BasePrim::Mode

stronginherited

Operations with meshes.

Constructor & Destructor Documentation

coat::scripto::CoreThreadPrim::CoreThreadPrim ( )

inline

Constructor for creating of core thread primitive.

Member Function Documentation

CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::AxisX ( const Vec3 & ax )

inlineinherited

Setter for Axis X.

Parameters

ax	The axis vector

Vec3 coat::scripto::IFastenerBasePrim< CoreThreadPrim >::AxisX ( ) const

inlineinherited

Getter for Axis X.

CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::AxisY ( const Vec3 & ay )

inlineinherited

Setter for Axis Y.

Parameters

ay	The axis vector

Vec3 coat::scripto::IFastenerBasePrim< CoreThreadPrim >::AxisY ( ) const

inlineinherited

Getter for Axis Y.

CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::AxisZ ( const Vec3 & az )

inlineinherited

Setter for Axis Z.

Parameters

az	The axis vector

Vec3 coat::scripto::IFastenerBasePrim< CoreThreadPrim >::AxisZ ( ) const

inlineinherited

Getter for Axis Z.

float coat::scripto::CoreThreadPrim::BottomDiameter ( ) const

inline

Gets the bottom diameter of core thread.

References cthpm_t_ptr().

CoreThreadPrim& coat::scripto::CoreThreadPrim::BottomDiameter ( const float & D )

inline

Sets the bottom diameter of core thread.

References cthpm_t_ptr().

virtual CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::ClickToPlace ( const float & brushRadius )

inlinevirtualinherited

Click to place.

Parameters

brushRadius The brush radius for placement

cthpm_t* coat::scripto::CoreThreadPrim::cthpm_t_ptr ( ) const

inline

Converts the pointer to base class to a pointer to this class.

Referenced by BottomDiameter(), Diameter(), Height(), Length(), Pitch(), Profile(), ThreadLength(), UseCone(), and UseThread().

virtual float coat::scripto::CoreThreadPrim::Diameter ( ) const

inlinevirtual

Gets the diameter of core thread.

References cthpm_t_ptr().

virtual CoreThreadPrim& coat::scripto::CoreThreadPrim::Diameter ( const float & D )

inlinevirtual

Sets the diameter of core thread.

References cthpm_t_ptr().

fstn_prm_t* coat::scripto::IFastenerBasePrim< CoreThreadPrim >::fstn_prm_ptr ( ) const

inlineinherited

Converts the pointer to base class.

virtual float coat::scripto::CoreThreadPrim::Height ( ) const

inlinevirtual

Gets the height of core thread.

References cthpm_t_ptr().

virtual CoreThreadPrim& coat::scripto::CoreThreadPrim::Height ( const float & h )

inlinevirtual

Sets the height of core thread.

References cthpm_t_ptr().

float coat::scripto::CoreThreadPrim::Length ( ) const

inline

Gets the length of core thread primitive.

Returns: Returns the length

References cthpm_t_ptr().

CoreThreadPrim& coat::scripto::CoreThreadPrim::Length ( const float & L )

inline

Sets the length of core thread primitive.

References cthpm_t_ptr().

virtual float coat::scripto::CoreThreadPrim::Pitch ( ) const

inlinevirtual

Gets the pitch value for thread.

References cthpm_t_ptr().

virtual CoreThreadPrim& coat::scripto::CoreThreadPrim::Pitch ( const float & pitch )

inlinevirtual

Sets the pitch value for thread.

References cthpm_t_ptr().

virtual CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::Position ( const Vec3 & c )

inlinevirtualinherited

Setter for object position.

virtual Vec3 coat::scripto::IFastenerBasePrim< CoreThreadPrim >::Position ( ) const

inlinevirtualinherited

Getter for object position.

virtual CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::Position2 ( const Vec3 & c )

inlinevirtualinherited

Sets the position2 for object.

virtual Vec3 coat::scripto::IFastenerBasePrim< CoreThreadPrim >::Position2 ( ) const

inlinevirtualinherited

Gets the position2 for object.

virtual ProfileType coat::scripto::CoreThreadPrim::Profile ( ) const

inlinevirtual

Gets the type of profile for thread.

References cthpm_t_ptr().

virtual CoreThreadPrim& coat::scripto::CoreThreadPrim::Profile ( const ProfileType & prof )

inlinevirtual

Sets the type of profile for thread.

References cthpm_t_ptr().

virtual CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::ResetAxis ( )

inlinevirtualinherited

Reset the axies.

virtual CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::ResetPosition ( )

inlinevirtualinherited

Reset the position object.

virtual CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::ResetSize ( )

inlinevirtualinherited

Reset the size object.

void coat::scripto::IFastenerBasePrim< CoreThreadPrim >::RestoreFP ( const FPRec & fp )

inlineinherited

Restore of the scale radius, clickToPlace and positions

Parameters

fp	The reference to the record of the fastern product

virtual CoreThreadPrim & coat::scripto::IFastenerBasePrim< CoreThreadPrim >::ScaleRadius ( const float & r )

inlinevirtualinherited

Sets the scale radius.

virtual float coat::scripto::IFastenerBasePrim< CoreThreadPrim >::ScaleRadius ( ) const

inlinevirtualinherited

Gets the scale radius.

void coat::scripto::IFastenerBasePrim< CoreThreadPrim >::StoreFP ( FPRec & fp )

inlineinherited

Store of the scale radius, clickToPlace and positions

Parameters

fp	The reference to the record of the fastern product

float coat::scripto::CoreThreadPrim::ThreadLength ( ) const

inline

Gets the length of core thread.

References cthpm_t_ptr().

CoreThreadPrim& coat::scripto::CoreThreadPrim::ThreadLength ( const float & L )

inline

Sets the length of core thread.

References cthpm_t_ptr().

virtual void coat::scripto::IFastenerBasePrim< CoreThreadPrim >::update ( )

inlinevirtualinherited

Update parameters.

Reimplemented from coat::scripto::BaseObj< CoreThreadPrim >.

void coat::scripto::IFastenerBasePrim< CoreThreadPrim >::UpdateModel ( )

inlineinherited

Update model on click to place action.

bool coat::scripto::CoreThreadPrim::UseCone ( ) const

inline

Gets the use cone flag.

References cthpm_t_ptr().

CoreThreadPrim& coat::scripto::CoreThreadPrim::UseCone ( const bool & b )

inline

Sets the use cone flag.

References cthpm_t_ptr().

bool coat::scripto::CoreThreadPrim::UseThread ( ) const

inline

Gets the use thread flag.

References cthpm_t_ptr().

CoreThreadPrim& coat::scripto::CoreThreadPrim::UseThread ( const bool & b )

inline

Sets the use thread flag.

References cthpm_t_ptr().

The documentation for this class was generated from the following file:

3d-coat/3D-CoatV4/3D-Coat/Scripto/SCoreThreadPrim.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation