#include <mobu-python-api.h>

Class Description

Animatable property base class.

Inheritance diagram for FBPropertyAnimatable:

Public Member Functions
	__reduce__ ()

str	GetDataTypeName (FBPropertyAnimatable arg1)
	Get the property datatype name. More...

object	GetAnimationNode (FBPropertyAnimatable arg1)
	Get the animation node for the property. More...

object	GetBox (FBPropertyAnimatable arg1)
	Get the owner box. More...

bool	IsAnimated (FBPropertyAnimatable arg1)
	Is the property animated. More...

bool	IsFocused (FBPropertyAnimatable arg1)
	Is the property focused (keyable). More...

bool	OriIsAnimated (FBPropertyAnimatable arg1)

	Key (FBPropertyAnimatable arg1)
	Key the property. More...

	KeyAt (FBPropertyAnimatable arg1, FBTime arg2)
	Key the property at time (t). More...

	KeyRemoveAt (FBPropertyAnimatable arg1, FBTime arg2)
	Remove the key at time (t). More...

	SetAnimated (FBPropertyAnimatable arg1, object arg2, object arg3)
	Set the animation state of the property. More...

	SetFocus (FBPropertyAnimatable arg1, object arg2)
	Set the property's focus (keyable) state. More...

bool	AllowsMuting (FBPropertyAnimatable arg1)
	AllowsMuting. More...

bool	HasSomethingMuted (FBPropertyAnimatable arg1)
	HasSomethingMuted. More...

bool	IsMuted (FBPropertyAnimatable arg1)
	IsMuted. More...

bool	IsMemberMuted (FBPropertyAnimatable arg1, object arg2)
	IsMemberMuted. More...

	SetMuted (FBPropertyAnimatable arg1, object arg2)
	SetMuted. More...

	SetMemberMuted (FBPropertyAnimatable arg1, object arg2, object arg3)
	SetMemberMuted. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBProperty
	__reduce__ ()

FBStringList	GetEnumStringList (FBProperty arg1, object arg2)
	String list for enum properties. More...

str	GetName (FBProperty arg1)
	Get the property's name. More...

	SetName (FBProperty arg1, str arg2)
	Set the property's name. More...

FBPropertyType	GetPropertyType (FBProperty arg1)
	Get the property's type. More...

	ModifyPropertyFlag (FBProperty arg1, FBPropertyFlag arg2, object arg3)
	ModifyPropertyFlag. More...

int	GetPropertyFlags (FBProperty arg1)
	GetPropertyFlags. More...

bool	GetPropertyFlag (FBProperty arg1, FBPropertyFlag arg2)
	GetPropertyFlag. More...

str	GetPropertyTypeName (FBProperty arg1)
	Get the property's type name. More...

str	AsString (FBProperty arg1, FBDataAsStringFlag arg2)
	Get the property value as a string. More...

bool	SetString (FBProperty arg1, str arg2)
	Set the property value from a string. More...

str	OriValueAsString (FBProperty arg1)
	Get the property original value (before any modification) as string. More...

bool	IsAnimatable (FBProperty arg1)

bool	IsInternal (FBProperty arg1)

bool	IsList (FBProperty arg1)
	Verify if property is of this type. More...

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

bool	IsReadOnly (FBProperty arg1)
	Is property read-only? More...

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

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

bool	IsTextureConnectableProperty (FBProperty arg1)

bool	IsReferenceProperty (FBProperty arg1)

bool	IsUserProperty (FBProperty arg1)

	SetMin (FBProperty arg1, object arg2, object arg3)
	SetMin. More...

	SetMax (FBProperty arg1, object arg2, object arg3)
	SetMax. More...

float	GetMin (FBProperty arg1)
	GetMin. More...

float	GetMax (FBProperty arg1)
	GetMax. More...

bool	AllowsLocking (FBProperty arg1)
	AllowsLocking. More...

bool	HasSomethingLocked (FBProperty arg1)
	HasSomethingLocked. More...

bool	IsLocked (FBProperty arg1)
	IsLocked. More...

bool	IsMemberLocked (FBProperty arg1, object arg2)
	IsMemberLocked. More...

	SetLocked (FBProperty arg1, object arg2)
	SetLocked. More...

	SetMemberLocked (FBProperty arg1, object arg2, object arg3)
	SetMemberLocked. More...

int	GetSubMemberCount (FBProperty arg1)
	GetSubMemberCount. More...

str	EnumList (FBProperty arg1, object arg2)
	Return the string of an enum value. More...

	NotifyEnumStringListChanged (FBProperty arg1)
	Notify system that the enum list was modified. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
object	Data

Public Attributes inherited from FBProperty
object	Data

ORSDK2018::FBString	Name
	Return to the default scope (private) More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__ ( ... )

Constructor.

Python Docstring:

Raises an exception
This class cannot be instantiated from Python

C++ Signature:

 FBPropertyAnimatable()

See the C++ reference

__reduce__ ( )

bool AllowsMuting ( FBPropertyAnimatable arg1 )

AllowsMuting.

Python Docstring:

AllowsMuting( (FBPropertyAnimatable)arg1) -> bool

C++ Signature:

bool AllowsMuting()

Returns: true if property can be muted

See the C++ reference

GetAnimationNode ( FBPropertyAnimatable arg1 )

Get the animation node for the property.

Python Docstring:

GetAnimationNode( (FBPropertyAnimatable)arg1) -> object

C++ Signature:

ORSDK2018::FBAnimationNode * GetAnimationNode(ORSDK2018::FBTake * pTake = ((void *) 0))

Parameters

pTake to get the animation node from.

Returns: Animation node for property. NULL is returned if property is not animated.

See the C++ reference

Returns: In Python, None is returned if property is not animated.

object GetBox ( FBPropertyAnimatable arg1 )

Get the owner box.

Python Docstring:

GetBox( (FBPropertyAnimatable)arg1) -> object

C++ Signature:

ORSDK2018::FBBox * GetBox()

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

See the C++ reference

str GetDataTypeName ( FBPropertyAnimatable arg1 )

Get the property datatype name.

Python Docstring:

GetDataTypeName( (FBPropertyAnimatable)arg1) -> str

C++ Signature:

const char * GetDataTypeName()

Returns: Datatype of property as a character string.

See the C++ reference

bool HasSomethingMuted ( FBPropertyAnimatable arg1 )

HasSomethingMuted.

Python Docstring:

HasSomethingMuted( (FBPropertyAnimatable)arg1) -> bool

C++ Signature:

bool HasSomethingMuted()

Returns: true if property or any of its members is muted

See the C++ reference

bool IsAnimated ( FBPropertyAnimatable arg1 )

Is the property animated.

Python Docstring:

IsAnimated( (FBPropertyAnimatable)arg1) -> bool

C++ Signature:

bool IsAnimated()

This is true if the property has an FCurve associated to it.

Returns: true if animated, false if not animated.

See the C++ reference

bool IsFocused ( FBPropertyAnimatable arg1 )

Is the property focused (keyable).

Python Docstring:

IsFocused( (FBPropertyAnimatable)arg1) -> bool

C++ Signature:

bool IsFocused()

Returns: Current focus (keyable) state for the property.

See the C++ reference

bool IsMemberMuted	(	FBPropertyAnimatable	arg1,
		object	arg2
	)

IsMemberMuted.

Python Docstring:

IsMemberMuted( (FBPropertyAnimatable)arg1, (object)arg2) -> bool

C++ Signature:

bool IsMemberMuted(int pIndex)

Parameters

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

Returns: true if property sub-member is muted

See the C++ reference

bool IsMuted ( FBPropertyAnimatable arg1 )

IsMuted.

Python Docstring:

IsMuted( (FBPropertyAnimatable)arg1) -> bool

C++ Signature:

bool IsMuted()

Returns: true if property is muted

See the C++ reference

Key ( FBPropertyAnimatable arg1 )

Key the property.

Python Docstring:

Key( (FBPropertyAnimatable)arg1) -> None

C++ Signature:

void Key()

See the C++ reference

KeyAt	(	FBPropertyAnimatable	arg1,
		FBTime	arg2
	)

Key the property at time (t).

Python Docstring:

KeyAt( (FBPropertyAnimatable)arg1, (FBTime)arg2) -> None

C++ Signature:

void KeyAt(ORSDK2018::FBTime pTime)

Parameters

pTime Time at which to insert the key.

See the C++ reference

KeyRemoveAt	(	FBPropertyAnimatable	arg1,
		FBTime	arg2
	)

Remove the key at time (t).

Python Docstring:

KeyRemoveAt( (FBPropertyAnimatable)arg1, (FBTime)arg2) -> None

C++ Signature:

void KeyRemoveAt(ORSDK2018::FBTime pTime)

Parameters

pTime Time at which to insert the key.

See the C++ reference

bool OriIsAnimated ( FBPropertyAnimatable arg1 )

Python Docstring:

OriIsAnimated( (FBPropertyAnimatable)arg1) -> bool

SetAnimated	(	FBPropertyAnimatable	arg1,
		object	arg2,
		object	arg3
	)

Set the animation state of the property.

Python Docstring:

SetAnimated( (FBPropertyAnimatable)arg1, (object)arg2 [, (object)arg3]) -> None

C++ Signature:

void SetAnimated(bool pState, bool pCheckLocked = false)

Parameters

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

See the C++ reference

SetFocus	(	FBPropertyAnimatable	arg1,
		object	arg2
	)

Set the property's focus (keyable) state.

Python Docstring:

SetFocus( (FBPropertyAnimatable)arg1, (object)arg2) -> None

C++ Signature:

void SetFocus(bool pState)

Parameters

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

See the C++ reference

SetMemberMuted	(	FBPropertyAnimatable	arg1,
		object	arg2,
		object	arg3
	)

SetMemberMuted.

Python Docstring:

SetMemberMuted( (FBPropertyAnimatable)arg1, (object)arg2, (object)arg3) -> None

C++ Signature:

void SetMemberMuted(int pIndex, bool pMuted)

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.

See the C++ reference

SetMuted	(	FBPropertyAnimatable	arg1,
		object	arg2
	)

SetMuted.

Python Docstring:

SetMuted( (FBPropertyAnimatable)arg1, (object)arg2) -> None

C++ Signature:

void SetMuted(bool pMuted)

Parameters

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

See the C++ reference

Member Data Documentation

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

FBPropertyAnimatable Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation