ISetIKKeyProp Class Reference

#include <istdplug.h>

Class Description

This is a helper class.

If we want to set just one attribute of the IK Key Property, we can derive a new class from it as follows:

class SetIKBlendProp : public ISetIKKeyProp {
public:
    SetIKBlendProp(float blend) : mBlend(blend) {}
    float GetIKBlend() const { return mBlend; }
    bool  SetIKBlend() const { return true; }
    float mBlend;
};
IKeyControl2* keyControl = (IKeyControl2*)control->GetInterface(I_KEYCONTROL2);
SetIKBlendProp prop(new_blend_value);
keyControl->SetKeyProp(IKeyProperty::kIKProp, key_index, prop); 

Inheritance diagram for ISetIKKeyProp:

Public Member Functions
float	GetIKBlend () const
	Override IIKKeyProp::GetIKBlend(). More...
EnumIKSpace	GetIKSpace () const
	Override IIKKeyProp::GetIKSpace(). More...
bool	GetPivotOn () const
	Override IIKKeyProp::GetPivotOn(). More...
Point3	GetWorldPivot () const
	Override IIKKeyProp::GetWorldPivot(). More...
INode *	GetPivotNode () const
	Override IIKKeyProp::GetPivotNode(). More...
Public Member Functions inherited from IIKKeyProp
PropID	GetPropID () const
	The Property ID of this interface. More...
virtual bool	SetIKBlend () const
	When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the IK Blend attribute. More...
virtual bool	SetIKSpace () const
	When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the IK Space attribute. More...
virtual bool	SetPivotOn () const
	When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the Pivot On attribute. More...
virtual bool	SetWorldPivot () const
	When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the World Pivot attribute. More...
virtual bool	SetPivotNode () const
	When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the Pivot Node attribute. More...
Public Member Functions inherited from IKeyProperty
virtual	~IKeyProperty ()
	Virtual destructor. More...

Additional Inherited Members
Public Types inherited from IIKKeyProp
enum	EnumIKSpace { kBodySpace, kObjectSpace }
	The enum type for the space with regard to which the IK goal is interpreted. More...
Public Types inherited from IKeyProperty
enum	PropID { kIKProp }
	Property ID enumeration. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Member Function Documentation

float GetIKBlend ( ) const

inlinevirtual

Override IIKKeyProp::GetIKBlend().

Implements IIKKeyProp.

{ return 0.0f; }

EnumIKSpace GetIKSpace ( ) const

inlinevirtual

Override IIKKeyProp::GetIKSpace().

Implements IIKKeyProp.

{ return kObjectSpace; }

bool GetPivotOn ( ) const

inlinevirtual

Override IIKKeyProp::GetPivotOn().

Implements IIKKeyProp.

{ return false; }

Point3 GetWorldPivot ( ) const

inlinevirtual

Override IIKKeyProp::GetWorldPivot().

Implements IIKKeyProp.

{ return Point3::Origin; }

INode* GetPivotNode ( ) const

inlinevirtual

Override IIKKeyProp::GetPivotNode().

Implements IIKKeyProp.

{ return NULL; }