#include <mobu-python-api.h>

Class Description

Property: Base property class.

A property is a holder for function callbacks into the internals of the application. You cannot instantiate FBProperty objects. To reference a property:

Use an instance of an FBComponent object. The methods FBComponent::PropertyCreate and FBComponent::PropertyRemove can be used to modify an object's set of properties. When accessing a FBProperty object via its containing object, you can get or set (assuming it is not read-only) its value directly, for example in Python: myObject.Visibility = True.
FBPropertyManager exists in all FBComponent objects, and contains an array of all the registered properties. Use FBProperty::Find to find a property by name. When accessing a property reference directly, its value is obtained via its 'Data' member.
myProp = myObject.PropertyList.Find( 'Visibility' )

if myProp: myProp.Data = True

To see how to create a custom property in Python, see CustomProperty.py.

See the C++ reference

Inheritance diagram for FBProperty:

Public Member Functions
	__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

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:

 FBProperty()

See the C++ reference

__reduce__ ( )

bool AllowsLocking ( FBProperty arg1 )

AllowsLocking.

Python Docstring:

AllowsLocking( (FBProperty)arg1) -> bool

C++ Signature:

bool AllowsLocking()

Returns: true if property can be locked

See the C++ reference

str AsString	(	FBProperty	arg1,
		FBDataAsStringFlag	arg2
	)

Get the property value as a string.

Python Docstring:

AsString( (FBProperty)arg1 [, (FBDataAsStringFlag)arg2]) -> str

C++ Signature:

const char * AsString(FBDataAsStringFlag pFlag = kFBDataAsStringUI)

Parameters

pFlag Indicates the returned string to be used for UI or storage. It defaults to kFBDataAsStringUI.

Returns: The string version of the property.

See the C++ reference

str EnumList	(	FBProperty	arg1,
		object	arg2
	)

Return the string of an enum value.

Python Docstring:

EnumList( (FBProperty)arg1, (object)arg2) -> str

C++ Signature:

const char * EnumList(int pIndex)

Parameters

pIndex Enum value to get string for.

Returns: String value of enum specified by pIndex.

See the C++ reference

FBStringList GetEnumStringList	(	FBProperty	arg1,
		object	arg2
	)

String list for enum properties.

Python Docstring:

GetEnumStringList( (FBProperty)arg1 [, (object)arg2]) -> FBStringList

C++ Signature:

ORSDK2018::FBStringList * GetEnumStringList(bool pCreateIt = false)

Parameters

pCreateIt Create a new list if necessary.

Returns: the pointer to the string list..

See the C++ reference

float GetMax ( FBProperty arg1 )

GetMax.

Python Docstring:

GetMax( (FBProperty)arg1) -> float

C++ Signature:

double GetMax()

Returns: Maximum value for the property.

See the C++ reference

float GetMin ( FBProperty arg1 )

GetMin.

Python Docstring:

GetMin( (FBProperty)arg1) -> float

C++ Signature:

double GetMin()

Returns: Minimum value for the property.

See the C++ reference

str GetName ( FBProperty arg1 )

Get the property's name.

Python Docstring:

GetName( (FBProperty)arg1) -> str

C++ Signature:

const char * GetName()

Returns: The property's name.

See the C++ reference

bool GetPropertyFlag	(	FBProperty	arg1,
		FBPropertyFlag	arg2
	)

GetPropertyFlag.

Python Docstring:

GetPropertyFlag( (FBProperty)arg1, (FBPropertyFlag)arg2) -> bool

C++ Signature:

bool GetPropertyFlag(FBPropertyFlag pFlag)

Parameters

pFlag Flag to test if it is True or False.

Returns: If the flag is True, the function returns True and vice-versa.

Warning: Flags are not saved into or read from a FBX file.

See the C++ reference

int GetPropertyFlags ( FBProperty arg1 )

GetPropertyFlags.

Python Docstring:

GetPropertyFlags( (FBProperty)arg1) -> int

C++ Signature:

FBPropertyFlag GetPropertyFlags()

Returns: Return all flags at once.

See the C++ reference

FBPropertyType GetPropertyType ( FBProperty arg1 )

Get the property's type.

Python Docstring:

GetPropertyType( (FBProperty)arg1) -> FBPropertyType

C++ Signature:

FBPropertyType GetPropertyType()

Returns: The property's type.

See the C++ reference

str GetPropertyTypeName ( FBProperty arg1 )

Get the property's type name.

Python Docstring:

GetPropertyTypeName( (FBProperty)arg1) -> str

C++ Signature:

const char * GetPropertyTypeName()

Returns: The property's type name.

See the C++ reference

int GetSubMemberCount ( FBProperty arg1 )

GetSubMemberCount.

Python Docstring:

GetSubMemberCount( (FBProperty)arg1) -> int

C++ Signature:

int GetSubMemberCount()

Returns: Number of sub-members.

See the C++ reference

bool HasSomethingLocked ( FBProperty arg1 )

HasSomethingLocked.

Python Docstring:

HasSomethingLocked( (FBProperty)arg1) -> bool

C++ Signature:

bool HasSomethingLocked()

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

See the C++ reference

bool IsAnimatable ( FBProperty arg1 )

Python Docstring:

IsAnimatable( (FBProperty)arg1) -> bool

C++ Signature:

bool IsAnimatable()

See the C++ reference

bool IsInternal ( FBProperty arg1 )

Python Docstring:

IsInternal( (FBProperty)arg1) -> bool

C++ Signature:

bool IsInternal()

See the C++ reference

bool IsList ( FBProperty arg1 )

Verify if property is of this type.

Python Docstring:

IsList( (FBProperty)arg1) -> bool

C++ Signature:

bool IsList()

Returns: true if property is of type.

See the C++ reference

bool IsLocked ( FBProperty arg1 )

IsLocked.

Python Docstring:

IsLocked( (FBProperty)arg1) -> bool

C++ Signature:

bool IsLocked()

Returns: true if property is locked

See the C++ reference

bool IsMaxClamp ( FBProperty arg1 )

Indicate if maximum value clamping will be applied on user input value.

Python Docstring:

IsMaxClamp( (FBProperty)arg1) -> bool

C++ Signature:

bool IsMaxClamp()

Returns: true if property the value will be clamped to a maximum value.

See the C++ reference

bool IsMemberLocked	(	FBProperty	arg1,
		object	arg2
	)

IsMemberLocked.

Python Docstring:

IsMemberLocked( (FBProperty)arg1, (object)arg2) -> bool

C++ Signature:

bool IsMemberLocked(int pIndex)

Parameters

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

Returns: true if property sub-member is locked

See the C++ reference

bool IsMinClamp ( FBProperty arg1 )

Indicate if minimum value clamping will be applied on user input value.

Python Docstring:

IsMinClamp( (FBProperty)arg1) -> bool

C++ Signature:

bool IsMinClamp()

Returns: true if property the value will be clamped to a minimum value.

See the C++ reference

bool IsObjectList ( FBProperty arg1 )

Indicate if is an instance of FBPropertyListObject.

Python Docstring:

IsObjectList( (FBProperty)arg1) -> bool

C++ Signature:

bool IsObjectList()

Warning: A FBPropertyListObject will also return true on a call to 'IsList()'.

See the C++ reference

bool IsReadOnly ( FBProperty arg1 )

Is property read-only?

Python Docstring:

IsReadOnly( (FBProperty)arg1) -> bool

C++ Signature:

bool IsReadOnly()

Returns: true if property is read-only.

See the C++ reference

bool IsReferenceProperty ( FBProperty arg1 )

Python Docstring:

IsReferenceProperty( (FBProperty)arg1) -> bool

C++ Signature:

bool IsReferenceProperty()

See the C++ reference

bool IsTextureConnectableProperty ( FBProperty arg1 )

Python Docstring:

IsTextureConnectableProperty( (FBProperty)arg1) -> bool

C++ Signature:

bool IsTextureConnectableProperty()

See the C++ reference

bool IsUserProperty ( FBProperty arg1 )

Python Docstring:

IsUserProperty( (FBProperty)arg1) -> bool

C++ Signature:

bool IsUserProperty()

See the C++ reference

ModifyPropertyFlag	(	FBProperty	arg1,
		FBPropertyFlag	arg2,
		object	arg3
	)

ModifyPropertyFlag.

Python Docstring:

ModifyPropertyFlag( (FBProperty)arg1, (FBPropertyFlag)arg2, (object)arg3) -> None

C++ Signature:

void ModifyPropertyFlag(FBPropertyFlag pFlag, bool pValue)

Parameters

pFlag	The flag to switch to True or False.
pValue	The value to set about this flag.

Warning: Flags are not saved into or read from a FBX file.

See the C++ reference

NotifyEnumStringListChanged ( FBProperty arg1 )

Notify system that the enum list was modified.

Python Docstring:

NotifyEnumStringListChanged( (FBProperty)arg1) -> None

C++ Signature:

void NotifyEnumStringListChanged()

See the C++ reference

str OriValueAsString ( FBProperty arg1 )

Get the property original value (before any modification) as string.

Python Docstring:

OriValueAsString( (FBProperty)arg1) -> str

C++ Signature:

const char * OriValueAsString()

Returns: returns the original value of the property in string with format same as AsString(kDataAsStringPersistence)

See the C++ reference

SetLocked	(	FBProperty	arg1,
		object	arg2
	)

SetLocked.

Python Docstring:

SetLocked( (FBProperty)arg1, (object)arg2) -> None

C++ Signature:

void SetLocked(bool pLocked)

Parameters

pLocked True if the property is to be locked, false if it is to be unlocked.

See the C++ reference

SetMax	(	FBProperty	arg1,
		object	arg2,
		object	arg3
	)

SetMax.

Python Docstring:

SetMax( (FBProperty)arg1, (object)arg2 [, (object)arg3]) -> None

C++ Signature:

void SetMax(double pMax, bool pForceMaxClamp = false)

Parameters

pMax	Maximum value of the property.
pForceMaxClamp	Force clamping to maximum value of the property.

See the C++ reference

SetMemberLocked	(	FBProperty	arg1,
		object	arg2,
		object	arg3
	)

SetMemberLocked.

Python Docstring:

SetMemberLocked( (FBProperty)arg1, (object)arg2, (object)arg3) -> None

C++ Signature:

void SetMemberLocked(int pIndex, bool pLocked)

Parameters

pIndex	Index of the sub-member of the property to lock or unlock.
pLocked	True if the sub-member is to be locked, false if it is to be unlocked.

See the C++ reference

SetMin	(	FBProperty	arg1,
		object	arg2,
		object	arg3
	)

SetMin.

Python Docstring:

SetMin( (FBProperty)arg1, (object)arg2 [, (object)arg3]) -> None

C++ Signature:

void SetMin(double pMin, bool pForceMinClamp = false)

Parameters

pMin	Minimum value of the property.
pForceMinClamp	Force clamping to minimum value of the property.

See the C++ reference

SetName	(	FBProperty	arg1,
		str	arg2
	)

Set the property's name.

Python Docstring:

SetName( (FBProperty)arg1, (str)arg2) -> None

C++ Signature:

void SetName(const char * pName)

Parameters

pName New name for the property.

See the C++ reference

bool SetString	(	FBProperty	arg1,
		str	arg2
	)

Set the property value from a string.

Python Docstring:

SetString( (FBProperty)arg1, (str)arg2) -> bool

C++ Signature:

bool SetString(const char * pString)

Parameters

pString String to set property value from, with format same as AsString(kFBDataAsStringPersistence)

Returns: True if it was possible.

See the C++ reference

Member Data Documentation

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

Name

Return to the default scope (private)

mName Property unique name.

See the C++ reference

Read Property: (str) The property's name.

FBProperty Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation