coat::scripto::IFastenerBasePrim< T > Class Template Reference

Basic class for fastener base primitives More...

#include <SBasePrim.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 T &	Position (const Vec3 &c)
	Setter for object position. More...
virtual Vec3	Position () const
	Getter for object position. More...
virtual T &	Position2 (const Vec3 &c)
	Sets the position2 for object. More...
virtual Vec3	Position2 () const
	Gets the position2 for object. More...
virtual T &	ScaleRadius (const float &r)
	Sets the scale radius. More...
virtual float	ScaleRadius () const
	Gets the scale radius. More...
virtual T &	ClickToPlace (const float &brushRadius)
	Click to place. More...
virtual T &	ResetSize ()
	Reset the size object. More...
virtual T &	ResetPosition ()
	Reset the position object. More...
virtual T &	ResetAxis ()
	Reset the axies. More...
T &	AxisX (const Vec3 &ax)
	Setter for Axis X. More...
Vec3	AxisX () const
	Getter for Axis X. More...
T &	AxisY (const Vec3 &ay)
	Setter for Axis Y. More...
Vec3	AxisY () const
	Getter for Axis Y. More...
T &	AxisZ (const Vec3 &az)
	Setter for Axis Z. More...
Vec3	AxisZ () const
	Getter for Axis Z. More...

Detailed Description

template<class T>
class coat::scripto::IFastenerBasePrim< T >

Basic class for fastener base primitives

Inheritance diagram for coat::scripto::IFastenerBasePrim< T >:

Member Enumeration Documentation

template<class T>

enum coat::scripto::BasePrim::Mode

stronginherited

Operations with meshes.

Member Function Documentation

template<class T>

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

inline

Setter for Axis X.

Parameters

ax	The axis vector

template<class T>

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

inline

Getter for Axis X.

template<class T>

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

inline

Setter for Axis Y.

Parameters

ay	The axis vector

template<class T>

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

inline

Getter for Axis Y.

template<class T>

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

inline

Setter for Axis Z.

Parameters

az	The axis vector

template<class T>

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

inline

Getter for Axis Z.

template<class T>

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

inlinevirtual

Click to place.

Parameters

brushRadius

The brush radius for placement

template<class T>

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

inline

Converts the pointer to base class.

Referenced by coat::scripto::IFastenerBasePrim< BoltPrim >::AxisX(), coat::scripto::IFastenerBasePrim< BoltPrim >::AxisY(), coat::scripto::IFastenerBasePrim< BoltPrim >::AxisZ(), coat::scripto::IFastenerBasePrim< BoltPrim >::ClickToPlace(), coat::scripto::IFastenerBasePrim< BoltPrim >::Position(), coat::scripto::IFastenerBasePrim< BoltPrim >::Position2(), coat::scripto::IFastenerBasePrim< BoltPrim >::ResetAxis(), coat::scripto::IFastenerBasePrim< BoltPrim >::ResetPosition(), coat::scripto::IFastenerBasePrim< BoltPrim >::ResetSize(), coat::scripto::IFastenerBasePrim< BoltPrim >::RestoreFP(), coat::scripto::IFastenerBasePrim< BoltPrim >::ScaleRadius(), coat::scripto::IFastenerBasePrim< BoltPrim >::StoreFP(), coat::scripto::IFastenerBasePrim< BoltPrim >::update(), and coat::scripto::IFastenerBasePrim< BoltPrim >::UpdateModel().

template<class T>

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

inlinevirtual

Setter for object position.

template<class T>

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

inlinevirtual

Getter for object position.

template<class T>

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

inlinevirtual

Sets the position2 for object.

template<class T>

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

inlinevirtual

Gets the position2 for object.

template<class T>

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

inlinevirtual

Reset the axies.

template<class T>

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

inlinevirtual

Reset the position object.

template<class T>

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

inlinevirtual

Reset the size object.

template<class T>

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

inline

Restore of the scale radius, clickToPlace and positions

Parameters

fp	The reference to the record of the fastern product

Referenced by coat::scripto::IFastenerBasePrim< BoltPrim >::UpdateModel().

template<class T>

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

inlinevirtual

Sets the scale radius.

template<class T>

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

inlinevirtual

Gets the scale radius.

Referenced by coat::scripto::IFastenerBasePrim< BoltPrim >::RestoreFP(), and coat::scripto::IFastenerBasePrim< BoltPrim >::StoreFP().

template<class T>

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

inline

Store of the scale radius, clickToPlace and positions

Parameters

fp	The reference to the record of the fastern product

Referenced by coat::scripto::IFastenerBasePrim< BoltPrim >::UpdateModel().

template<class T>

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

inlinevirtual

Update parameters.

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

Reimplemented in coat::scripto::BoltHeadPrim, coat::scripto::NutPrim, coat::scripto::BoltPrim, coat::scripto::WasherPrim, and coat::scripto::TapScrewPrim.

Referenced by coat::scripto::IFastenerBasePrim< BoltPrim >::Position(), coat::scripto::IFastenerBasePrim< BoltPrim >::Position2(), coat::scripto::IFastenerBasePrim< BoltPrim >::ScaleRadius(), and coat::scripto::IFastenerBasePrim< BoltPrim >::UpdateModel().

template<class T>

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

inline

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/SBasePrim.h