IGameKnot Class Reference

Simple wrapper for spline knots. More...

#include <IGameObject.h>

Inheritance diagram for IGameKnot:

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.

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

Simple wrapper for spline knots.

An IGame wrapper for Knot information

Member Enumeration Documentation

KnotType

enum KnotType

Knot types.

Enumerator
KNOT_AUTO	Auto generate Knot.
KNOT_CORNER	A corner knot.
KNOT_BEZIER	A bezier knot.
KNOT_BEZIER_CORNER	A bezier corner knot.

                 {
        KNOT_AUTO,              
        KNOT_CORNER,            
        KNOT_BEZIER,            
        KNOT_BEZIER_CORNER,     
    };

KnotData

enum KnotData

Knot data.

Enumerator
KNOT_INVEC	The in vector.
KNOT_OUTVEC	The out vector.
KNOT_POINT	The actual knot position.

                 {
        KNOT_INVEC,             
        KNOT_OUTVEC,            
        KNOT_POINT,             
    };

Constructor & Destructor Documentation

~IGameKnot()

virtual ~IGameKnot ( )

inlinevirtual

Destructor.

{;}

Member Function Documentation

GetInVec()

virtual Point3 GetInVec ( )

pure virtual

Get the in vector.

Returns

The in vector

GetOutVec()

virtual Point3 GetOutVec ( )

pure virtual

Get the out vector.

Returns

The out vector

GetKnotPoint()

virtual Point3 GetKnotPoint ( )

pure virtual

Get actual knot position.

Returns

The knot position

GetKnotType()

virtual KnotType GetKnotType ( )

pure virtual

Get the type of knot.

Returns

The knot as a IGameKnot::KnotType

GetKnotControl()

virtual IGameControl * GetKnotControl ( KnotData  kd )

pure virtual

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