IIKGoal Class Reference

Search for all occurrences

#include <ikhierarchy.h>

Inheritance diagram for IIKGoal:

---

Class Description

See also:

: Class BaseInterface

class IIKGoal : public BaseInterface

Description:

This class is only available in release 5 or later. This is the interface class that various types of IK goal will derive from. The unique interface id will specify what type of goal this interface provides.

Public Member Functions
BaseInterface *	GetInterface (Interface_ID id)
Interface_ID	GetID ()
LifetimeType	LifetimeControl ()
CoreExport void	ReleaseInterface ()
virtual	~IIKGoal ()

---

Constructor & Destructor Documentation

virtual ~IIKGoal

(

)

[inline, virtual]

Remarks:

Delete the interface. However, IT IS HEAVILY ADVISED that one must FIRST RELEASE the interface BEFORE delete is called.

{}

---

Member Function Documentation

BaseInterface* GetInterface

(

Interface_ID

id

)

[inline, virtual]

Search for all occurrences

Remarks:

Returns a pointer of type BaseInterface for the interface IIKGoal

Parameters:

Interface_ID id

Input id = kGoalID(<b>0x53937e2, 0x2be92941)

Remarks:

Returns, Interface_ID kGoalID(0x53937e2, 0x2be92941)

Reimplemented from BaseInterface.

Reimplemented in IHIIKGoal, and ISplineIKGoal.

{ if (id == kGoalID) return this; else return BaseInterface::GetInterface(id); }

Interface_ID GetID

(

)

[inline, virtual]

Search for all occurrences

Remarks:

Returns, Interface_ID kGoalID(0x53937e2, 0x2be92941)

Reimplemented from BaseInterface.

Reimplemented in IHIIKGoal, ISplineIKGoal, and ISplineIKGoal2.

{ return kGoalID; }

LifetimeType LifetimeControl

(

)

[inline, virtual]

Search for all occurrences

Remarks:

Indicates to the function-published system that this interface wants to be released automatically upon disuse.

Reimplemented from BaseInterface.

{ return wantsRelease; }

CoreExport void ReleaseInterface

(

)

[virtual]

Search for all occurrences

Remarks:

Manually release this interface.

Reimplemented from BaseInterface.