FCurveKey Class Reference
This reference page is linked to from the following overview topics: Object Model Examples.
#include <xsi_fcurvekey.h>
This class represents a key on a function curve (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);
// set the zero slopes on the key tangents
CDoubleArray tangentsArray(12);
i=0;
tangentsArray[i++]=-10.5; tangentsArray[i++]=0; tangentsArray[i++]=10.5; tangentsArray[i++] = 0;
tangentsArray[i++]=-10.5; tangentsArray[i++]=0; tangentsArray[i++]=10.5; tangentsArray[i++] = 0;
tangentsArray[i++]=-10.5; tangentsArray[i++]=0; tangentsArray[i++]=10.5; tangentsArray[i++] = 0;
fcrv.SetKeyTangents( tangentsArray );
Public Member Functions |
|
| FCurveKey () | |
| ~FCurveKey () | |
| FCurveKey (const CRef &in_ref) | |
| FCurveKey (const FCurveKey &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| FCurveKey & | operator= (const FCurveKey &in_obj) |
| FCurveKey & | operator= (const CRef &in_ref) |
| CValue::DataType | GetValueType () const |
| CValue | GetValue (void) const |
| CStatus | PutValue (const CValue &in_value) |
| CTime | GetTime (void) const |
| CStatus | PutTime (const CTime &in_time) |
| bool | GetLocked (void) const |
| CStatus | PutLocked (bool in_bFlag) |
| bool | GetSelected (void) const |
| CValue | GetLeft () const |
| CStatus | PutLeft (const CValue &in_value) |
| CValue | GetRight (void) const |
| CStatus | PutRight (const CValue &in_value) |
| double | GetLeftTanY (void) const |
| CStatus | PutLeftTanY (double in_value) |
| double | GetRightTanY (void) const |
| CStatus | PutRightTanY (double in_value) |
| CTime | GetLeftTanX (void) const |
| CStatus | PutLeftTanX (const CTime &in_value) |
| CTime | GetRightTanX (void) const |
| CStatus | PutRightTanX (const CTime &in_value) |
| siFCurveKeyInterpolation | GetInterpolation (void) const |
| CStatus | PutInterpolation (siFCurveKeyInterpolation in_value) |
| bool | GetConstraint (siFCurveKeyConstraint in_eKC) const |
| CStatus | PutConstraint (siFCurveKeyConstraint in_eKC, bool in_bSet) |
| CStatus | Set (const CTime &in_frame, const CValue &in_value, bool in_overridekeylock=false) |
| LONG | GetIndex (void) const |
| FCurveKey | ( | ) |
Default constructor.
| ~FCurveKey | ( | ) |
Default destructor.
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
| in_ClassID | class type. |
Reimplemented from SIObject.
| siClassID GetClassID | ( | ) | const [virtual] |
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
| in_obj | constant class object. |
| CValue::DataType GetValueType | ( | ) | const |
Returns the value type of the function curve key.
| CValue GetValue | ( | void | ) | const |
Returns the value of the function curve key.
Sets the value of the function curve key.
| in_value | Function curve key value |
| CTime GetTime | ( | void | ) | const |
Returns the key frame for the function curve key.
Sets the frame for the function curve key.
| in_time | Function curve key frame |
| bool GetLocked | ( | void | ) | const |
Returns the locked state of the function curve key.
| CStatus PutLocked | ( | bool | in_bFlag | ) |
Sets the locked state of the function curve key.
| in_bFlag | Function curve key locked state value. |
| bool GetSelected | ( | void | ) | const |
Returns the selected state of the function curve key.
| CValue GetLeft | ( | ) | const |
Returns the left value of the function curve key.
Sets the left value of the function curve key.
| in_value | New left value. |
| CValue GetRight | ( | void | ) | const |
Returns the right value of the function curve key.
Sets the right value of the function curve key.
| in_value | New right value. |
| double GetLeftTanY | ( | void | ) | const |
Returns the left tangent Y value of the function curve key.
| CStatus PutLeftTanY | ( | double | in_value | ) |
Sets the left tangent Y value of the function curve key.
| in_value | New left tangent Y value. |
| double GetRightTanY | ( | void | ) | const |
Returns the right tangent Y value of the function curve key.
| CStatus PutRightTanY | ( | double | in_value | ) |
Sets the right tangent Y value of the function curve key.
| in_value | New right tangent Y value. |
| CTime GetLeftTanX | ( | void | ) | const |
Returns the left tangent key of the function curve key.
Sets the left tangent X value of the function curve key.
| in_value | new left tangent X value. |
| CTime GetRightTanX | ( | void | ) | const |
Returns the right tangent key of the function curve key.
Sets the right tangent X value of the function curve key.
| in_value | new right tangent X value. |
| siFCurveKeyInterpolation GetInterpolation | ( | void | ) | const |
Returns the interpolation type of the function curve key.
| CStatus PutInterpolation | ( | siFCurveKeyInterpolation | in_value | ) |
Sets the interpolation for the function curve key.
| in_value | New interpolation |
| bool GetConstraint | ( | siFCurveKeyConstraint | in_eKC | ) | const |
Returns true if the specified constraint is turned on.
| in_eKC | Type of constraint to query (one of the siFCurveKeyConstraint values). |
| CStatus PutConstraint | ( | siFCurveKeyConstraint | in_eKC, |
| bool | in_bSet | ||
| ) |
Sets the constraint for the function curve key.
| in_eKC | Type of constraint to set (one of the siFCurveKeyConstraint values). |
| in_bSet | True to turn constraint on. |
Sets the function curve key's frame and value.
| in_frame | New key frame. |
| in_value | New key value. |
| in_overridekeylock | True to override key lock. |
| LONG GetIndex | ( | void | ) | const |
Returns the index of this key in the function curve.