SSConstraintPoint Class Reference

#include <springsys.h>

Class Description

See also

Class Point3 , Class SpringSys

This class represents the constraint point object as it is used in the spring system. This controlled particle class is used to constrain a point to an object.

Inheritance diagram for SSConstraintPoint:

Public Member Functions
	SSConstraintPoint ()
	SSConstraintPoint (int id)
	~SSConstraintPoint ()
SSConstraintPoint &	operator= (const SSConstraintPoint &from)
SSConstraintPoint	Copy (const SSConstraintPoint from)
int	GetIndex ()
void	SetIndex (int id)
Point3	GetPos ()
void	SetPos (Point3 p)
Point3	GetVel ()
void	SetVel (Point3 v)
bool	operator== (const SSConstraintPoint &b) const

Public Attributes
int	index
	This bone index is used to identify the bone. More...
Point3	pos
	The control nodes stored position. More...
Point3	vel
	The control nodes stored velocity. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Constructor & Destructor Documentation

SSConstraintPoint ( )

inline

Remarks

Constructor.

Default Implementation:

{ index = -1; pos = Point3(0.0f, 0.0f, 0.0f);

vel = Point3(0.0f, 0.0f, 0.0f); }

{index = -1; pos = Point3(0.0f, 0.0f, 0.0f); vel = Point3(0.0f, 0.0f, 0.0f);}

SSConstraintPoint ( int  id )

inline

Remarks

Constructor.

Parameters:

int id

The index to initialize with.

Default Implementation:

{index = id; vel = Point3(0,0,0);}

{index = id; pos = Point3(0.0f, 0.0f, 0.0f); vel = Point3(0,0,0);}

~SSConstraintPoint ( )

inline

Remarks

Destructor.

Default Implementation:

{ }

{}

Member Function Documentation

SSConstraintPoint& operator= ( const SSConstraintPoint &  from )

inline

Remarks

Assignment operator.

        {
            index = from.index;
            pos = from.pos;
            vel = from.vel;
            
            return *this;
        }

SSConstraintPoint Copy ( const SSConstraintPoint  from )

inline

Remarks

This method allows you to copy the data from the specified SSConstraintPoint.

Parameters:

const SSConstraintPoint from

The object to copy from.

        {
            index = from.index;
            pos = from.pos;
            vel = from.vel;
            
            return *this;
        }

int GetIndex ( )

inline

Remarks

This method returns the value of the index.

{ return index; }

void SetIndex ( int  id )

inline

Remarks

This method allows you to set the index.

{ index = id; }

Point3 GetPos ( )

inline

Remarks

This method returns the position data.

{ return pos; }

void SetPos ( Point3  p )

inline

Remarks

This method allows you to set the position data.

Parameters:

Point3 p

The position to set.

{ pos = p; }

Point3 GetVel ( )

inline

Remarks

This method returns the velocity data.

{ return vel; }

void SetVel ( Point3  v )

inline

Remarks

This method allows you to set the velocity data.

Parameters:

Point3 v

The velocity data to set.

{ vel = v; }

bool operator== ( const SSConstraintPoint &  b ) const

inline

Remarks

Compares this class instance to another one

        {
            return index == b.index && pos == b.pos && vel == b.vel;
        }

Member Data Documentation

int index

This bone index is used to identify the bone.

Usually refers to a reference index, or paramblock index.

Point3 pos

The control nodes stored position.

Point3 vel

The control nodes stored velocity.