Detailed Description
This class represents an array of keys on a function curve (FCurve). Duplicate keys are not allowed and a single array can only hold keys from the same fcurve.
- See also:
- CRefArray, FCurveKeys, FCurve::GetKeys, FCurve::GetKeysBetween
- Since:
- 6.0
- Example:
- This example demonstrates how to get a list of references to all keys in an FCurve
#include <xsi_fcurvekey.h>
List of all members.
Constructor & Destructor Documentation
Copy constructor. Performs a shallow copy, so any change to one instance will appear in any of the copies.
Member Function Documentation
Assigns a CFCurveKeyRefArray object to this one.
- Parameters:
-
- Returns:
- A new reference array.
- Since:
- 6.0
virtual void Add |
( |
const CRef & |
in_item | ) |
[virtual] |
Adds another FCurveKey to this array. The item will be added only if it is not already in the array and it belongs to the same FCurve as existing keys. CFCurveKeyRefArray will add keys to the array so that the array is sorted by frame time.
- Parameters:
-
in_item | The reference to an FCurveKey to be added. |
- Since:
- 6.0
Reimplemented from CRefArray.
Adds the keys from another CFCurveKeyRefArray into this array. The keys will be added to this array only if they are not already in the array and they belong to the same FCurve as existing keys.
Keys will be added to the array sorted by frame time.
- Parameters:
-
in_keys | Array of references to FCurveKey objects to add |
- Since:
- 6.0
void RemoveAt |
( |
LONG |
in_index | ) |
|
Removes an item from the specified location in the array.
- Parameters:
-
in_index | Index of item to remove |
- Since:
- 6.0
CTime GetMinKeyFrame |
( |
void |
| ) |
const |
CTime GetMidKeyFrame |
( |
void |
| ) |
const |
Returns the average of the first and last key times in the array.
- Returns:
- Center key time
-
CStatus::Fail If the array has no keys
- Since:
- 6.0
CTime GetMaxKeyFrame |
( |
void |
| ) |
const |
Returns the largest key time in the array.
- Returns:
- Maximum key time
-
CStatus::Fail If the array has no keys
- Since:
- 6.0
CValue GetMinKeyValue |
( |
void |
| ) |
const |
Returns the smallest key value in the array.
- Returns:
- Minimum key value
-
CStatus::Fail If the array has no keys
- Since:
- 6.0
CValue GetMidKeyValue |
( |
void |
| ) |
const |
Returns the average of the largest and smallest key values in the array.
- Returns:
- Center key value
-
CStatus::Fail If the array has no keys
- Since:
- 6.0
CValue GetMaxKeyValue |
( |
void |
| ) |
const |
Returns the largest key value in the array.
- Returns:
- Maximum key value
-
CStatus::Fail If the array has no keys
- Since:
- 6.0
The documentation for this class was generated from the following file: