SSConstraintPoint Class Reference

Search for all occurrences

#include <springsys.h>

Inheritance diagram for SSConstraintPoint:

---

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.

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.
Point3	pos
	The control nodes stored position.
Point3	vel
	The control nodes stored velocity.

---

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]

Search for all occurrences

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]

Search for all occurrences

Remarks:

This method returns the value of the index.

{ return index; }

void SetIndex

(

int

id

)

[inline]

Search for all occurrences

Remarks:

This method allows you to set the index.

{ index = id; }

Point3 GetPos

(

)

[inline]

Search for all occurrences

Remarks:

This method returns the position data.

{ return pos; }

void SetPos

(

Point3

p

)

[inline]

Search for all occurrences

Remarks:

This method allows you to set the position data.

Parameters:

Point3 p

The position to set.

{ pos = p; }

Point3 GetVel

(

)

[inline]

Search for all occurrences

Remarks:

This method returns the velocity data.

{ return vel; }

void SetVel

(

Point3

v

)

[inline]

Search for all occurrences

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

Search for all occurrences

This bone index is used to identify the bone.

Usually refers to a reference index, or paramblock index.

Point3 pos

Search for all occurrences

The control nodes stored position.

Point3 vel

Search for all occurrences

The control nodes stored velocity.