SSConstraintPoint Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class Point3 , Class SpringSys

Description:

This class is available in release 4.0 and later only.

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.

Data Members:

int index

This bone index is used to identify the bone.

This usually refers to a reference item or paramblock index.

Point3 vel, pos;

The control node stored velocity and position.

#include <springsys.h>

Inheritance diagram for SSConstraintPoint:

List of all members.

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)
Public Attributes
int	index
Point3	pos
Point3	vel

---

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; }

---

Member Data Documentation

int index

Search for all occurrences

Point3 pos

Search for all occurrences

Point3 vel

Search for all occurrences