Property: Base property class. More...

#include <fbproperties.h>

Inheritance diagram for FBProperty:

[legend]

Public Member Functions
	FBProperty ()
	Constructor. More...

void	SetEnable (bool pValue)
	Set property enable status. More...

const char *	GetName ()
	Get the property's name. More...

void	SetName (const char *pName)
	Set the property's name. More...

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

const char *	GetPropertyTypeName ()
	Get the property's type name. More...

virtual KDataType *	GetDataType ()
	Get the property datatype pointer. More...

virtual void	SetData (void *pData)
	Set the value of the property, passing the type as an argument. More...

virtual void	GetData (void pData, int pSize, FBEvaluateInfo pEvalInfo=NULL) const
	Get the value of a property. More...

int	AsInt ()
	Get the property as an integer. More...

bool	SetInt (int pInt)
	Set the property from an integer. More...

virtual const char *	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
	Get the property value as a string. More...

virtual bool	SetString (const char *pString)
	Set the property value from a string. More...

const char *	OriValueAsString ()
	Get the property original value (before any modification) as string. More...

bool	IsAnimated () const
	Get the property animated flag status. More...

bool	OriIsAnimated () const
	Get the property original animated flag status (before any modification) More...

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

virtual bool	IsAnimatable ()

bool	IsInternal () const

bool	IsUserProperty ()

bool	IsTextureConnectableProperty ()

bool	IsReferenceProperty ()

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

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

bool	IsTemporaryProperty ()
	Indicate if a property was created on retrieve because it didn't exist. More...

bool	AcceptTemporaryProperty (const char *pEnumList[]=NULL, fbExternalGetSetHandler pGet=NULL, fbExternalGetSetHandler pSet=NULL)
	Accept a temporary property as a dynamic property. More...

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

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

virtual const char *	EnumList (int pIndex)
	Return the string of an enum value. More...

FBStringList *	GetEnumStringList (bool pCreateIt=false)
	String list for enum properties. More...

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

void	ModifyPropertyFlag (FBPropertyFlag pFlag, bool pValue)
	ModifyPropertyFlag. More...

FBPropertyFlag	GetPropertyFlags ()
	GetPropertyFlags. More...

bool	GetPropertyFlag (FBPropertyFlag pFlag)
	GetPropertyFlag. More...

void	SetMinMax (double pMin, double pMax, bool pForceMinClamp=false, bool pForceMaxClamp=false)
	SetMinMax. More...

void	SetMin (double pMin, bool pForceMinClamp=false)
	SetMin. More...

void	SetMax (double pMax, bool pForceMaxClamp=false)
	SetMax. More...

double	GetMin ()
	GetMin. More...

double	GetMax ()
	GetMax. More...

void *	GetParent ()
	Get the parent of the object. More...

Interface for property locking mechanism.
Locking a property or any number of its channel(s) prevents the user from modifying animation on this property. This means that the user can't add, remove or edit any key on any layer of a locked property/channel. It also means that the user can't change the current value of the property. However, a locked property allows existing animation to flow through. This means that the value of a locked property can change through time as its being driven by existing animation and/or constraints.
int	GetSubMemberCount () const
	GetSubMemberCount. More...

bool	AllowsLocking () const
	AllowsLocking. More...

bool	HasSomethingLocked () const
	HasSomethingLocked. More...

bool	IsLocked () const
	IsLocked. More...

bool	IsMemberLocked (int pIndex) const
	IsMemberLocked. More...

void	SetLocked (bool pLocked)
	SetLocked. More...

void	SetMemberLocked (int pIndex, bool pLocked)
	SetMemberLocked. More...

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

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Protected Attributes
FBString	mName

void *	mParent

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Additional Inherited Members
Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

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

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

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

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

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

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

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

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

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

virtual const char *	ClassName ()
	internal System vars. More...

virtual bool	Is (int pTypeId)
	Is( int pTypeId ) More...

virtual int	GetTypeId ()
	GetTypeId( int pTypeId ) More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

virtual void	FBDelete ()
	Actual destructor for a FBPlug. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

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

Definition at line 194 of file fbproperties.h.

Constructor & Destructor Documentation

◆ FBProperty()

FBProperty ( )

Constructor.

Member Function Documentation

◆ AcceptTemporaryProperty()

bool AcceptTemporaryProperty	(	const char *	pEnumList[] = `NULL`,
		fbExternalGetSetHandler	pGet = `NULL`,
		fbExternalGetSetHandler	pSet = `NULL`
	)

Accept a temporary property as a dynamic property.

Warning: if there is no call to AcceptTemporaryProperty(), is will be converted to a user property after the file is retrieved.

Returns: true if property was temporary and converted to a user property.

◆ AllowsLocking()

bool AllowsLocking ( ) const

AllowsLocking.

Returns: true if property can be locked

◆ AsInt()

int AsInt ( )

Get the property as an integer.

Returns: The integer version of the property.

Referenced by FBPropertyBaseEnum< tType >::AsString().

◆ AsString()

virtual const char* AsString ( FBDataAsStringFlag pFlag = kFBDataAsStringUI )

virtual

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.

Reimplemented in FBPropertyBaseAnimatableEnum< tType >, FBPropertyStringList, FBPropertyBaseEnum< tType >, FBPropertyBaseEnum< EPathEndCapStyle >, FBPropertyBaseEnum< EKeyPropertyBehavior >, FBPropertyBaseEnum< ELengthUnitType >, and FBPropertyBaseEnum< EAreaLightShapes >.

◆ EnumList()

virtual const char* EnumList ( int pIndex )

virtual

Return the string of an enum value.

Parameters

pIndex Enum value to get string for.

Returns: String value of enum specified by pIndex.

Reimplemented in FBPropertyBaseAnimatableEnum< tType >, FBPropertyBaseEnum< tType >, FBPropertyBaseEnum< EPathEndCapStyle >, FBPropertyBaseEnum< EKeyPropertyBehavior >, FBPropertyBaseEnum< ELengthUnitType >, and FBPropertyBaseEnum< EAreaLightShapes >.

Referenced by FBPropertyBaseEnum< tType >::EnumList(), and FBPropertyBaseAnimatableEnum< tType >::EnumList().

◆ GetData()

virtual void GetData	(	void *	pData,
		int	pSize,
		FBEvaluateInfo *	pEvalInfo = `NULL`
	)		const

virtual

Get the value of a property.

Return values

pData Value to fill with property's current value.

Parameters

pSize	Size of pData buffer
pEvalInfo	Used only with animated properties

Referenced by FBPropertyBase< tType, pPT >::GetData().

◆ GetDataType()

virtual KDataType* GetDataType ( )

virtual

Get the property datatype pointer.

Returns: Datatype of property (NULL in the case of the FBProperty is not internal).

Reimplemented in FBPropertyAnimatable.

◆ 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()

double GetMax ( )

GetMax.

Returns: Maximum value for the property.

◆ GetMin()

double GetMin ( )

GetMin.

Returns: Minimum value for the property.

◆ GetName()

const char* GetName ( )

Get the property's name.

Returns: The property's name.

◆ GetParent()

void* GetParent ( )

inline

Get the parent of the object.

Returns: Parent object.

Definition at line 422 of file fbproperties.h.

◆ GetPropertyFlag()

bool GetPropertyFlag ( FBPropertyFlag 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()

FBPropertyFlag GetPropertyFlags ( )

GetPropertyFlags.

Returns: Return all flags at once.

◆ GetPropertyType()

virtual FBPropertyType GetPropertyType ( )

virtual

Get the property's type.

Returns: The property's type.

Reimplemented in FBPropertyBaseAnimatable< tType, pPT >, FBPropertyBaseAnimatable< FBColor, kFBPT_ColorRGB >, FBPropertyBaseAnimatable< int, kFBPT_enum >, FBPropertyBaseAnimatable< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBaseAnimatable< double, kFBPT_double >, FBPropertyBaseAnimatable< bool, kFBPT_bool >, FBPropertyBaseAnimatable< FBVector3d, kFBPT_Vector3D >, FBPropertyStringList, FBPropertyBase< tType, pPT >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBProperty *, kFBPT_Reference >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< float, kFBPT_float >, FBPropertyEvent, and FBPropertyListComponentBase.

◆ GetPropertyTypeName()

const char* 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 ( ) const

GetSubMemberCount.

Returns: Number of sub-members.

◆ HasSomethingLocked()

bool HasSomethingLocked ( ) const

HasSomethingLocked.

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

◆ IsAnimated()

bool IsAnimated ( ) const

Get the property animated flag status.

◆ IsList()

virtual bool IsList ( )

virtual

Verify if property is of this type.

Returns: true if property is of type.

Reimplemented in FBPropertyStringList, and FBPropertyBasicList.

◆ IsLocked()

bool IsLocked ( ) const

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

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

virtual bool IsReadOnly ( )

virtual

Is property read-only?

Returns: true if property is read-only.

Reimplemented in FBPropertyBase< tType, pPT >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBProperty *, kFBPT_Reference >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< kReference, kFBPT_kReference >, and FBPropertyBase< float, kFBPT_float >.

Referenced by FBPropertyBase< tType, pPT >::IsReadOnly().

◆ IsTemporaryProperty()

bool IsTemporaryProperty ( )

Indicate if a property was created on retrieve because it didn't exist.

Warning: if there is no call to AcceptTemporaryProperty(), is will be converted to a user property after the file is retrieved.

Returns: true if property is temporary.

◆ ModifyPropertyFlag()

void ModifyPropertyFlag	(	FBPropertyFlag	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()

void NotifyEnumStringListChanged ( )

Notify system that the enum list was modified.

◆ OriIsAnimated()

bool OriIsAnimated ( ) const

Get the property original animated flag status (before any modification)

◆ OriValueAsString()

const char* 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)

◆ SetData()

virtual void SetData ( void * pData )

virtual

Set the value of the property, passing the type as an argument.

Parameters

pData Value to affect property with.

Referenced by FBPropertyBase< tType, pPT >::SetData().

◆ SetEnable()

void SetEnable ( bool pValue )

Set property enable status.

◆ SetInt()

bool SetInt ( int pInt )

Set the property from an integer.

Parameters

pInt	Int to set property from.

Returns: True if it was possible.

◆ SetLocked()

void SetLocked ( bool pLocked )

SetLocked.

Parameters

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

◆ SetMax()

void SetMax	(	double	pMax,
		bool	pForceMaxClamp = `false`
	)

SetMax.

Parameters

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

◆ SetMemberLocked()

void 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()

void SetMin	(	double	pMin,
		bool	pForceMinClamp = `false`
	)

SetMin.

Parameters

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

◆ SetMinMax()

void SetMinMax	(	double	pMin,
		double	pMax,
		bool	pForceMinClamp = `false`,
		bool	pForceMaxClamp = `false`
	)

SetMinMax.

Parameters

pMin	Minimum value of the property.
pMax	Maximum value of the property.
pForceMinClamp	Force clamping to minimum value of the property.
pForceMaxClamp	Force clamping to maximum value of the property.

◆ SetName()

void SetName ( const char * pName )

Set the property's name.

Parameters

pName New name for the property.

◆ SetString()

virtual bool SetString ( const char * pString )

virtual

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.

Reimplemented in FBPropertyBaseAnimatableEnum< tType >, FBPropertyStringList, FBPropertyBaseEnum< tType >, FBPropertyBaseEnum< EPathEndCapStyle >, FBPropertyBaseEnum< EKeyPropertyBehavior >, FBPropertyBaseEnum< ELengthUnitType >, and FBPropertyBaseEnum< EAreaLightShapes >.

Member Data Documentation

◆ mName

FBString mName

protected

mName Property unique name.

Definition at line 200 of file fbproperties.h.

◆ mParent

void* mParent

protected

mParent Parent of the property.

Definition at line 202 of file fbproperties.h.

The documentation for this class was generated from the following file:

fbproperties.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBProperty()

Member Function Documentation

◆ AcceptTemporaryProperty()

◆ AllowsLocking()

◆ AsInt()

◆ AsString()

◆ EnumList()

◆ GetData()

◆ GetDataType()

◆ GetEnumStringList()

◆ GetMax()

◆ GetMin()

◆ GetName()

◆ GetParent()

◆ GetPropertyFlag()

◆ GetPropertyFlags()

◆ GetPropertyType()

◆ GetPropertyTypeName()

◆ GetReferencedProperty()

◆ GetSubMemberCount()

◆ HasSomethingLocked()

◆ IsAnimated()

◆ IsList()

◆ IsLocked()

◆ IsMaxClamp()

◆ IsMemberLocked()

◆ IsMinClamp()

◆ IsObjectList()

◆ IsReadOnly()

◆ IsTemporaryProperty()

◆ ModifyPropertyFlag()

◆ NotifyEnumStringListChanged()

◆ OriIsAnimated()

◆ OriValueAsString()

◆ SetData()

◆ SetEnable()

◆ SetInt()

◆ SetLocked()

◆ SetMax()

◆ SetMemberLocked()

◆ SetMin()

◆ SetMinMax()

◆ SetName()

◆ SetString()

Member Data Documentation

◆ mName

◆ mParent