FBPropertyAnimatable Class Reference

Animatable property base class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBPropertyAnimatable:

Public Member Functions
FBAnimationNode	GetAnimationNode ()
	Get the animation node for the property.
	FBPropertyAnimatable ()
	Constructor.
bool	AllowsMuting ()
	AllowsMuting.
FBBox	GetBox ()
	Get the owner box.
FBColor	GetColor (int pIndex)
	Get the color of a particular FCurve of the property.
str	GetDataTypeName ()
	Get the property datatype name.
bool	HasSomethingMuted ()
	HasSomethingMuted.
bool	IsAnimated ()
	Is the property animated.
bool	IsFocused ()
	Is the property focused (keyable).
bool	IsFocusedChild (int pIndex)
	Get the focus (keyable) state of child component.
bool	IsMemberMuted (int pIndex)
	IsMemberMuted.
bool	IsMuted ()
	IsMuted.
	Key ()
	Key the property.
	KeyAt (FBTime pTime)
	Key the property at time (t).
	KeyRemoveAt (FBTime pTime)
	Remove the key at time (t).
bool	ResetColor (int pIndex)
	Revert the FCurves to their default color.
	SetAnimated (bool pState, bool pCheckLocked=False)
	Set the animation state of the property.
bool	SetColor (FBColor pColor, int pIndex)
	Set the color of the FCurves for the property.
	SetFocus (bool pState)
	Set the property's focus (keyable) state.
bool	SetFocusChild (int pIndex, bool pState)
	Set the focus (keyable) state of child component.
	SetMemberMuted (int pIndex, bool pMuted)
	SetMemberMuted.
	SetMuted (bool pMuted)
	SetMuted.
Public Member Functions inherited from FBProperty
	FBProperty ()
	Constructor.
bool	AllowsLocking ()
	AllowsLocking.
str	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
	Get the property value as a string.
str	EnumList (int pIndex)
	Return the string of an enum value.
FBStringList	GetEnumStringList (bool pCreateIt=False)
	String list for enum properties.
float	GetMax ()
	GetMax.
float	GetMin ()
	GetMin.
str	GetName ()
	Get the property's name.
bool	GetPropertyFlag (FBFlag pFlag)
	GetPropertyFlag.
FBFlag	GetPropertyFlags ()
	GetPropertyFlags.
FBType	GetPropertyType ()
	Get the property's type.
str	GetPropertyTypeName ()
	Get the property's type name.
FBProperty	GetReferencedProperty ()
	Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method).
int	GetSubMemberCount ()
	GetSubMemberCount.
bool	HasSomethingLocked ()
	HasSomethingLocked.
bool	IsAnimatable ()
bool	IsInternal ()
bool	IsList ()
	Verify if property is of this type.
bool	IsLocked ()
	IsLocked.
bool	IsMaxClamp ()
	Indicate if maximum value clamping will be applied on user input value.
bool	IsMemberLocked (int pIndex)
	IsMemberLocked.
bool	IsMinClamp ()
	Indicate if minimum value clamping will be applied on user input value.
bool	IsObjectList ()
	Indicate if is an instance of FBPropertyListObject.
bool	IsReadOnly ()
	Is property read-only?
bool	IsReferenceProperty ()
bool	IsTextureConnectableProperty ()
bool	IsUserProperty ()
	ModifyPropertyFlag (FBFlag pFlag, bool pValue)
	ModifyPropertyFlag.
	NotifyEnumStringListChanged ()
	Notify system that the enum list was modified.
str	OriValueAsString ()
	Get the property original value (before any modification) as string.
	SetLocked (bool pLocked)
	SetLocked.
	SetMax (float pMax, bool pForceMaxClamp=False)
	SetMax.
	SetMemberLocked (int pIndex, bool pLocked)
	SetMemberLocked.
	SetMin (float pMin, bool pForceMinClamp=False)
	SetMin.
	SetName (str pName)
	Set the property's name.
bool	SetString (str pString)
	Set the property value from a string.

Public Attributes
object	Data
	Read Write Property: The property data value. Type of this depends on the subclass of FBPropertyAnimatable (ex: in a FBPropertyAnimatableInt, Data is of type int).
Public Attributes inherited from FBProperty
str	Name
	Read Property: The property's name.
object	Data
	Read Write Property: The property data value. Type of this depends on the subclass of FBProperty (ex: in a FBPropertyInt, Data is of type int).
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Animatable property base class.

Constructor & Destructor Documentation

FBPropertyAnimatable()

FBPropertyAnimatable

(

)

Constructor.

Member Function Documentation

AllowsMuting()

bool AllowsMuting

(

)

AllowsMuting.

Returns

true if property can be muted

GetAnimationNode()

FBAnimationNode GetAnimationNode

(

)

Get the animation node for the property.

Returns

Animation node for property. None 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.

GetDataTypeName()

str GetDataTypeName

(

)

Get the property datatype name.

Returns

Datatype of property as a character string.

HasSomethingMuted()

bool HasSomethingMuted

(

)

HasSomethingMuted.

Returns

true if property or any of its members is muted

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

)

IsMemberMuted.

Parameters

pIndex

Index of the sub-member of the property to check.

Returns

true if property sub-member is muted

IsMuted()

bool IsMuted

(

)

IsMuted.

Returns

true if property is muted

Key()

Key

(

)

Key the property.

KeyAt()

KeyAt

(

FBTime

pTime

)

Key the property at time (t).

Parameters

pTime

Time at which to insert the key.

KeyRemoveAt()

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()

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.

SetColor()

bool SetColor	(	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

SetFocus()

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

SetMemberMuted()

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()

SetMuted

(

bool

pMuted

)

SetMuted.

Parameters

pMuted

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

Member Data Documentation

Data

object Data

Read Write Property: The property data value. Type of this depends on the subclass of FBPropertyAnimatable (ex: in a FBPropertyAnimatableInt, Data is of type int).