FBProperty Class Reference

b>Property: Action Action property to trigger function. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBProperty:

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

Additional Inherited Members
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

b>Property: Action Action property to trigger function.

Constructor & Destructor Documentation

FBProperty()

FBProperty

(

)

Constructor.

Member Function Documentation

AllowsLocking()

bool AllowsLocking

(

)

AllowsLocking.

Returns

true if property can be locked

AsString()

str AsString

(

FBDataAsStringFlag

pFlag = kFBDataAsStringUI

)

Get the property value as a string.

Parameters

pFlag

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

Returns

The string version of the property.

EnumList()

str EnumList

(

int

pIndex

)

Return the string of an enum value.

Parameters

pIndex

Enum value to get string for.

Returns

String value of enum specified by pIndex.

GetEnumStringList()

FBStringList GetEnumStringList

(

bool

pCreateIt = False

)

String list for enum properties.

Parameters

pCreateIt

Create a new list if necessary.

Returns

the pointer to the string list..

GetMax()

float GetMax

(

)

GetMax.

Returns

Maximum value for the property.

GetMin()

float GetMin

(

)

GetMin.

Returns

Minimum value for the property.

GetName()

str GetName

(

)

Get the property's name.

Returns

The property's name.

GetPropertyFlag()

bool GetPropertyFlag

(

FBFlag

pFlag

)

GetPropertyFlag.

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.

GetPropertyFlags()

FBFlag GetPropertyFlags

(

)

GetPropertyFlags.

Returns

Return all flags at once.

GetPropertyType()

FBType GetPropertyType

(

)

Get the property's type.

Returns

The property's type.

GetPropertyTypeName()

str GetPropertyTypeName

(

)

Get the property's type name.

Returns

The property's type name.

GetReferencedProperty()

FBProperty GetReferencedProperty

(

)

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

Returns

The referenced property, or a null pointer if this property is not a reference property.

GetSubMemberCount()

int GetSubMemberCount

(

)

GetSubMemberCount.

Returns

Number of sub-members.

HasSomethingLocked()

bool HasSomethingLocked

(

)

HasSomethingLocked.

Returns

true if property or any of its members is locked

IsAnimatable()

bool IsAnimatable

(

)

IsInternal()

bool IsInternal

(

)

IsList()

bool IsList

(

)

Verify if property is of this type.

Returns

true if property is of type.

IsLocked()

bool IsLocked

(

)

IsLocked.

Returns

true if property is locked

IsMaxClamp()

bool IsMaxClamp

(

)

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

Returns

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

IsMemberLocked()

bool IsMemberLocked

(

int

pIndex

)

IsMemberLocked.

Parameters

pIndex

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

Returns

true if property sub-member is locked

IsMinClamp()

bool IsMinClamp

(

)

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

Returns

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

IsObjectList()

bool IsObjectList

(

)

Indicate if is an instance of FBPropertyListObject.

Warning

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

IsReadOnly()

bool IsReadOnly

(

)

Is property read-only?

Returns

true if property is read-only.

IsReferenceProperty()

bool IsReferenceProperty

(

)

IsTextureConnectableProperty()

bool IsTextureConnectableProperty

(

)

IsUserProperty()

bool IsUserProperty

(

)

ModifyPropertyFlag()

ModifyPropertyFlag	(	FBFlag	pFlag,
		bool	pValue
	)

ModifyPropertyFlag.

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.

NotifyEnumStringListChanged()

NotifyEnumStringListChanged

(

)

Notify system that the enum list was modified.

OriValueAsString()

str OriValueAsString

(

)

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

Returns

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

SetLocked()

SetLocked

(

bool

pLocked

)

SetLocked.

Parameters

pLocked

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

SetMax()

SetMax	(	float	pMax,
		bool	pForceMaxClamp = False
	)

SetMax.

Parameters

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

SetMemberLocked()

SetMemberLocked	(	int	pIndex,
		bool	pLocked
	)

SetMemberLocked.

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.

SetMin()

SetMin	(	float	pMin,
		bool	pForceMinClamp = False
	)

SetMin.

Parameters

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

SetName()

SetName

(

str

pName

)

Set the property's name.

Parameters

pName

New name for the property.

SetString()

bool SetString

(

str

pString

)

Set the property value from a string.

Parameters

pString

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

Returns

True if it was possible.