CFCurveKeyRefArray Class
Reference
#include <xsi_fcurvekey.h>
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.
using namespace XSI;
Application app;
Model root = app.GetActiveSceneRoot();
Null myNull;
root.AddNull( L"", myNull );
Parameter posx( myNull.GetParameter( L"posx" ) );
// Create and connect an function curve to the position x
FCurve fcrv;
posx.AddFCurve( siUnknownFCurve, fcrv );
// Set the keys
LONG i = 0;
CTimeArray timeArray(3);
CValueArray valueArray(3);
timeArray[i] = 1; valueArray[i] = (double)10; i++;
timeArray[i] = 50; valueArray[i] = (double)0; i++;
timeArray[i] = 100; valueArray[i] = (double)10; i++;
fcrv.SetKeys(timeArray,valueArray);
// Get the keys
CFCurveKeyRefArray keys = fcrv.GetKeys();
Public Member Functions |
|
| CFCurveKeyRefArray () | |
| CFCurveKeyRefArray (const CFCurveKeyRefArray &) | |
| ~CFCurveKeyRefArray () | |
| CFCurveKeyRefArray & | operator= (const CFCurveKeyRefArray &in_refArray) |
| CFCurveKeyRefArray & | operator+= (const CFCurveKeyRefArray &in_refArray) |
| virtual void | Add (const CRef &in_item) |
| void | AddItems (const CFCurveKeyRefArray &in_keys) |
| void | RemoveAt (LONG in_index) |
| CTime | GetMinKeyFrame (void) const |
| CTime | GetMidKeyFrame (void) const |
| CTime | GetMaxKeyFrame (void) const |
| CValue | GetMinKeyValue (void) const |
| CValue | GetMidKeyValue (void) const |
| CValue | GetMaxKeyValue (void) const |
Default constructor.
| CFCurveKeyRefArray | ( | const CFCurveKeyRefArray & | ) |
Copy constructor. Performs a shallow copy, so any change to one instance will appear in any of the copies.
| ~CFCurveKeyRefArray | ( | ) |
Default destructor.
| CFCurveKeyRefArray& operator= | ( | const CFCurveKeyRefArray & | in_refArray | ) |
Assigns a CFCurveKeyRefArray object to this one.
| in_refArray | A constant CFCurveKeyRefArray object. |
| CFCurveKeyRefArray& operator+= | ( | const CFCurveKeyRefArray & | in_refArray | ) |
Adds a CFCurveKeyRefArray object to this one.
| in_refArray | A constant CFCurveKeyRefArray object. |
| 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.
| in_item | The reference to an FCurveKey to be added. |
Reimplemented from CRefArray.
| void AddItems | ( | const CFCurveKeyRefArray & | in_keys | ) |
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.
| in_keys | Array of references to FCurveKey objects to add |
| void RemoveAt | ( | LONG | in_index | ) |
Removes an item from the specified location in the array.
| in_index | Index of item to remove |
| CTime GetMinKeyFrame | ( | void | ) | const |
Returns the smallest key time in the CFCurveKeyRefArray.
| CTime GetMidKeyFrame | ( | void | ) | const |
Returns the average of the first and last key times in the array.
| CTime GetMaxKeyFrame | ( | void | ) | const |
Returns the largest key time in the array.
| CValue GetMinKeyValue | ( | void | ) | const |
Returns the smallest key value in the array.
| CValue GetMidKeyValue | ( | void | ) | const |
Returns the average of the largest and smallest key values in the array.
| CValue GetMaxKeyValue | ( | void | ) | const |
Returns the largest key value in the array.