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

#include <SCapsulePrim.h>

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

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

Vec2	Cap () const
	Gets the cap scale vector. More...

CapsulePrim &	Cap (const Vec2 &cap)
	Sets the scale vector for cap. More...

float	Cap1 () const
	Getter the first cap scale. More...

CapsulePrim &	Cap1 (const float &cap)
	Setter the scale factor for first cap. More...

float	Cap2 () const
	Getter the second cap scale. More...

CapsulePrim &	Cap2 (const float &cap)
	Setter the scale factor for second cap. More...

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

T &	height (const float &h)
	Sets the height. More...

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

T &	radius (const float &r)
	Sets the radius. More...

bool	useFillet () const
	Gets the use fillet flag. More...

T &	useFillet (const bool &b)
	Sets the use fillet flag. More...

T &	filletRadius (const float &r)
	Sets the fillet radius. More...

float	filletRadius () const
	Gets the fillet radius. More...

T &	filletRadiusRelation (const float &r)
	Sets the fillet relative radius. More...

float	filletRadiusRelation () const
	Gets the fillet relative radius. More...

T &	sectorAngle (const float &a)
	Setter for sector angle. More...

float	sectorAngle () const
	Getter for sector angle. More...

virtual T &	Position (const Vec3 &c)
	Sets the object position. More...

virtual Vec3	Position () const
	Gets the object position. More...

T &	startPoint (const Vec3 &pos)
	Setter for startPoint. More...

Vec3	startPoint () const
	Getter for startPoint. More...

T &	endPoint (const Vec3 &pos)
	Setter for endPoint. More...

Vec3	endPoint () const
	Getter for endPoint. More...

T &	topRadius (const float &r)
	Sets the top radius. More...

float	topRadius () const
	Gets the top radius. More...

T &	bottomRadius (const float &r)
	Sets the bottom radius. More...

float	bottomRadius () const
	Gets the bottom radius. More...

T &	scale (const Vec2 &s)
	Sets the scale vector. More...

Vec2	scale () const
	Gets the scale vector. More...

T &	scalex (const float &s)
	Sets the scale in x-direction. More...

float	scalex () const
	Gets the scale in x-direction. More...

T &	scaley (const float &s)
	Sets the scale in y-direction. More...

float	scaley () const
	Gets the scale in y-direction. More...

void	MainX ()
	Align to X axis. More...

void	MainY ()
	Align to Y axis. More...

void	MainZ ()
	Align to Z axis. More...

void	ViewSpace ()
	Align to view space. More...

void	ToCenterMass ()
	Assign to center mass. More...

void	ResetScales ()
	Resets tthe scales. More...

virtual T &	ResetPosition ()
	Resets the position. More...

virtual T &	ResetAxis ()
	Resets the axis. More...

Detailed Description

Class for working with primitive mesh which represents like capsule prim.

See Also: CapsulePrim for notes.

Since: 5.0.0

Inherits coat::scripto::ICylinderPrim< 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::ICylinderPrim< T >::bottomRadius ( const float & r )

inlineinherited

Sets the bottom radius.

template<class T>

float coat::scripto::ICylinderPrim< T >::bottomRadius ( ) const

inlineinherited

Gets the bottom radius.

Vec2 coat::scripto::CapsulePrim::Cap ( ) const

inline

Gets the cap scale vector.

Returns: Returns the cap scale vector

References cpm_ptr().

CapsulePrim& coat::scripto::CapsulePrim::Cap ( const Vec2 & cap )

inline

Sets the scale vector for cap.

Parameters

cap	The cap scale vector

References cpm_ptr().

float coat::scripto::CapsulePrim::Cap1 ( ) const

inline

Getter the first cap scale.

Returns: Returns the cap scale factor

References cpm_ptr().

CapsulePrim& coat::scripto::CapsulePrim::Cap1 ( const float & cap )

inline

Setter the scale factor for first cap.

Parameters

cap	The cap scale factor

References cpm_ptr().

float coat::scripto::CapsulePrim::Cap2 ( ) const

inline

Getter the second cap scale.

Returns: Returns the cap scale factor

References cpm_ptr().

CapsulePrim& coat::scripto::CapsulePrim::Cap2 ( const float & cap )

inline

Setter the scale factor for second cap.

Parameters

cap	The cap scale factor

References cpm_ptr().

cappm_t* coat::scripto::CapsulePrim::cpm_ptr ( ) const

inline

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

Referenced by Cap(), Cap1(), and Cap2().

template<class T>

T& coat::scripto::ICylinderPrim< T >::endPoint ( const Vec3 & pos )

inlineinherited

Setter for endPoint.

template<class T>

Vec3 coat::scripto::ICylinderPrim< T >::endPoint ( ) const

inlineinherited

Getter for endPoint.

template<class T>

T& coat::scripto::ICylinderPrim< T >::filletRadius ( const float & r )

inlineinherited

Sets the fillet radius.

template<class T>

float coat::scripto::ICylinderPrim< T >::filletRadius ( ) const

inlineinherited

Gets the fillet radius.

template<class T>

T& coat::scripto::ICylinderPrim< T >::filletRadiusRelation ( const float & r )

inlineinherited

Sets the fillet relative radius.

template<class T>

float coat::scripto::ICylinderPrim< T >::filletRadiusRelation ( ) const

inlineinherited

Gets the fillet relative radius.

template<class T>

float coat::scripto::ICylinderPrim< T >::height ( ) const

inlineinherited

Gets the height.

template<class T>

T& coat::scripto::ICylinderPrim< T >::height ( const float & h )

inlineinherited

Sets the height.

template<class T>

void coat::scripto::ICylinderPrim< T >::MainX ( )

inlineinherited

Align to X axis.

template<class T>

void coat::scripto::ICylinderPrim< T >::MainY ( )

inlineinherited

Align to Y axis.

template<class T>

void coat::scripto::ICylinderPrim< T >::MainZ ( )

inlineinherited

Align to Z axis.

template<class T>

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

inlinevirtualinherited

Sets the object position.

template<class T>

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

inlinevirtualinherited

Gets the object position.

template<class T>

float coat::scripto::ICylinderPrim< T >::radius ( ) const

inlineinherited

Gets the radius.

template<class T>

T& coat::scripto::ICylinderPrim< T >::radius ( const float & r )

inlineinherited

Sets the radius.

template<class T>

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

inlinevirtualinherited

Resets the axis.

template<class T>

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

inlinevirtualinherited

Resets the position.

template<class T>

void coat::scripto::ICylinderPrim< T >::ResetScales ( )

inlineinherited

Resets tthe scales.

template<class T>

T& coat::scripto::ICylinderPrim< T >::scale ( const Vec2 & s )

inlineinherited

Sets the scale vector.

template<class T>

Vec2 coat::scripto::ICylinderPrim< T >::scale ( ) const

inlineinherited

Gets the scale vector.

template<class T>

T& coat::scripto::ICylinderPrim< T >::scalex ( const float & s )

inlineinherited

Sets the scale in x-direction.

template<class T>

float coat::scripto::ICylinderPrim< T >::scalex ( ) const

inlineinherited

Gets the scale in x-direction.

template<class T>

T& coat::scripto::ICylinderPrim< T >::scaley ( const float & s )

inlineinherited

Sets the scale in y-direction.

template<class T>

float coat::scripto::ICylinderPrim< T >::scaley ( ) const

inlineinherited

Gets the scale in y-direction.

template<class T>

T& coat::scripto::ICylinderPrim< T >::sectorAngle ( const float & a )

inlineinherited

Setter for sector angle.

template<class T>

float coat::scripto::ICylinderPrim< T >::sectorAngle ( ) const

inlineinherited

Getter for sector angle.

template<class T>

T& coat::scripto::ICylinderPrim< T >::startPoint ( const Vec3 & pos )

inlineinherited

Setter for startPoint.

template<class T>

Vec3 coat::scripto::ICylinderPrim< T >::startPoint ( ) const

inlineinherited

Getter for startPoint.

template<class T>

void coat::scripto::ICylinderPrim< T >::ToCenterMass ( )

inlineinherited

Assign to center mass.

template<class T>

T& coat::scripto::ICylinderPrim< T >::topRadius ( const float & r )

inlineinherited

Sets the top radius.

template<class T>

float coat::scripto::ICylinderPrim< T >::topRadius ( ) const

inlineinherited

Gets the top radius.

template<class T>

bool coat::scripto::ICylinderPrim< T >::useFillet ( ) const

inlineinherited

Gets the use fillet flag.

template<class T>

T& coat::scripto::ICylinderPrim< T >::useFillet ( const bool & b )

inlineinherited

Sets the use fillet flag.

template<class T>

void coat::scripto::ICylinderPrim< T >::ViewSpace ( )

inlineinherited

Align to view space.

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

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation