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

#include <SFreeFormPrim.h>

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

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

float	Radius () const
	Gets/Sets the radius. More...

FreeFormPrim &	Position (const Vec3 &c)
	Setter for position. More...

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

void	ResetPrim ()
	Resets the primitive. More...

void	Scale ()
	Scale. More...

void	ScaleX ()
	Scale X-axis. More...

void	ScaleY ()
	Scale Y-axis. More...

void	ScaleZ ()
	Scale Z-axis. More...

void	EditPoints ()
	Edit points. More...

void	ResetPoints ()
	Reset points. More...

FreeFormPrim &	SideA (const float &a)
	Setter for Side X. More...

float	SideA () const
	Getter for Side X. More...

FreeFormPrim &	SideB (const float &b)
	Setter for Side Y. More...

float	SideB () const
	Getter for Side Y. More...

FreeFormPrim &	SideC (const float &c)
	Setter for Side Z. More...

float	SideC () const
	Getter for Side Z. More...

bool	SymmetryX () const
	Gets the available of symmetry at X-axis. More...

bool	SymmetryY () const
	Gets the available of symmetry at Y-axis. More...

bool	SymmetryZ () const
	Gets the available of symmetry at Z-axis. More...

FreeFormPrim &	SymmetryX (const bool &b)
	Sets the available of symmetry at X-axis. More...

FreeFormPrim &	SymmetryY (const bool &b)
	Sets the available of symmetry at Y-axis. More...

FreeFormPrim &	SymmetryZ (const bool &b)
	Sets the available of symmetry at Z-axis. More...

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

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

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

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

FreeFormPrim &	AxisZ (const Vec3 &az)
	Setter for Axis Z. More...

Vec3	AxisZ () const
	Getter for Axis Z. More...

bool	Transform () const
	Gets/Sets transform mode flag. More...

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

float	OuterRadius () const
	Gets/Sets the outer radius. More...

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

int	SubPrim () const
	Gets/Sets the index of the sub primitive. More...

FreeFormPrim &	IsSurf (const bool &surf)
	Sets/Gets the exist of surface. More...

FreeFormPrim &	MoveOnlyGizmo (const bool &onlyGizmo)
	Sets/Gets the "Move only gizmo" mode. More...

FreeFormPrim &	LocalSpace (const bool &locSpace)
	Sets/Gets the "Local Space" mode. More...

FreeFormPrim &	Name (const std::string &name)
	Sets/Gets the freeform primitive name. More...

FreeFormPrim &	SubName (const std::string &name)
	Sets/Gets the subname of the freeform primitive. More...

FreeFormPrim &	MeshName (const std::string &name)
	Sets/Gets the Mesh name. More...

int	SetPoint (int id, float x, float y, float z)
	Sets the point the primitive. More...

Detailed Description

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

See Also: FreeFormPrim for notes.

Since: 5.0.0

Inheritance diagram for coat::scripto::FreeFormPrim:

Member Enumeration Documentation

enum coat::scripto::BasePrim::Mode

stronginherited

Operations with meshes.

Member Function Documentation

FreeFormPrim& coat::scripto::FreeFormPrim::AxisX ( const Vec3 & ax )

inline

Setter for Axis X.

References AxisX(), and ffp_ptr().

Referenced by AxisX().

Vec3 coat::scripto::FreeFormPrim::AxisX ( ) const

inline

Getter for Axis X.

References AxisX(), ffp_ptr(), coat::scripto::Vec3::x(), coat::scripto::Vec3::y(), and coat::scripto::Vec3::z().

FreeFormPrim& coat::scripto::FreeFormPrim::AxisY ( const Vec3 & ay )

inline

Setter for Axis Y.

References AxisY(), and ffp_ptr().

Referenced by AxisY().

Vec3 coat::scripto::FreeFormPrim::AxisY ( ) const

inline

Getter for Axis Y.

References AxisY(), ffp_ptr(), coat::scripto::Vec3::x(), coat::scripto::Vec3::y(), and coat::scripto::Vec3::z().

FreeFormPrim& coat::scripto::FreeFormPrim::AxisZ ( const Vec3 & az )

inline

Setter for Axis Z.

References AxisZ(), and ffp_ptr().

Referenced by AxisZ().

Vec3 coat::scripto::FreeFormPrim::AxisZ ( ) const

inline

Getter for Axis Z.

References AxisZ(), ffp_ptr(), coat::scripto::Vec3::x(), coat::scripto::Vec3::y(), and coat::scripto::Vec3::z().

void FreeFormPrim::EditPoints ( )

Edit points.

References EditPoints(), and ffp_ptr().

Referenced by EditPoints().

ffp_t* coat::scripto::FreeFormPrim::ffp_ptr ( ) const

inline

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

Referenced by AxisX(), AxisY(), AxisZ(), EditPoints(), InnerRadius(), IsSurf(), LocalSpace(), MeshName(), MoveOnlyGizmo(), Name(), OuterRadius(), Position(), Radius(), ResetPoints(), ResetPrim(), Scale(), ScaleX(), ScaleY(), ScaleZ(), SetPoint(), SideA(), SideB(), SideC(), SubName(), SubPrim(), SymmetryX(), SymmetryY(), SymmetryZ(), Thickness(), and Transform().

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

inline

Gets/Sets the inner radius.

References ffp_ptr(), and InnerRadius().

Referenced by InnerRadius().

FreeFormPrim& coat::scripto::FreeFormPrim::IsSurf ( const bool & surf )

inline

Sets/Gets the exist of surface.

References ffp_ptr(), and IsSurf().

Referenced by IsSurf().

FreeFormPrim& coat::scripto::FreeFormPrim::LocalSpace ( const bool & locSpace )

inline

Sets/Gets the "Local Space" mode.

References ffp_ptr(), and LocalSpace().

Referenced by LocalSpace().

FreeFormPrim& coat::scripto::FreeFormPrim::MeshName ( const std::string & name )

inline

Sets/Gets the Mesh name.

References ffp_ptr(), and MeshName().

Referenced by MeshName().

FreeFormPrim& coat::scripto::FreeFormPrim::MoveOnlyGizmo ( const bool & onlyGizmo )

inline

Sets/Gets the "Move only gizmo" mode.

References ffp_ptr(), and MoveOnlyGizmo().

Referenced by MoveOnlyGizmo().

FreeFormPrim& coat::scripto::FreeFormPrim::Name ( const std::string & name )

inline

Sets/Gets the freeform primitive name.

References ffp_ptr(), and SubPrim().

float coat::scripto::FreeFormPrim::OuterRadius ( ) const

inline

Gets/Sets the outer radius.

References ffp_ptr(), and OuterRadius().

Referenced by OuterRadius().

FreeFormPrim & FreeFormPrim::Position ( const Vec3 & c )

Setter for position.

References ffp_ptr().

Vec3 FreeFormPrim::Position ( ) const

Getter for position.

References ffp_ptr().

float coat::scripto::FreeFormPrim::Radius ( ) const

inline

Gets/Sets the radius.

References ffp_ptr(), and Radius().

Referenced by Radius().

void FreeFormPrim::ResetPoints ( )

Reset points.

References ffp_ptr(), and ResetPoints().

Referenced by ResetPoints().

void FreeFormPrim::ResetPrim ( )

Resets the primitive.

References ffp_ptr(), and ResetPrim().

Referenced by ResetPrim().

void FreeFormPrim::Scale ( )

Scale.

References ffp_ptr(), and Scale().

Referenced by Scale().

void FreeFormPrim::ScaleX ( )

Scale X-axis.

References ffp_ptr(), and ScaleX().

Referenced by ScaleX().

void FreeFormPrim::ScaleY ( )

Scale Y-axis.

References ffp_ptr(), and ScaleY().

Referenced by ScaleY().

void FreeFormPrim::ScaleZ ( )

Scale Z-axis.

References ffp_ptr(), and ScaleZ().

Referenced by ScaleZ().

int coat::scripto::FreeFormPrim::SetPoint	(	int	id,
		float	x,
		float	y,
		float	z
	)

inline

Sets the point the primitive.

Parameters

id	index point
x	X-position
y	Y-position
z	Z-position

Returns: Returns the index of the set point

References ffp_ptr().

FreeFormPrim& coat::scripto::FreeFormPrim::SideA ( const float & a )

inline

Setter for Side X.

References ffp_ptr(), and SideA().

Referenced by SideA().

float coat::scripto::FreeFormPrim::SideA ( ) const

inline

Getter for Side X.

References ffp_ptr(), and SideA().

FreeFormPrim& coat::scripto::FreeFormPrim::SideB ( const float & b )

inline

Setter for Side Y.

References ffp_ptr(), and SideB().

Referenced by SideB().

float coat::scripto::FreeFormPrim::SideB ( ) const

inline

Getter for Side Y.

References ffp_ptr(), and SideB().

FreeFormPrim& coat::scripto::FreeFormPrim::SideC ( const float & c )

inline

Setter for Side Z.

References ffp_ptr(), and SideC().

Referenced by SideC().

float coat::scripto::FreeFormPrim::SideC ( ) const

inline

Getter for Side Z.

References ffp_ptr(), and SideC().

FreeFormPrim& coat::scripto::FreeFormPrim::SubName ( const std::string & name )

inline

Sets/Gets the subname of the freeform primitive.

References ffp_ptr().

int coat::scripto::FreeFormPrim::SubPrim ( ) const

inline

Gets/Sets the index of the sub primitive.

References ffp_ptr().

Referenced by Name().

bool coat::scripto::FreeFormPrim::SymmetryX ( ) const

inline

Gets the available of symmetry at X-axis.

References ffp_ptr().

FreeFormPrim & FreeFormPrim::SymmetryX ( const bool & b )

Sets the available of symmetry at X-axis.

References ffp_ptr().

bool coat::scripto::FreeFormPrim::SymmetryY ( ) const

inline

Gets the available of symmetry at Y-axis.

References ffp_ptr().

FreeFormPrim & FreeFormPrim::SymmetryY ( const bool & b )

Sets the available of symmetry at Y-axis.

References ffp_ptr().

bool coat::scripto::FreeFormPrim::SymmetryZ ( ) const

inline

Gets the available of symmetry at Z-axis.

References ffp_ptr().

FreeFormPrim & FreeFormPrim::SymmetryZ ( const bool & b )

Sets the available of symmetry at Z-axis.

References ffp_ptr().

float coat::scripto::FreeFormPrim::Thickness ( ) const

inline

Gets/Sets the thickness.

References ffp_ptr(), and Thickness().

Referenced by Thickness().

bool coat::scripto::FreeFormPrim::Transform ( ) const

inline

Gets/Sets transform mode flag.

References ffp_ptr().

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

3d-coat/3D-CoatV4/3D-Coat/Scripto/SFreeFormPrim.h
3d-coat/3D-CoatV4/3D-Coat/Scripto/SFreeFormPrim.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation