Public Member Functions

FBPropertyAnimatable Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, MotionBuilder 2013, FBProperty - Object Properties.


Search for all occurrences

Detailed Description

Animatable property base class.

Definition at line 1461 of file fbproperties.h.

#include <fbproperties.h>

Inheritance diagram for FBPropertyAnimatable:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBPropertyAnimatable ()
 Constructor.
virtual ~FBPropertyAnimatable ()
 Destructor.
FBPropertyAnimatableInitInternal (KEvaluationProperty *pProperty)
 Initialize internal pointer.
FBPropertyAnimatableInit (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.
FBAnimationNodeGetAnimationNode (FBTake *pTake=NULL)
 Get the animation node for the property.
FBBoxGetBox ()
 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 & Destructor Documentation

Constructor.

virtual ~FBPropertyAnimatable ( ) [virtual]

Destructor.


Member Function Documentation

FBPropertyAnimatable* InitInternal ( KEvaluationProperty *  pProperty)

Initialize internal pointer.

FBPropertyAnimatable* Init ( FBBox pOwner,
const char *  pName,
const char *  pType,
double *  pInit 
)

Initialization function (custom).

Parameters:
pOwnerOwner box object.
pNameName of property to add.
pTypeType name (string) of property.
pInitInitialization value.
Returns:
this, once initialized.
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]

Get the property datatype pointer.

Returns:
Datatype of property.

Reimplemented from FBProperty.

const char* GetDataTypeName ( )

Get the property datatype name.

Returns:
Datatype of property as a character string.
bool IsFocused ( )

Is the property focused (keyable).

Returns:
Current focus (keyable) state for the property.
void SetFocus ( bool  pState)

Set the property's focus (keyable) state.

Parameters:
pStateFocus (keyable) state to set for the property.
void Key ( )

Key the property.

void KeyAt ( FBTime  pTime)

Key the property at time (t).

Parameters:
pTimeTime at which to insert the key.
void KeyRemoveAt ( FBTime  pTime)

Remove the key at time (t).

Parameters:
pTimeTime at which to insert the key.
int GetDataSize ( ) const

Get the data size (number of values) for the connector.

Returns:
Data size.
virtual bool IsAnimatable ( ) [inline, override, virtual]

Certify that the property is animatable.

Returns:
true because it is necessarely an animatable property.

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.

Returns:
true if animated, false if not animated.
void SetAnimated ( bool  pState)

Set the animation state of the property.

Parameters:
pStateState of animation for property, true to animate, false to remove curves.
FBAnimationNode* GetAnimationNode ( FBTake pTake = NULL)

Get the animation node for the property.

Parameters:
pTaketo get the animation node from.
Returns:
Animation node for property. NULL is returned if property is not animated.
FBBox* GetBox ( )

Get the owner box.

Returns:
Handle to the owning box (i.e. model).
virtual void SetData ( void *  pData) [override, virtual]

Set the value of the property, passing the type as an argument.

Parameters:
pDataValue 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.

Return values:
pValueValue to fill with property's current value.

Reimplemented from FBProperty.

void SetCandidate ( void *  pData,
int  pSize,
FBEvaluateInfo pEvalInfo = NULL 
)

Set the candidate.

Parameters:
pDataValue of data to candidate.
pSizeThe size of the current type of data.
pEvalInfoCandidate time.
void SetGlobalCandidate ( void *  pData,
int  pSize,
FBEvaluateInfo pEvalInfo = NULL 
)

Set the global candidate (useful for model TRS).

Parameters:
pDataValue of data to candidate.
pSizeThe Size of the current type of data.
pEvalInfoCandidate time.
bool AllowsMuting ( ) const

AllowsMuting.

Returns:
true if property can be muted
bool HasSomethingMuted ( ) const

HasSomethingMuted.

Returns:
true if property or any of its members is muted
bool IsMuted ( ) const

IsMuted.

Returns:
true if property is muted
bool IsMemberMuted ( int  pIndex) const

IsMemberMuted.

Parameters:
pIndexIndex of the sub-member of the property to check.
Returns:
true if property sub-member is muted
void SetMuted ( bool  pMuted)

SetMuted.

Parameters:
pMutedTrue if the property is to be muted, false if it is to be unmuted.
void SetMemberMuted ( int  pIndex,
bool  pMuted 
)

SetMemberMuted.

Parameters:
pIndexIndex of the sub-member of the property to mute or unmute.
pMutedTrue if the sub-member is to be muted, false if it is to be unmuted.

The documentation for this class was generated from the following file:

FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable
FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable FBPropertyAnimatable