Class for working with primitive mesh which represents like bolt head. More...

#include <SBoltHeadPrim.h>

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

Public Member Functions
blthpm_t *	bltpm_t_ptr () const
	Converts the pointer to base class to a pointer to this class. More...

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

float	Diameter () const
	Getter the diameter. More...

BoltHeadPrim &	Diameter (const float &d)
	Setter the diameter. More...

float	Height () const
	Gets the height parameter. More...

BoltHeadPrim &	Height (const float &h)
	Sets the height parameter. More...

float	param (int i) const
	Gets parameter by index. More...

BoltHeadPrim &	param (int i, float val)
	Sets the parameter by index. More...

float	Width () const
	Gets the width. More...

BoltHeadPrim &	Width (const float &val)
	Sets the width. More...

float	Length () const
	Gets the length. More...

BoltHeadPrim &	Length (const float &val)
	Sets the length. More...

float	HeadHeight () const
	Gets the height of bolt head. More...

BoltHeadPrim &	HeadHeight (const float &h)
	Sets the height of bolt head. More...

float	HeadDiameter () const
	Gets the diameter of bolt head. More...

BoltHeadPrim &	HeadDiameter (const float &h)
	Sets the diameter of bolt head. More...

float	HeadDiameterDown () const
	Gets the down diameter of bolt head. More...

BoltHeadPrim &	HeadDiameterDown (const float &h)
	Sets the down diameter of bolt head. More...

float	HeadDiameterUpper () const
	Gets the upper diameter of bolt head. More...

BoltHeadPrim &	HeadDiameterUpper (const float &h)
	Sets the upper diameter of bolt head. More...

float	EarThickness () const
	Gets the thickness ear of the lamb bolt head. More...

BoltHeadPrim &	EarThickness (const float &e)
	Sets the thickness ear of the lamb bolt head. More...

float	Thickness () const
	Gets the thickness. More...

BoltHeadPrim &	Thickness (const float &e)
	Sets the thickness. More...

float	InnerRadius () const
	Gets the inner radius. More...

BoltHeadPrim &	InnerRadius (const float &in)
	Sets the inner radius. More...

float	InsideDiameter () const
	Gets the inside diameter. More...

BoltHeadPrim &	InsideDiameter (const float &in)
	Sets the inside diameter. More...

float	OutsideDiameter () const
	Gets the outside diameter. More...

BoltHeadPrim &	OutsideDiameter (const float &in)
	Sets the outside diameter. More...

bool	UseSlit () const
	Gets the use slit flag. More...

BoltHeadPrim &	UseSlit (const bool &b)
	Sets the use slit flag. More...

float	SlitWidth () const
	Gets the width slit. More...

BoltHeadPrim &	SlitWidth (const float &w)
	Sets the width slit. More...

float	SlitHeight () const
	Gets the height slit. More...

BoltHeadPrim &	SlitHeight (const float &h)
	Sets the height slit. More...

float	SlitLength () const
	Gets the length slit. More...

BoltHeadPrim &	SlitLength (const float &l)
	Sets the length slit. More...

SHeadType	HeadType () const
	Gets the head type. More...

BoltHeadPrim &	HeadType (const SHeadType &t)
	Sets the head type. More...

SSlitType	SlitType () const
	Gets the slit type. More...

BoltHeadPrim &	SlitType (const SSlitType &t)
	Sets the slit type. 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 BoltHeadPrim &	Position (const Vec3 &c)
	Setter for object position. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

BoltHeadPrim &	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 bolt head.

See Also: BoltHeadPrim for notes.

Since: 5.0.0

Inheritance diagram for coat::scripto::BoltHeadPrim:

Member Enumeration Documentation

enum coat::scripto::BasePrim::Mode

stronginherited

Operations with meshes.

Member Function Documentation

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

inlineinherited

Setter for Axis X.

Parameters

ax	The axis vector

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

inlineinherited

Getter for Axis X.

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

inlineinherited

Setter for Axis Y.

Parameters

ay	The axis vector

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

inlineinherited

Getter for Axis Y.

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

inlineinherited

Setter for Axis Z.

Parameters

az	The axis vector

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

inlineinherited

Getter for Axis Z.

blthpm_t* coat::scripto::BoltHeadPrim::bltpm_t_ptr ( ) const

inline

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

Referenced by Diameter(), HeadHeight(), HeadType(), Height(), param(), SlitHeight(), SlitLength(), SlitType(), SlitWidth(), update(), and UseSlit().

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

inlinevirtualinherited

Click to place.

Parameters

brushRadius The brush radius for placement

float coat::scripto::BoltHeadPrim::Diameter ( ) const

inline

Getter the diameter.

Returns: Returns the diameter

References bltpm_t_ptr().

Referenced by HeadDiameterDown().

BoltHeadPrim& coat::scripto::BoltHeadPrim::Diameter ( const float & d )

inline

Setter the diameter.

References bltpm_t_ptr(), and update().

float coat::scripto::BoltHeadPrim::EarThickness ( ) const

inline

Gets the thickness ear of the lamb bolt head.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::EarThickness ( const float & e )

inline

Sets the thickness ear of the lamb bolt head.

References param().

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

inlineinherited

Converts the pointer to base class.

float coat::scripto::BoltHeadPrim::HeadDiameter ( ) const

inline

Gets the diameter of bolt head.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::HeadDiameter ( const float & h )

inline

Sets the diameter of bolt head.

References param().

float coat::scripto::BoltHeadPrim::HeadDiameterDown ( ) const

inline

Gets the down diameter of bolt head.

References Diameter().

BoltHeadPrim& coat::scripto::BoltHeadPrim::HeadDiameterDown ( const float & h )

inline

Sets the down diameter of bolt head.

References Diameter().

float coat::scripto::BoltHeadPrim::HeadDiameterUpper ( ) const

inline

Gets the upper diameter of bolt head.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::HeadDiameterUpper ( const float & h )

inline

Sets the upper diameter of bolt head.

References param().

float coat::scripto::BoltHeadPrim::HeadHeight ( ) const

inline

Gets the height of bolt head.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::HeadHeight ( const float & h )

inline

Sets the height of bolt head.

References bltpm_t_ptr(), and update().

SHeadType coat::scripto::BoltHeadPrim::HeadType ( ) const

inline

Gets the head type.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::HeadType ( const SHeadType & t )

inline

Sets the head type.

References bltpm_t_ptr(), and update().

float coat::scripto::BoltHeadPrim::Height ( ) const

inline

Gets the height parameter.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::Height ( const float & h )

inline

Sets the height parameter.

References bltpm_t_ptr(), and update().

float coat::scripto::BoltHeadPrim::InnerRadius ( ) const

inline

Gets the inner radius.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::InnerRadius ( const float & in )

inline

Sets the inner radius.

References param().

float coat::scripto::BoltHeadPrim::InsideDiameter ( ) const

inline

Gets the inside diameter.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::InsideDiameter ( const float & in )

inline

Sets the inside diameter.

References param().

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

inline

Gets the length.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::Length ( const float & val )

inline

Sets the length.

References param().

float coat::scripto::BoltHeadPrim::OutsideDiameter ( ) const

inline

Gets the outside diameter.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::OutsideDiameter ( const float & in )

inline

Sets the outside diameter.

References param().

float coat::scripto::BoltHeadPrim::param ( int i ) const

inline

Gets parameter by index.

References bltpm_t_ptr().

Referenced by EarThickness(), HeadDiameter(), HeadDiameterUpper(), InnerRadius(), InsideDiameter(), Length(), OutsideDiameter(), Thickness(), and Width().

BoltHeadPrim& coat::scripto::BoltHeadPrim::param	(	int	i,
		float	val
	)

inline

Sets the parameter by index.

References bltpm_t_ptr(), and update().

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

inlinevirtualinherited

Setter for object position.

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

inlinevirtualinherited

Getter for object position.

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

inlinevirtualinherited

Sets the position2 for object.

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

inlinevirtualinherited

Gets the position2 for object.

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

inlinevirtualinherited

Reset the axies.

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

inlinevirtualinherited

Reset the position object.

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

inlinevirtualinherited

Reset the size object.

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

inlinevirtualinherited

Sets the scale radius.

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

inlinevirtualinherited

Gets the scale radius.

float coat::scripto::BoltHeadPrim::SlitHeight ( ) const

inline

Gets the height slit.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::SlitHeight ( const float & h )

inline

Sets the height slit.

References bltpm_t_ptr(), and update().

float coat::scripto::BoltHeadPrim::SlitLength ( ) const

inline

Gets the length slit.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::SlitLength ( const float & l )

inline

Sets the length slit.

References bltpm_t_ptr(), and update().

SSlitType coat::scripto::BoltHeadPrim::SlitType ( ) const

inline

Gets the slit type.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::SlitType ( const SSlitType & t )

inline

Sets the slit type.

References bltpm_t_ptr(), and update().

float coat::scripto::BoltHeadPrim::SlitWidth ( ) const

inline

Gets the width slit.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::SlitWidth ( const float & w )

inline

Sets the width slit.

References bltpm_t_ptr(), and update().

void coat::scripto::IFastenerBasePrim< BoltHeadPrim >::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::BoltHeadPrim::Thickness ( ) const

inline

Gets the thickness.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::Thickness ( const float & e )

inline

Sets the thickness.

References param().

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

inlinevirtual

Update parameters.

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

References bltpm_t_ptr().

Referenced by Diameter(), HeadHeight(), HeadType(), Height(), param(), SlitHeight(), SlitLength(), SlitType(), SlitWidth(), and UseSlit().

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

inlineinherited

Update model on click to place action.

bool coat::scripto::BoltHeadPrim::UseSlit ( ) const

inline

Gets the use slit flag.

References bltpm_t_ptr().

BoltHeadPrim& coat::scripto::BoltHeadPrim::UseSlit ( const bool & b )

inline

Sets the use slit flag.

References bltpm_t_ptr(), and update().

float coat::scripto::BoltHeadPrim::Width ( ) const

inline

Gets the width.

References param().

BoltHeadPrim& coat::scripto::BoltHeadPrim::Width ( const float & val )

inline

Sets the width.

References param().

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

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation