Animatable property base class. More...

#include <fbproperties.h>

Inheritance diagram for FBPropertyAnimatable:

[legend]

Public Member Functions
	FBPropertyAnimatable ()
	Constructor.

virtual	~FBPropertyAnimatable ()
	Destructor.

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, bool pCheckLocked=false)
	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.

bool	SetColor (const FBColor &pColor, int pIndex)
	Set the color of the FCurves for the property.

FBColor	GetColor (int pIndex)
	Get the color of a particular FCurve of the property.

bool	ResetColor (int pIndex)
	Revert the FCurves to their default color.

bool	IsFocusedChild (int pIndex)
	Get the focus (keyable) state of child component.

bool	SetFocusChild (int pIndex, bool pState)
	Set the focus (keyable) state of child component.

Public Member Functions inherited from FBProperty
	FBProperty ()
	Constructor.

void	SetEnable (bool pValue)
	Set property enable status.

const char *	GetName ()
	Get the property's name.

void	SetName (const char *pName)
	Set the property's name.

virtual FBPropertyType	GetPropertyType ()
	Get the property's type.

const char *	GetPropertyTypeName ()
	Get the property's type name.

virtual KDataType *	GetDataType ()
	Get the property datatype pointer.

virtual void	SetData (void *pData)
	Set the value of the property, passing the type as an argument.

virtual void	GetData (void pData, int pSize, FBEvaluateInfo pEvalInfo=NULL) const
	Get the value of a property.

int	AsInt ()
	Get the property as an integer.

bool	SetInt (int pInt)
	Set the property from an integer.

virtual const char *	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
	Get the property value as a string.

virtual bool	SetString (const char *pString)
	Set the property value from a string.

const char *	OriValueAsString ()
	Get the property original value (before any modification) as string.

bool	IsAnimated () const
	Get the property animated flag status.

bool	OriIsAnimated () const
	Get the property original animated flag status (before any modification)

virtual bool	IsList ()
	Verify if property is of this type.

virtual bool	IsAnimatable ()

bool	IsInternal () const

bool	IsUserProperty ()

bool	IsTextureConnectableProperty ()

bool	IsReferenceProperty ()

bool	IsMinClamp ()
	Indicate if minimum value clamping will be applied on user input value.

bool	IsMaxClamp ()
	Indicate if maximum value clamping will be applied on user input value.

bool	IsTemporaryProperty ()
	Indicate if a property was created on retrieve because it didn't exist.

bool	AcceptTemporaryProperty (const char *pEnumList[]=NULL, fbExternalGetSetHandler pGet=NULL, fbExternalGetSetHandler pSet=NULL)
	Accept a temporary property as a dynamic property.

bool	IsObjectList ()
	Indicate if is an instance of FBPropertyListObject.

virtual bool	IsReadOnly ()
	Is property read-only?

virtual const char *	EnumList (int pIndex)
	Return the string of an enum value.

FBStringList *	GetEnumStringList (bool pCreateIt=false)
	String list for enum properties.

void	NotifyEnumStringListChanged ()
	Notify system that the enum list was modified.

void	ModifyPropertyFlag (FBPropertyFlag pFlag, bool pValue)
	ModifyPropertyFlag.

FBPropertyFlag	GetPropertyFlags ()
	GetPropertyFlags.

bool	GetPropertyFlag (FBPropertyFlag pFlag)
	GetPropertyFlag.

void	SetMinMax (double pMin, double pMax, bool pForceMinClamp=false, bool pForceMaxClamp=false)
	SetMinMax.

void	SetMin (double pMin, bool pForceMinClamp=false)
	SetMin.

void	SetMax (double pMax, bool pForceMaxClamp=false)
	SetMax.

double	GetMin ()
	GetMin.

double	GetMax ()
	GetMax.

void *	GetParent ()
	Get the parent of the object.

int	GetSubMemberCount () const
	GetSubMemberCount.

bool	AllowsLocking () const
	AllowsLocking.

bool	HasSomethingLocked () const
	HasSomethingLocked.

bool	IsLocked () const
	IsLocked.

bool	IsMemberLocked (int pIndex) const
	IsMemberLocked.

void	SetLocked (bool pLocked)
	SetLocked.

void	SetMemberLocked (int pIndex, bool pLocked)
	SetMemberLocked.

FBProperty *	GetReferencedProperty ()
	Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method).

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

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.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

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.

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.

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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBProperty
FBString	mName

void *	mParent

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Animatable property base class.

Definition at line 1481 of file fbproperties.h.

Constructor & Destructor Documentation

◆ FBPropertyAnimatable()

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

pTake to 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

pIndex Index 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

pValue Value to fill with property's current value.

Reimplemented from FBProperty.

Referenced by FBPropertyBaseAnimatable< bool, kFBPT_bool >::operator bool().

◆ 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

pOwner	Owner box object.
pName	Name of property to add.
pType	Type name (string) of property.
pInit	Initialization 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

pIndex Index of the child FCurve component.

Returns: true if the component is in focus, false otherwise

◆ IsMemberMuted()

bool IsMemberMuted ( int pIndex ) const

IsMemberMuted.

Parameters

pIndex Index 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

pTime Time at which to insert the key.

◆ KeyRemoveAt()

void KeyRemoveAt ( FBTime pTime )

Remove the key at time (t).

Parameters

pTime Time at which to insert the key.

◆ ResetColor()

bool ResetColor ( int pIndex )

Revert the FCurves to their default color.

Parameters

pIndex Index 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

pState	State of animation for property, true to animate, false to remove curves.
pCheckLocked	Decides whether to check the locked status.

◆ SetCandidate()

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

Set the candidate.

Parameters

pData	Value of data to candidate.
pSize	The size of the current type of data.
pEvalInfo	Candidate time.

◆ SetColor()

bool SetColor	(	const FBColor &	pColor,
		int	pIndex
	)

Set the color of the FCurves for the property.

Parameters

pColor	Color to set for the FCurve(s).
pIndex	Index 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

pData Value to affect property with.

Reimplemented from FBProperty.

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

◆ SetFocus()

void SetFocus ( bool pState )

Set the property's focus (keyable) state.

Parameters

pState Focus (keyable) state to set for the property.

◆ SetFocusChild()

bool SetFocusChild	(	int	pIndex,
		bool	pState
	)

Set the focus (keyable) state of child component.

Parameters

pIndex	Index of the child FCurve component.
pState	Focus (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

pData	Value of data to candidate.
pSize	The Size of the current type of data.
pEvalInfo	Candidate time.

◆ SetMemberMuted()

void SetMemberMuted	(	int	pIndex,
		bool	pMuted
	)

SetMemberMuted.

Parameters

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.

◆ SetMuted()

void SetMuted ( bool pMuted )

SetMuted.

Parameters

pMuted True 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:

fbproperties.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBPropertyAnimatable()

◆ ~FBPropertyAnimatable()

Member Function Documentation

◆ AllowsMuting()

◆ Destroy()

◆ GetAnimationNode()

◆ GetBox()

◆ GetColor()

◆ GetData()

◆ GetDataSize()

◆ GetDataType()

◆ GetDataTypeName()

◆ HasSomethingMuted()

◆ Init()

◆ IsAnimatable()

◆ IsAnimated()

◆ IsFocused()

◆ IsFocusedChild()

◆ IsMemberMuted()

◆ IsMuted()

◆ Key()

◆ KeyAt()

◆ KeyRemoveAt()

◆ ResetColor()

◆ SetAnimated()

◆ SetCandidate()

◆ SetColor()

◆ SetData()

◆ SetFocus()

◆ SetFocusChild()

◆ SetGlobalCandidate()

◆ SetMemberMuted()

◆ SetMuted()