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

#include <SSpringPrim.h>

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

Public Member Functions
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 SpringPrim &	Position (const Vec3 &c)
	Setter for object position. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

SpringPrim &	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 spring prim.

See Also: SpringPrim for notes.

Since: 5.0.0

Inheritance diagram for coat::scripto::SpringPrim:

Member Enumeration Documentation

enum coat::scripto::BasePrim::Mode

stronginherited

Operations with meshes.

Member Function Documentation

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

inlineinherited

Setter for Axis X.

Parameters

ax	The axis vector

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

inlineinherited

Getter for Axis X.

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

inlineinherited

Setter for Axis Y.

Parameters

ay	The axis vector

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

inlineinherited

Getter for Axis Y.

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

inlineinherited

Setter for Axis Z.

Parameters

az	The axis vector

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

inlineinherited

Getter for Axis Z.

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

inlinevirtualinherited

Click to place.

Parameters

brushRadius The brush radius for placement

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

inlineinherited

Converts the pointer to base class.

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

inlinevirtualinherited

Setter for object position.

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

inlinevirtualinherited

Getter for object position.

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

inlinevirtualinherited

Sets the position2 for object.

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

inlinevirtualinherited

Gets the position2 for object.

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

inlinevirtualinherited

Reset the axies.

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

inlinevirtualinherited

Reset the position object.

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

inlinevirtualinherited

Reset the size object.

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

inlinevirtualinherited

Sets the scale radius.

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

inlinevirtualinherited

Gets the scale radius.

void coat::scripto::IFastenerBasePrim< SpringPrim >::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::IFastenerBasePrim< SpringPrim >::update ( )

inlinevirtualinherited

Update parameters.

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

void coat::scripto::IFastenerBasePrim< SpringPrim >::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/SSpringPrim.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation