Class for working with primitive mesh which represents like tap-screw prim. More...

#include <STapScrewPrim.h>

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

Public Member Functions
virtual void	update ()
	Update parameters. More...

fstn_prm_t *	fstn_prm_ptr () const
	Converts the pointer to base class. 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 TapScrewPrim &	Position (const Vec3 &c)
	Setter for object position. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

TapScrewPrim &	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 tap-screw prim.

See Also: TapScrewPrim for notes.

Since: 5.0.0

Inheritance diagram for coat::scripto::TapScrewPrim:

Member Enumeration Documentation

enum coat::scripto::BasePrim::Mode

stronginherited

Operations with meshes.

Member Function Documentation

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

inlineinherited

Setter for Axis X.

Parameters

ax	The axis vector

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

inlineinherited

Getter for Axis X.

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

inlineinherited

Setter for Axis Y.

Parameters

ay	The axis vector

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

inlineinherited

Getter for Axis Y.

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

inlineinherited

Setter for Axis Z.

Parameters

az	The axis vector

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

inlineinherited

Getter for Axis Z.

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

inlinevirtualinherited

Click to place.

Parameters

brushRadius The brush radius for placement

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

inlineinherited

Converts the pointer to base class.

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

inlinevirtualinherited

Setter for object position.

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

inlinevirtualinherited

Getter for object position.

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

inlinevirtualinherited

Sets the position2 for object.

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

inlinevirtualinherited

Gets the position2 for object.

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

inlinevirtualinherited

Reset the axies.

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

inlinevirtualinherited

Reset the position object.

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

inlinevirtualinherited

Reset the size object.

void coat::scripto::IFastenerBasePrim< TapScrewPrim >::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 TapScrewPrim & coat::scripto::IFastenerBasePrim< TapScrewPrim >::ScaleRadius ( const float & r )

inlinevirtualinherited

Sets the scale radius.

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

inlinevirtualinherited

Gets the scale radius.

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

inlineinherited

Store of the scale radius, clickToPlace and positions

Parameters

fp	The reference to the record of the fastern product

virtual void coat::scripto::TapScrewPrim::update ( )

inlinevirtual

Update parameters.

Reimplemented from coat::scripto::IFastenerBasePrim< TapScrewPrim >.

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

inlineinherited

Update model on click to place action.

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

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation