IKeyControl2 Class Reference

Search for all occurrences

---

Detailed 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.

#include <istdplug.h>

Inheritance diagram for IKeyControl2:

List of all members.

Public Member Functions
virtual bool	DoesKeyPropExist (IKeyProperty::PropID id)
	Whether the key of this key controller has property of ID id.
virtual const IKeyProperty *	GetKeyProp (IKeyProperty::PropID id, int i)
	Get the property of the i-th key.
virtual bool	SetKeyProp (IKeyProperty::PropID id, int i, const IKeyProperty &prop)
	Set the property to the i-th key.

---

Member Function Documentation

virtual bool DoesKeyPropExist

(

IKeyProperty::PropID

id

)

[inline, virtual]

Search for all occurrences

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
	)		[inline, virtual]

Search for all occurrences

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
	)		[inline, virtual]

Search for all occurrences

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; }