IGameKnot Class Reference

Search for all occurrences

---

Detailed Description

Simple wrapper for spline knots.

An IGame wrapper for Knot information

#include <IGameObject.h>

Inheritance diagram for IGameKnot:

List of all members.

Public Types
enum	KnotType { KNOT_AUTO, KNOT_CORNER, KNOT_BEZIER, KNOT_BEZIER_CORNER }
	Knot types. More...
enum	KnotData { KNOT_INVEC, KNOT_OUTVEC, KNOT_POINT }
	Knot data. More...
Public Member Functions
virtual	~IGameKnot ()
	Destructor.
virtual Point3	GetInVec ()=0
	Get the in vector.
virtual Point3	GetOutVec ()=0
	Get the out vector.
virtual Point3	GetKnotPoint ()=0
	Get actual knot position.
virtual KnotType	GetKnotType ()=0
	Get the type of knot.
virtual IGameControl *	GetKnotControl (KnotData kd)=0
	Get the knot controller.

---

Member Enumeration Documentation

enum KnotType

Search for all occurrences

Knot types.

Enumerator:

KNOT_AUTO	Auto generate Knot. Search for all occurrences
KNOT_CORNER	A corner knot. Search for all occurrences
KNOT_BEZIER	A bezier knot. Search for all occurrences
KNOT_BEZIER_CORNER	A bezier corner knot. Search for all occurrences

                 {
        KNOT_AUTO,              
        KNOT_CORNER,            
        KNOT_BEZIER,            
        KNOT_BEZIER_CORNER,     
    };

enum KnotData

Search for all occurrences

Knot data.

Enumerator:

KNOT_INVEC	The in vector. Search for all occurrences
KNOT_OUTVEC	The out vector. Search for all occurrences
KNOT_POINT	The actual knot position. Search for all occurrences

                 {
        KNOT_INVEC,             
        KNOT_OUTVEC,            
        KNOT_POINT,             
    };

---

Constructor & Destructor Documentation

virtual ~IGameKnot

(

)

[inline, virtual]

Destructor.

{;}

---

Member Function Documentation

virtual Point3 GetInVec

(

)

[pure virtual]

Search for all occurrences

Get the in vector.

Returns:

The in vector

virtual Point3 GetOutVec

(

)

[pure virtual]

Search for all occurrences

Get the out vector.

Returns:

The out vector

virtual Point3 GetKnotPoint

(

)

[pure virtual]

Search for all occurrences

Get actual knot position.

Returns:

The knot position

virtual KnotType GetKnotType

(

)

[pure virtual]

Search for all occurrences

Get the type of knot.

Returns:

The knot as a IGameKnot::KnotType

virtual IGameControl* GetKnotControl

(

KnotData

kd

)

[pure virtual]

Search for all occurrences

Get the knot controller.

Get the actual IGameController for the knot - this provides access to any animated data

Parameters:

kd	The knot to access

Returns:

The controller for the specified knot