Enumeration property. More...
#include <pyfbsdk.h>
Public Member Functions | |
str | EnumList (int pIdx) |
![]() | |
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 | |
Enumeration | Data |
Return the string associated with the index. Will return None when no value is associated. | |
![]() | |
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). | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
Enumeration property.
Certain properties have strings associated with the integer values they may possess. FBModel's ShadingMode property is one of those example. The actual underlying value of the property is numerical, but it is represented by a string value in the GUI. User can create this type of property via the GUI by creating a list property. The names added to the list can be obtained via the 'EnumList()' method.
Enumeration Data |
Return the string associated with the index. Will return None when no value is associated.