IKeyControl2 Class Reference

#include <istdplug.h>

Class Description

Extend IKeyControl to include interfaces to IKeyProperty.

Keys of a key controller may have extra properties that does not affect the interpolated value. These properties are accessed through interface IKeyProperty. IKeyControl2 provides interface to the Key Property of individual keys.
The interface ID is I_KEYCONTROL2 defined in AnimatableInterfaceIDs.h.

Inheritance diagram for IKeyControl2:

Public Member Functions
virtual bool	DoesKeyPropExist (IKeyProperty::PropID id)
	Whether the key of this key controller has property of ID id. More...
virtual const IKeyProperty *	GetKeyProp (IKeyProperty::PropID id, int i)
	Get the property of the i-th key. More...
virtual bool	SetKeyProp (IKeyProperty::PropID id, int i, const IKeyProperty &prop)
	Set the property to the i-th key. More...
Public Member Functions inherited from IKeyControl
virtual int	GetNumKeys ()=0
virtual void	SetNumKeys (int n)=0
virtual void	GetKey (int i, IKey *key)=0
virtual void	SetKey (int i, IKey *key)=0
virtual int	AppendKey (IKey *key)=0
virtual void	SortKeys ()=0
virtual DWORD &	GetTrackFlags ()=0
virtual int	GetKeySize ()

Additional Inherited Members
Public Types inherited from IKeyControl
typedef IKey	KeyType
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

virtual bool DoesKeyPropExist ( IKeyProperty::PropID  id )

inlinevirtual

Whether the key of this key controller has property of ID id.

Parameters

[in]

id

- the property ID being queried.

Returns

true if it has the property of ID id.

{ return false;}

virtual const IKeyProperty* GetKeyProp ( IKeyProperty::PropID  id, int  i  )

inlinevirtual

Get the property of the i-th key.

Use this method to get the property of the i-th key.

Parameters

[in]	id	- the property ID.
[in]	i	- the index of the key

Returns

a pointer to the key property object. It may return null
if the property of the respected ID does not exist at the key
of this key frame controller. To get the actual attributes of the
properties, cast the returned pointer to the appropriate property interface.
The returned pointer must be deleted after use.

{ return NULL; }

virtual bool SetKeyProp ( IKeyProperty::PropID  id, int  i, const IKeyProperty &  prop  )

inlinevirtual

Set the property to the i-th key.

Parameters

[in]	id	- the property ID.
[in]	i	the index for the key at which to set.
[in]	prop	- the property object whose values are used for set-value. The implementation will cast it to appropriate property interface and call the get methods to extract values. The values will be checked against the expected range. An attribute of the key property won't be affected if the value of that particular attribute is out of range.

Returns

true if set the key property has actually affected. It can
be false if (a) this key controller does not have the property, or
(b) the values in prop are out of expected ranges.

{ return false; }