Open Reality Reference Guide
FBPropertyAnimatable Class Reference

Animatable property base class. More...

#include <fbproperties.h>

Inheritance diagram for FBPropertyAnimatable:

Public Member Functions

 FBPropertyAnimatable ()
 Constructor. More...
 
virtual ~FBPropertyAnimatable ()
 Destructor. More...
 
FBPropertyAnimatableInit (FBBox *pOwner, const char *pName, const char *pType, double *pInit)
 Initialization function (custom). More...
 
void Destroy ()
 Destruction function, for internal connectors. More...
 
virtual KDataType * GetDataType () override
 Get the property datatype pointer. More...
 
const char * GetDataTypeName ()
 Get the property datatype name. More...
 
bool IsFocused ()
 Is the property focused (keyable). More...
 
void SetFocus (bool pState)
 Set the property's focus (keyable) state. More...
 
void Key ()
 Key the property. More...
 
void KeyAt (FBTime pTime)
 Key the property at time (t). More...
 
void KeyRemoveAt (FBTime pTime)
 Remove the key at time (t). More...
 
int GetDataSize () const
 Get the data size (number of values) for the connector. More...
 
virtual bool IsAnimatable () override
 Certify that the property is animatable. More...
 
bool IsAnimated ()
 Is the property animated. More...
 
void SetAnimated (bool pState, bool pCheckLocked=false)
 Set the animation state of the property. More...
 
FBAnimationNodeGetAnimationNode (FBTake *pTake=NULL)
 Get the animation node for the property. More...
 
FBBoxGetBox ()
 Get the owner box. More...
 
virtual void SetData (void *pData) override
 Set the value of the property, passing the type as an argument. More...
 
virtual void GetData (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL) const override
 Get the value of a property. More...
 
void SetCandidate (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL)
 Set the candidate. More...
 
void SetGlobalCandidate (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL)
 Set the global candidate (useful for model TRS). More...
 
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. More...
 
bool HasSomethingMuted () const
 HasSomethingMuted. More...
 
bool IsMuted () const
 IsMuted. More...
 
bool IsMemberMuted (int pIndex) const
 IsMemberMuted. More...
 
void SetMuted (bool pMuted)
 SetMuted. More...
 
void SetMemberMuted (int pIndex, bool pMuted)
 SetMemberMuted. More...
 
bool SetColor (const FBColor &pColor, int pIndex)
 Set the color of the FCurves for the property. More...
 
FBColor GetColor (int pIndex)
 Get the color of a particular FCurve of the property. More...
 
bool ResetColor (int pIndex)
 Revert the FCurves to their default color. More...
 
bool IsFocusedChild (int pIndex)
 Get the focus (keyable) state of child component. More...
 
bool SetFocusChild (int pIndex, bool pState)
 Set the focus (keyable) state of child component. More...
 
- Public Member Functions inherited from FBProperty
 FBProperty ()
 Constructor. More...
 
void SetEnable (bool pValue)
 Set property enable status. More...
 
const char * GetName ()
 Get the property's name. More...
 
void SetName (const char *pName)
 Set the property's name. More...
 
virtual FBPropertyType GetPropertyType ()
 Get the property's type. More...
 
const char * GetPropertyTypeName ()
 Get the property's type name. More...
 
int AsInt ()
 Get the property as an integer. More...
 
bool SetInt (int pInt)
 Set the property from an integer. More...
 
virtual const char * AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
 Get the property value as a string. More...
 
virtual bool SetString (const char *pString)
 Set the property value from a string. More...
 
const char * OriValueAsString ()
 Get the property original value (before any modification) as string. More...
 
bool IsAnimated () const
 Get the property animated flag status. More...
 
bool OriIsAnimated () const
 Get the property original animated flag status (before any modification) More...
 
virtual bool IsList ()
 Verify if property is of this type. More...
 
bool IsInternal () const
 
bool IsUserProperty ()
 
bool IsTextureConnectableProperty ()
 
bool IsReferenceProperty ()
 
bool IsMinClamp ()
 Indicate if minimum value clamping will be applied on user input value. More...
 
bool IsMaxClamp ()
 Indicate if maximum value clamping will be applied on user input value. More...
 
bool IsTemporaryProperty ()
 Indicate if a property was created on retrieve because it didn't exist. More...
 
bool AcceptTemporaryProperty (const char *pEnumList[]=NULL, fbExternalGetSetHandler pGet=NULL, fbExternalGetSetHandler pSet=NULL)
 Accept a temporary property as a dynamic property. More...
 
bool IsObjectList ()
 Indicate if is an instance of FBPropertyListObject. More...
 
virtual bool IsReadOnly ()
 Is property read-only? More...
 
virtual const char * EnumList (int pIndex)
 Return the string of an enum value. More...
 
FBStringListGetEnumStringList (bool pCreateIt=false)
 String list for enum properties. More...
 
void NotifyEnumStringListChanged ()
 Notify system that the enum list was modified. More...
 
void ModifyPropertyFlag (FBPropertyFlag pFlag, bool pValue)
 ModifyPropertyFlag. More...
 
FBPropertyFlag GetPropertyFlags ()
 GetPropertyFlags. More...
 
bool GetPropertyFlag (FBPropertyFlag pFlag)
 GetPropertyFlag. More...
 
void SetMinMax (double pMin, double pMax, bool pForceMinClamp=false, bool pForceMaxClamp=false)
 SetMinMax. More...
 
void SetMin (double pMin, bool pForceMinClamp=false)
 SetMin. More...
 
void SetMax (double pMax, bool pForceMaxClamp=false)
 SetMax. More...
 
double GetMin ()
 GetMin. More...
 
double GetMax ()
 GetMax. More...
 
void * GetParent ()
 Get the parent of the object. More...
 
int GetSubMemberCount () const
 GetSubMemberCount. More...
 
bool AllowsLocking () const
 AllowsLocking. More...
 
bool HasSomethingLocked () const
 HasSomethingLocked. More...
 
bool IsLocked () const
 IsLocked. More...
 
bool IsMemberLocked (int pIndex) const
 IsMemberLocked. More...
 
void SetLocked (bool pLocked)
 SetLocked. More...
 
void SetMemberLocked (int pIndex, bool pLocked)
 SetMemberLocked. More...
 
FBPropertyGetReferencedProperty ()
 Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method). More...
 
- Public Member Functions inherited from FBWrapperHolder
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Additional Inherited Members

- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component. More...
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection. More...
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection. More...
 
void DisconnectAllSrc ()
 Remove all source connections. More...
 
void DisconnectAllDst ()
 Remove all destination connections. More...
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index. More...
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B. More...
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex. More...
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc. More...
 
int GetSrcCount ()
 Get source connection count. More...
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index. More...
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index. More...
 
int GetDstCount ()
 Get destination connection count. More...
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index. More...
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index. More...
 
bool BeginChange ()
 Begins a change on multiple plugs. More...
 
void EndChange ()
 Ends a change on multiple plugs. More...
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed. More...
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status. More...
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag. More...
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed. More...
 
FBPlugGetOwner ()
 Get the owner of this plug. More...
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index. More...
 
int GetOwnedCount ()
 Get the owned plug count. More...
 
virtual const char * ClassName ()
 internal System vars. More...
 
virtual bool Is (int pTypeId)
 Is( int pTypeId ) More...
 
virtual int GetTypeId ()
 GetTypeId( int pTypeId ) More...
 
virtual bool PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
 PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...
 
virtual bool PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
 PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...
 
virtual bool PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
 PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...
 
virtual void FBDelete ()
 Actual destructor for a FBPlug. More...
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id. More...
 
- Protected Attributes inherited from FBProperty
FBString mName
 
void * mParent
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component. More...
 
HIObject mObject
 Handle on the Plug. More...
 
bool mSDKComponent
 bool Plug is an SDK component.
More...
 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object. More...
 
static int TypeInfo
 TypeInfo. More...
 
static int mGlobalTypeInfo
 Represente the Type Index. More...
 

Detailed Description

Animatable property base class.

Definition at line 1481 of file fbproperties.h.

Constructor & Destructor Documentation

◆ FBPropertyAnimatable()

Constructor.

◆ ~FBPropertyAnimatable()

virtual ~FBPropertyAnimatable ( )
virtual

Destructor.

Member Function Documentation

◆ AllowsMuting()

bool AllowsMuting ( ) const

AllowsMuting.

Returns
true if property can be muted

◆ Destroy()

void Destroy ( )

Destruction function, for internal connectors.

Used in the case of custom properties in order to remove the connectors.

◆ GetAnimationNode()

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.

◆ GetBox()

FBBox* GetBox ( )

Get the owner box.

Returns
Handle to the owning box (i.e. model).

◆ GetColor()

FBColor GetColor ( int  pIndex)

Get the color of a particular FCurve of the property.

Parameters
pIndexIndex of the FCurve to get the color.
Returns
The color of the FCurve at the specified index, a default FBColor object if the index is invalid.

◆ GetData()

virtual void GetData ( void *  pData,
int  pSize,
FBEvaluateInfo pEvalInfo = NULL 
) const
overridevirtual

Get the value of a property.

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

Reimplemented from FBProperty.

Referenced by FBPropertyBaseAnimatable< tType, pPT >::operator tType().

◆ GetDataSize()

int GetDataSize ( ) const

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

Returns
Data size.

◆ GetDataType()

virtual KDataType* GetDataType ( )
overridevirtual

Get the property datatype pointer.

Returns
Datatype of property.

Reimplemented from FBProperty.

◆ GetDataTypeName()

const char* GetDataTypeName ( )

Get the property datatype name.

Returns
Datatype of property as a character string.

◆ HasSomethingMuted()

bool HasSomethingMuted ( ) const

HasSomethingMuted.

Returns
true if property or any of its members is muted

◆ Init()

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.

◆ IsAnimatable()

virtual bool IsAnimatable ( )
inlineoverridevirtual

Certify that the property is animatable.

Returns
true because it is necessarely an animatable property.

Reimplemented from FBProperty.

Definition at line 1554 of file fbproperties.h.

◆ IsAnimated()

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.

◆ IsFocused()

bool IsFocused ( )

Is the property focused (keyable).

Returns
Current focus (keyable) state for the property.

◆ IsFocusedChild()

bool IsFocusedChild ( int  pIndex)

Get the focus (keyable) state of child component.

Parameters
pIndexIndex of the child FCurve component.
Returns
true if the component is in focus, false otherwise

◆ IsMemberMuted()

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

◆ IsMuted()

bool IsMuted ( ) const

IsMuted.

Returns
true if property is muted

◆ Key()

void Key ( )

Key the property.

◆ KeyAt()

void KeyAt ( FBTime  pTime)

Key the property at time (t).

Parameters
pTimeTime at which to insert the key.

◆ KeyRemoveAt()

void KeyRemoveAt ( FBTime  pTime)

Remove the key at time (t).

Parameters
pTimeTime at which to insert the key.

◆ ResetColor()

bool ResetColor ( int  pIndex)

Revert the FCurves to their default color.

Parameters
pIndexIndex of the FCurve to reset the color, use -1 to reset the color for all FCurves of the property.
Returns
true if the color was reverted to its default value, false otherwise

◆ SetAnimated()

void SetAnimated ( bool  pState,
bool  pCheckLocked = false 
)

Set the animation state of the property.

Parameters
pStateState of animation for property, true to animate, false to remove curves.
pCheckLockedDecides whether to check the locked status.

◆ SetCandidate()

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.

◆ SetColor()

bool SetColor ( const FBColor pColor,
int  pIndex 
)

Set the color of the FCurves for the property.

Parameters
pColorColor to set for the FCurve(s).
pIndexIndex of the FCurve to set the new color, use -1 to set the color for all FCurves.
Returns
true if the color was changed, false otherwise

◆ SetData()

virtual void SetData ( void *  pData)
overridevirtual

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

Parameters
pDataValue to affect property with.

Reimplemented from FBProperty.

Referenced by FBPropertyBaseAnimatable< FBVector3d, kFBPT_Vector3D >::operator=().

◆ SetFocus()

void SetFocus ( bool  pState)

Set the property's focus (keyable) state.

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

◆ SetFocusChild()

bool SetFocusChild ( int  pIndex,
bool  pState 
)

Set the focus (keyable) state of child component.

Parameters
pIndexIndex of the child FCurve component.
pStateFocus (keyable) state to set for the property component.
Returns
true if the operation was successful, false otherwise

◆ SetGlobalCandidate()

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.

◆ SetMemberMuted()

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.

◆ SetMuted()

void SetMuted ( bool  pMuted)

SetMuted.

Parameters
pMutedTrue if the property is to be muted, false if it is to be unmuted.

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