3DCoat  3D-COAT 4.9.xx
3DCoat is the one application that has all the tools you need to take your 3D idea from a block of digital clay all the way to a production ready, fully textured organic or hard surface model.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
coat::scripto::BoltPrim Class Reference

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

#include <SBoltPrim.h>

Public Types

enum  Mode
 Operations with meshes. More...
 

Public Member Functions

bltpm_t * blttpm_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
 Gets the diameter. More...
 
BoltPrimDiameter (const float &d)
 Sets the diameter. More...
 
float Height () const
 Gets the height. More...
 
BoltPrimHeight (const float &h)
 Sets the height. More...
 
float Width () const
 Gets the width. More...
 
BoltPrimWidth (const float &w)
 Sets the width. More...
 
float Length () const
 Gets the length. More...
 
BoltPrimLength (const float &h)
 Sets the length. More...
 
float HeadHeight () const
 Gets the head height. More...
 
BoltPrimHeadHeight (const float &h)
 Sets the head height. More...
 
float HeadDiameterDown () const
 Gets the head diameter at bottom. More...
 
BoltPrimHeadDiameterDown (const float &h)
 Sets the head diameter at bottom. More...
 
float HeadDiameterUpper () const
 Gets the head diameter at top. More...
 
BoltPrimHeadDiameterUpper (const float &h)
 Sets the head diameter at top. More...
 
float Thickness () const
 Gets the thickness. More...
 
BoltPrimThickness (const float &t)
 Sets the thickness. More...
 
float InnerRadius () const
 Gets the inner radius. More...
 
BoltPrimInnerRadius (const float &in)
 Sets the inner radius. More...
 
float ThreadLength () const
 Gets the thread length. More...
 
BoltPrimThreadLength (const float &l)
 Sets the thread length. More...
 
float Pitch () const
 Gets the bolt pitch. More...
 
BoltPrimPitch (const float &pitch)
 Sets the bolt pitch. More...
 
SHeadType HeadType () const
 Gets the head type. More...
 
BoltPrimHeadType (const SHeadType &htype)
 Sets the head type. More...
 
SUnderHeadType UnderHeadType () const
 Gets the under head type. More...
 
BoltPrimUnderHeadType (const SUnderHeadType &prof)
 Gets the under head type. More...
 
bool UseSlit () const
 Gets the using of slit flag. More...
 
BoltPrimUseSlit (const bool &b)
 Gets the using of slit flag. More...
 
bool UseUnderHead () const
 Gets the using of under head flag. More...
 
BoltPrimUseUnderHead (const bool &b)
 Sets the using of under head flag. More...
 
float UnderHeadWidth () const
 Gets the under head width. More...
 
BoltPrimUnderHeadWidth (const float &w)
 Sets the under head width. More...
 
float UnderHeadHeight () const
 Gets the under head height. More...
 
BoltPrimUnderHeadHeight (const float &h)
 Sets the under head height. More...
 
ProfileType Profile () const
 Gets the profile value. More...
 
BoltPrimProfile (const ProfileType &prof)
 Sets the profile value. More...
 
SSlitType SlitType () const
 Gets the type of head slit. More...
 
BoltPrimSlitType (const SSlitType &t)
 Sets the type of head slit. More...
 
float SlitWidth () const
 Gets the slit width. More...
 
BoltPrimSlitWidth (const float &w)
 Sets the slit width. More...
 
float SlitHeight () const
 Gets the slit height. More...
 
BoltPrimSlitHeight (const float &h)
 Sets the slit height. More...
 
float SlitLength () const
 Gets the slit length. More...
 
BoltPrimSlitLength (const float &l)
 Sets the slit length. More...
 
float BodyLength () const
 Gets the body length. More...
 
BoltPrimBodyLength (const float &l)
 Sets the body length. More...
 
float BodyDiameter () const
 Gets the body diameter. More...
 
BoltPrimBodyDiameter (const float &d)
 Sets the body diameter. More...
 
bool UseThread () const
 Gets the using of thread flag. More...
 
BoltPrimUseThread (const bool &l)
 Sets the using of thread flag. More...
 
bool UseNut () const
 Gets the using of nut. More...
 
BoltPrimUseNut (const bool &l)
 Sets the using of nut. More...
 
bool UseNutSeparate () const
 Gets the using of separate nut. More...
 
BoltPrimUseNutSeparate (const bool &l)
 Sets the using of separate nut. More...
 
bool UseGroove () const
 Gets the groove flag. More...
 
BoltPrimUseGroove (const bool &l)
 Sets the groove flag. More...
 
float NutLocation (bool ref) const
 Gets the nut location on the bolt. More...
 
BoltPrimNutLocation (const float &l, bool ref)
 Sets the nut location on the bolt. More...
 
BoltPrimMarks (const std::string &n)
 Sets the mark name of the standart bolt. More...
 
std::string Marks () const
 Gets the mark name of the standart bolt. More...
 
BoltPrimModelType (const int &t)
 Sets the model type of bolt. More...
 
int ModelType () const
 Gets the model type. More...
 
BoltPrimProductID (const int &n)
 Sets the product identifier. More...
 
int ProductID () const
 Gets the product identifier. More...
 
void ResetScales ()
 Reset scales. More...
 
void StoreProdPresets ()
 Store the presets of product. More...
 
void LoadProdPresets ()
 Load the presets of product. More...
 
void Standard ()
 Switch to standard mode. More...
 
void Custom ()
 Switch to custom mode. 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 BoltPrimPosition (const Vec3 &c)
 Setter for object position. More...
 
virtual Vec3 Position () const
 Getter for object position. More...
 
virtual BoltPrimPosition2 (const Vec3 &c)
 Sets the position2 for object. More...
 
virtual Vec3 Position2 () const
 Gets the position2 for object. More...
 
virtual BoltPrimScaleRadius (const float &r)
 Sets the scale radius. More...
 
virtual float ScaleRadius () const
 Gets the scale radius. More...
 
virtual BoltPrimClickToPlace (const float &brushRadius)
 Click to place. More...
 
virtual BoltPrimResetSize ()
 Reset the size object. More...
 
virtual BoltPrimResetPosition ()
 Reset the position object. More...
 
virtual BoltPrimResetAxis ()
 Reset the axies. More...
 
BoltPrimAxisX (const Vec3 &ax)
 Setter for Axis X. More...
 
Vec3 AxisX () const
 Getter for Axis X. More...
 
BoltPrimAxisY (const Vec3 &ay)
 Setter for Axis Y. More...
 
Vec3 AxisY () const
 Getter for Axis Y. More...
 
BoltPrimAxisZ (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.

bolt.jpg
See Also
BoltPrim for notes.
Since
5.0.0
+ Inheritance diagram for coat::scripto::BoltPrim:

Member Enumeration Documentation

enum coat::scripto::BasePrim::Mode
stronginherited

Operations with meshes.

Member Function Documentation

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

Setter for Axis X.

Parameters
axThe axis vector

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

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

Setter for Axis Y.

Parameters
ayThe axis vector

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

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

Setter for Axis Z.

Parameters
azThe axis vector

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

float coat::scripto::BoltPrim::BodyDiameter ( ) const
inline

Gets the body diameter.

Returns
Returns the body diameter

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::BodyDiameter ( const float &  d)
inline

Sets the body diameter.

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::BodyLength ( ) const
inline

Gets the body length.

Returns
Returns the body length

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::BodyLength ( const float &  l)
inline

Sets the body length.

References blttpm_t_ptr(), and update().

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

Click to place.

Parameters
brushRadiusThe brush radius for placement

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

void coat::scripto::BoltPrim::Custom ( )
inline

Switch to custom mode.

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::Diameter ( ) const
inline

Gets the diameter.

Returns
Returns the diameter

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::Diameter ( const float &  d)
inline

Sets the diameter.

References blttpm_t_ptr(), and update().

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

Converts the pointer to base class.

float coat::scripto::BoltPrim::HeadDiameterDown ( ) const
inline

Gets the head diameter at bottom.

Returns
Returns the head diameter at bottom

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::HeadDiameterDown ( const float &  h)
inline

Sets the head diameter at bottom.

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::HeadDiameterUpper ( ) const
inline

Gets the head diameter at top.

Returns
Returns the head diameter at top
BoltPrim& coat::scripto::BoltPrim::HeadDiameterUpper ( const float &  h)
inline

Sets the head diameter at top.

float coat::scripto::BoltPrim::HeadHeight ( ) const
inline

Gets the head height.

Returns
Returns the head height

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::HeadHeight ( const float &  h)
inline

Sets the head height.

References blttpm_t_ptr(), and update().

SHeadType coat::scripto::BoltPrim::HeadType ( ) const
inline

Gets the head type.

Returns
Returns the head type

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::HeadType ( const SHeadType &  htype)
inline

Sets the head type.

Parameters
htypeThe head type parameter

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::Height ( ) const
inline

Gets the height.

Returns
Returns the height

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::Height ( const float &  h)
inline

Sets the height.

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::InnerRadius ( ) const
inline

Gets the inner radius.

Returns
Returns the inner radius
BoltPrim& coat::scripto::BoltPrim::InnerRadius ( const float &  in)
inline

Sets the inner radius.

float coat::scripto::BoltPrim::Length ( ) const
inline

Gets the length.

Returns
Returns the length
BoltPrim& coat::scripto::BoltPrim::Length ( const float &  h)
inline

Sets the length.

void coat::scripto::BoltPrim::LoadProdPresets ( )
inline

Load the presets of product.

References blttpm_t_ptr(), and update().

BoltPrim& coat::scripto::BoltPrim::Marks ( const std::string &  n)
inline

Sets the mark name of the standart bolt.

Parameters
nMark name

References blttpm_t_ptr(), and coat::scripto::IFastenerBasePrim< BoltPrim >::UpdateModel().

std::string coat::scripto::BoltPrim::Marks ( ) const
inline

Gets the mark name of the standart bolt.

Returns
Returns the mark name of the standart bolt

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::ModelType ( const int &  t)
inline

Sets the model type of bolt.

Parameters
tModel type

References blttpm_t_ptr(), and coat::scripto::IFastenerBasePrim< BoltPrim >::UpdateModel().

int coat::scripto::BoltPrim::ModelType ( ) const
inline

Gets the model type.

Returns
Returns the model type

References blttpm_t_ptr().

float coat::scripto::BoltPrim::NutLocation ( bool  ref) const
inline

Gets the nut location on the bolt.

Parameters
refIf parameter is equal true then used the relative value
Returns
Returns the nut location

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::NutLocation ( const float &  l,
bool  ref 
)
inline

Sets the nut location on the bolt.

Parameters
l, refIf parameter "ref" is equal true then used the relative value

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::Pitch ( ) const
inline

Gets the bolt pitch.

Returns
Returns the bolt pitch

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::Pitch ( const float &  pitch)
inline

Sets the bolt pitch.

Parameters
pitchThe step of thread parameter

References blttpm_t_ptr(), and update().

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

Getter for object position.

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

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

Gets the position2 for object.

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

BoltPrim& coat::scripto::BoltPrim::ProductID ( const int &  n)
inline

Sets the product identifier.

Parameters
nValues 0 - bolts, 1 - screws

References blttpm_t_ptr(), and update().

int coat::scripto::BoltPrim::ProductID ( ) const
inline

Gets the product identifier.

Returns
Returns the product ID

References blttpm_t_ptr().

ProfileType coat::scripto::BoltPrim::Profile ( ) const
inline

Gets the profile value.

Returns
Returns the profile

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::Profile ( const ProfileType &  prof)
inline

Sets the profile value.

Parameters
profSet the ProfileType value

References blttpm_t_ptr(), and update().

virtual BoltPrim & coat::scripto::IFastenerBasePrim< BoltPrim >::ResetAxis ( )
inlinevirtualinherited
virtual BoltPrim & coat::scripto::IFastenerBasePrim< BoltPrim >::ResetPosition ( )
inlinevirtualinherited

Reset the position object.

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

void coat::scripto::BoltPrim::ResetScales ( )
inline

Reset scales.

References blttpm_t_ptr().

virtual BoltPrim & coat::scripto::IFastenerBasePrim< BoltPrim >::ResetSize ( )
inlinevirtualinherited

Reset the size object.

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

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

Restore of the scale radius, clickToPlace and positions

Parameters
fpThe reference to the record of the fastern product

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr(), and coat::scripto::IFastenerBasePrim< T >::ScaleRadius().

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

Gets the scale radius.

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr().

float coat::scripto::BoltPrim::SlitHeight ( ) const
inline

Gets the slit height.

Returns
Returns the slit height

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::SlitHeight ( const float &  h)
inline

Sets the slit height.

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::SlitLength ( ) const
inline

Gets the slit length.

Returns
Returns the slit length

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::SlitLength ( const float &  l)
inline

Sets the slit length.

References blttpm_t_ptr(), and update().

SSlitType coat::scripto::BoltPrim::SlitType ( ) const
inline

Gets the type of head slit.

Returns
Returns type of head slit

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::SlitType ( const SSlitType &  t)
inline

Sets the type of head slit.

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::SlitWidth ( ) const
inline

Gets the slit width.

Returns
Returns the slit width

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::SlitWidth ( const float &  w)
inline

Sets the slit width.

References blttpm_t_ptr(), and update().

void coat::scripto::BoltPrim::Standard ( )
inline

Switch to standard mode.

References blttpm_t_ptr(), and update().

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

Store of the scale radius, clickToPlace and positions

Parameters
fpThe reference to the record of the fastern product

References coat::scripto::IFastenerBasePrim< T >::fstn_prm_ptr(), and coat::scripto::IFastenerBasePrim< T >::ScaleRadius().

void coat::scripto::BoltPrim::StoreProdPresets ( )
inline

Store the presets of product.

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::Thickness ( ) const
inline

Gets the thickness.

Returns
Returns the thickness
BoltPrim& coat::scripto::BoltPrim::Thickness ( const float &  t)
inline

Sets the thickness.

float coat::scripto::BoltPrim::ThreadLength ( ) const
inline

Gets the thread length.

Returns
Returns the thread length

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::ThreadLength ( const float &  l)
inline

Sets the thread length.

Parameters
lThe thread length

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::UnderHeadHeight ( ) const
inline

Gets the under head height.

Returns
Returns the under head height

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UnderHeadHeight ( const float &  h)
inline

Sets the under head height.

References blttpm_t_ptr(), and update().

SUnderHeadType coat::scripto::BoltPrim::UnderHeadType ( ) const
inline

Gets the under head type.

Returns
Returns the under head type

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UnderHeadType ( const SUnderHeadType &  prof)
inline

Gets the under head type.

Parameters
profParameter must be DISK or SQUARE

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::UnderHeadWidth ( ) const
inline

Gets the under head width.

Returns
Returns the under head width

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UnderHeadWidth ( const float &  w)
inline

Sets the under head width.

References blttpm_t_ptr(), and update().

bool coat::scripto::BoltPrim::UseGroove ( ) const
inline

Gets the groove flag.

Returns
Returns the true if groove mode is checked otherwise returns false

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UseGroove ( const bool &  l)
inline

Sets the groove flag.

References blttpm_t_ptr(), and update().

bool coat::scripto::BoltPrim::UseNut ( ) const
inline

Gets the using of nut.

Returns
Returns the true if nut is used otherwise false

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UseNut ( const bool &  l)
inline

Sets the using of nut.

References blttpm_t_ptr(), and update().

bool coat::scripto::BoltPrim::UseNutSeparate ( ) const
inline

Gets the using of separate nut.

Returns
Returns the true if nut is separated otherwise returns false

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UseNutSeparate ( const bool &  l)
inline

Sets the using of separate nut.

References blttpm_t_ptr(), and update().

bool coat::scripto::BoltPrim::UseSlit ( ) const
inline

Gets the using of slit flag.

Returns
Returns the using of slit flag

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UseSlit ( const bool &  b)
inline

Gets the using of slit flag.

References blttpm_t_ptr(), and update().

bool coat::scripto::BoltPrim::UseThread ( ) const
inline

Gets the using of thread flag.

Returns
Returns true if thread is used otherwise false

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UseThread ( const bool &  l)
inline

Sets the using of thread flag.

References blttpm_t_ptr(), and update().

bool coat::scripto::BoltPrim::UseUnderHead ( ) const
inline

Gets the using of under head flag.

Returns
Returns the true if used the under head otherwise returns false

References blttpm_t_ptr().

BoltPrim& coat::scripto::BoltPrim::UseUnderHead ( const bool &  b)
inline

Sets the using of under head flag.

Parameters
bTrue if flag is used

References blttpm_t_ptr(), and update().

float coat::scripto::BoltPrim::Width ( ) const
inline

Gets the width.

Returns
Returns the width
BoltPrim& coat::scripto::BoltPrim::Width ( const float &  w)
inline

Sets the width.


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