This reference page is linked to from the following overview topics: MotionBuilder 2014, MotionBuilder 2013, FBProperty - Object Properties.
Animatable property base class.
Definition at line 1461 of file fbproperties.h.
#include <fbproperties.h>
Public Member Functions | |
FBPropertyAnimatable () | |
Constructor. | |
virtual | ~FBPropertyAnimatable () |
Destructor. | |
FBPropertyAnimatable * | InitInternal (KEvaluationProperty *pProperty) |
Initialize internal pointer. | |
FBPropertyAnimatable * | Init (FBBox *pOwner, const char *pName, const char *pType, double *pInit) |
Initialization function (custom). | |
void | Destroy () |
Destruction function, for internal connectors. | |
virtual KDataType * | GetDataType () override |
Get the property datatype pointer. | |
const char * | GetDataTypeName () |
Get the property datatype name. | |
bool | IsFocused () |
Is the property focused (keyable). | |
void | SetFocus (bool pState) |
Set the property's focus (keyable) state. | |
void | Key () |
Key the property. | |
void | KeyAt (FBTime pTime) |
Key the property at time (t). | |
void | KeyRemoveAt (FBTime pTime) |
Remove the key at time (t). | |
int | GetDataSize () const |
Get the data size (number of values) for the connector. | |
virtual bool | IsAnimatable () override |
Certify that the property is animatable. | |
bool | IsAnimated () |
Is the property animated. | |
void | SetAnimated (bool pState) |
Set the animation state of the property. | |
FBAnimationNode * | GetAnimationNode (FBTake *pTake=NULL) |
Get the animation node for the property. | |
FBBox * | GetBox () |
Get the owner box. | |
virtual void | SetData (void *pData) override |
Set the value of the property, passing the type as an argument. | |
virtual void | GetData (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL) const override |
Get the value of a property. | |
void | SetCandidate (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL) |
Set the candidate. | |
void | SetGlobalCandidate (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL) |
Set the global candidate (useful for model TRS). | |
Interface for animatable property mute mechanism. | |
Muting an animatable property (or its channels) prevents animation from flowing through a property (or its channels). This means that value of a muted property (or its channels) will be the value upon muting, instead of changing over time as it is being driven by its existing animation and/or constraints. User however can still modify the muted property to add/remove/edit existing keys. | |
bool | AllowsMuting () const |
AllowsMuting. | |
bool | HasSomethingMuted () const |
HasSomethingMuted. | |
bool | IsMuted () const |
IsMuted. | |
bool | IsMemberMuted (int pIndex) const |
IsMemberMuted. | |
void | SetMuted (bool pMuted) |
SetMuted. | |
void | SetMemberMuted (int pIndex, bool pMuted) |
SetMemberMuted. |
Constructor.
virtual ~FBPropertyAnimatable | ( | ) | [virtual] |
Destructor.
FBPropertyAnimatable* InitInternal | ( | KEvaluationProperty * | pProperty | ) |
Initialize internal pointer.
FBPropertyAnimatable* Init | ( | FBBox * | pOwner, |
const char * | pName, | ||
const char * | pType, | ||
double * | pInit | ||
) |
Initialization function (custom).
pOwner | Owner box object. |
pName | Name of property to add. |
pType | Type name (string) of property. |
pInit | Initialization value. |
void Destroy | ( | ) |
Destruction function, for internal connectors.
Used in the case of custom properties in order to remove the connectors.
virtual KDataType* GetDataType | ( | ) | [override, virtual] |
const char* GetDataTypeName | ( | ) |
Get the property datatype name.
bool IsFocused | ( | ) |
Is the property focused (keyable).
void SetFocus | ( | bool | pState | ) |
Set the property's focus (keyable) state.
pState | Focus (keyable) state to set for the property. |
void Key | ( | ) |
Key the property.
void KeyAt | ( | FBTime | pTime | ) |
Key the property at time (t).
pTime | Time at which to insert the key. |
void KeyRemoveAt | ( | FBTime | pTime | ) |
Remove the key at time (t).
pTime | Time at which to insert the key. |
int GetDataSize | ( | ) | const |
Get the data size (number of values) for the connector.
virtual bool IsAnimatable | ( | ) | [inline, override, virtual] |
Certify that the property is animatable.
Reimplemented from FBProperty.
Definition at line 1534 of file fbproperties.h.
{ return true; }
bool IsAnimated | ( | ) |
Is the property animated.
This is true if the property has an FCurve associated to it.
void SetAnimated | ( | bool | pState | ) |
Set the animation state of the property.
pState | State of animation for property, true to animate, false to remove curves. |
FBAnimationNode* GetAnimationNode | ( | FBTake * | pTake = NULL | ) |
Get the animation node for the property.
pTake | to get the animation node from. |
FBBox* GetBox | ( | ) |
virtual void SetData | ( | void * | pData | ) | [override, virtual] |
Set the value of the property, passing the type as an argument.
pData | Value to affect property with. |
Reimplemented from FBProperty.
virtual void GetData | ( | void * | pData, |
int | pSize, | ||
FBEvaluateInfo * | pEvalInfo = NULL |
||
) | const [override, virtual] |
Get the value of a property.
pValue | Value to fill with property's current value. |
Reimplemented from FBProperty.
void SetCandidate | ( | void * | pData, |
int | pSize, | ||
FBEvaluateInfo * | pEvalInfo = NULL |
||
) |
Set the candidate.
pData | Value of data to candidate. |
pSize | The size of the current type of data. |
pEvalInfo | Candidate time. |
void SetGlobalCandidate | ( | void * | pData, |
int | pSize, | ||
FBEvaluateInfo * | pEvalInfo = NULL |
||
) |
Set the global candidate (useful for model TRS).
pData | Value of data to candidate. |
pSize | The Size of the current type of data. |
pEvalInfo | Candidate time. |
bool AllowsMuting | ( | ) | const |
bool HasSomethingMuted | ( | ) | const |
HasSomethingMuted.
bool IsMuted | ( | ) | const |
bool IsMemberMuted | ( | int | pIndex | ) | const |
IsMemberMuted.
pIndex | Index of the sub-member of the property to check. |
void SetMuted | ( | bool | pMuted | ) |
SetMuted.
pMuted | True if the property is to be muted, false if it is to be unmuted. |
void SetMemberMuted | ( | int | pIndex, |
bool | pMuted | ||
) |
SetMemberMuted.
pIndex | Index of the sub-member of the property to mute or unmute. |
pMuted | True if the sub-member is to be muted, false if it is to be unmuted. |