FBProperty Class Reference

FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty FBProperty

Inheritance diagram for FBProperty:

[legend]

List of all members.

---

Detailed Description

Generic application property.

FBProperty objects cannot be instantiated by the user. Reference to a property can be obtained either via an instance of a FBComponent object, or by calling the method 'Find()' of a FBPropertyManager. The class FBComponent has a FBPropertyManager data member named 'PropertyList'.

When accessing a FBProperty object via its containing object, you can get or set (assuming it is not read-only) its value directly:

      lObject.Visibility = True
   

When accessing a property reference directly, its value is obtained via it's 'Data' member.

      lProp = lObject.PropertyList.Find( 'Visibility' )
      if lProp: lProp.Data = True
   

The methods 'PropertyCreate()' and 'PropertyRemove' of the class FBComponent can be used to modify an object's set of properties.

Public Member Functions
	FBProperty ()
	Constructor.
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.
bool	IsAnimatable ()
	Verify if property is of this type.
bool	IsInternal ()
	Verify if property is of this type.
bool	IsList ()
	Verify if property is of this type.
bool	IsMaxClamp ()
	Indicate if maximum value clamping will be applied on user input value.
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 ()
	Verify if property is of this type.
bool	IsUserProperty ()
	Verify if property is of this type.
	SetMax (float pMax, bool pForceMaxClamp=False)
	SetMax.
	SetMin (float pMin, bool pForceMinClamp=False)
	SetMin.
Public Attributes
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).

---

Constructor & Destructor Documentation

FBProperty

(

)

Constructor.

---

Member Function Documentation

float GetMax

(

)

GetMax.

Returns:

Maximum value for the property.

float GetMin

(

)

GetMin.

Returns:

Minimum value for the property.

str GetName

(

)

Get the property's name.

Returns:

The property's name.

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.

FBFlag GetPropertyFlags

(

)

GetPropertyFlags.

Returns:

Return all flags at once.

FBType GetPropertyType

(

)

Get the property's type.

Returns:

The property's type.

str GetPropertyTypeName

(

)

Get the property's type name.

Returns:

The property's type name.

bool IsAnimatable

(

)

Verify if property is of this type.

Returns:

true if property is of type.

bool IsInternal

(

)

Verify if property is of this type.

Returns:

true if property is of type.

bool IsList

(

)

Verify if property is of this type.

Returns:

true if property is of type.

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.

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.

bool IsObjectList

(

)

Indicate if is an instance of FBPropertyListObject.

Warning:

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

bool IsReadOnly

(

)

Is property read-only?

Returns:

true if property is read-only.

bool IsReferenceProperty

(

)

Verify if property is of this type.

Returns:

true if property is of type.

bool IsUserProperty

(

)

Verify if property is of this type.

Returns:

true if property is of type.

SetMax	(	float	pMax,
		bool	pForceMaxClamp = False
	)

SetMax.

Parameters:

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

SetMin	(	float	pMin,
		bool	pForceMinClamp = False
	)

SetMin.

Parameters:

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

---

Member Data Documentation

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

Reimplemented in FBPropertyAction, FBPropertyBool, FBPropertyColor, FBPropertyColorAndAlpha, FBPropertyComponent, FBPropertyDouble, FBPropertyFloat, FBPropertyInt, FBPropertyString, FBPropertyTime, FBPropertyVector2d, FBPropertyVector3d, FBPropertyVector4d, FBPropertyEnum, FBPropertyAnimatable, FBPropertyAnimatableAction, FBPropertyAnimatableBool, FBPropertyAnimatableColor, FBPropertyAnimatableColorAndAlpha, FBPropertyAnimatableDouble, FBPropertyAnimatableTime, FBPropertyAnimatableEnum, FBPropertyAnimatableInt, FBPropertyAnimatableVector2d, FBPropertyAnimatableVector3d, and FBPropertyAnimatableVector4d.

---