#include <fbxproperty.h>

Class Description

template<class T>
class FbxPropertyT< T >

This template class is used to contain user properties of specific data types.

Examples:: ImportScene/DisplayCommon.cxx, ImportScene/DisplayMaterial.cxx, Transformations/DisplayCommon.cxx, and ViewScene/SceneCache.cxx.

Definition at line 1070 of file fbxproperty.h.

Inheritance diagram for FbxPropertyT< T >:

Static initialization.
FbxProperty &	StaticInit (FbxObject pObject, const char pName, const T &pValue, bool pForceSet, FbxPropertyFlags::EFlags pFlags=FbxPropertyFlags::eNone)
	Creates a property and initializes it using a specific value and flag. More...

FbxProperty &	StaticInit (FbxObject pObject, const char pName, const FbxDataType &pDataType, const T &pValue, bool pForceSet, FbxPropertyFlags::EFlags pFlags=FbxPropertyFlags::eNone)
	Creates a property and initializes it using a specific value and flag. More...

FbxProperty &	StaticInit (FbxProperty pCompound, const char *pName, const FbxDataType &pDataType, const T &pValue, bool pForceSet=true, FbxPropertyFlags::EFlags pFlags=FbxPropertyFlags::eNone)
	Creates a property and initializes it using a specific value and flag. More...

Value Management
FbxPropertyT &	Set (const T &pValue)
	Assignment function. More...

T	Get () const
	Retrieve function. More...

FbxPropertyT &	operator= (const T &pValue)
	Assignment operator. More...

	operator T () const
	Type cast operator. More...

Animation Evaluation
T	EvaluateValue (const FbxTime &pTime=FbxTime((0x7fffffffffffffffLL)), bool pForceEval=false)
	Evaluate the value of a property if it has animation and return the result. More...

Additional Inherited Members
Public Member Functions inherited from FbxProperty
bool	CopyValue (const FbxProperty &pProperty)
	Copies the value of a property. More...

void	Destroy ()
	Destroys a dynamic property. More...

void	DestroyRecursively ()
	Destroys a dynamic property and its children. More...

void	DestroyChildren ()
	Destroys children of a dynamic property. More...

	FbxProperty ()
	Static property constructor. More...

	FbxProperty (const FbxProperty &pProperty)
	Copy constructor for properties. More...

	FbxProperty (const FbxPropertyHandle &pPropertyHandle)
	Copy constructor for properties. More...

	~FbxProperty ()
	Static property destructor. More...

FbxDataType	GetPropertyDataType () const
	Returns the property data type. More...

FbxString	GetName () const
	Returns the internal name of the property. More...

const char *	GetNameAsCStr () const
	Returns the internal name of the property. More...

FbxString	GetHierarchicalName () const
	Returns the hierarchical name of the property. More...

FbxString	GetLabel (bool pReturnNameIfEmpty=true) const
	Returns the property label. More...

void	SetLabel (const FbxString &pLabel)
	Sets a label for the property. More...

FbxObject *	GetFbxObject () const
	Returns the object that contains the property. More...

void	SetUserTag (int pTag)
	Sets the user tag. More...

int	GetUserTag ()
	Gets the user tag. More...

void	SetUserDataPtr (void *pUserData)
	Sets the user data pointer. More...

void *	GetUserDataPtr ()
	Gets the user data pointer. More...

void	ModifyFlag (FbxPropertyFlags::EFlags pFlag, bool pValue)
	Changes the property attribute. More...

bool	GetFlag (FbxPropertyFlags::EFlags pFlag) const
	Returns the state of the property attribute. More...

FbxPropertyFlags::EFlags	GetFlags () const
	Returns the state of all of the property attributes. More...

FbxPropertyFlags::EInheritType	GetFlagInheritType (FbxPropertyFlags::EFlags pFlag) const
	Returns the inheritance type of the given flag, similar to GetValueInheritType(). More...

bool	SetFlagInheritType (FbxPropertyFlags::EFlags pFlag, FbxPropertyFlags::EInheritType pType)
	Sets the inheritance type for the specific flag, similar to SetValueInheritType(). More...

bool	ModifiedFlag (FbxPropertyFlags::EFlags pFlag) const
	Checks if the property flag has been modified from its default value. More...

FbxProperty &	operator= (const FbxProperty &pProperty)
	Assignment operator. More...

bool	operator== (const FbxProperty &pProperty) const
	Equivalence operator. More...

bool	operator!= (const FbxProperty &pProperty) const
	Non-equivalence operator. More...

bool	operator< (const FbxProperty &pProperty) const
	Lesser operator, used to sort property in map. More...

bool	operator> (const FbxProperty &pProperty) const
	Greater operator, used to sort property in map. More...

bool	operator== (int pValue) const
	Equivalence operator. More...

bool	operator!= (int pValue) const
	Non-equivalence operator. More...

bool	CompareValue (const FbxProperty &pProperty) const
	Compares this property's value to another property's value. More...

template<class T >
T	Get () const
	Gets the value of the property. More...

template<class T >
bool	Set (const T &pValue)
	Sets the value of the property. More...

bool	IsValid () const
	Judges the property's validity. More...

FbxPropertyFlags::EInheritType	GetValueInheritType () const
	Queries the inheritance type of the property. More...

bool	SetValueInheritType (FbxPropertyFlags::EInheritType pType)
	Sets the inheritance type of the property. More...

bool	Modified () const
	Checks if the property's value has been modified from its default value. More...

bool	SupportSetLimitAsDouble () const
	Returns whether setting limits as a double number on this property type is allowed. More...

bool	SetMinLimit (double pMin)
	Sets a minimum property value limit. More...

bool	HasMinLimit () const
	Returns whether a minimum limit exists, if it returns false, calling GetMinLimit() produces undefined behavior. More...

double	GetMinLimit () const
	Returns the minimum property value limit. More...

bool	HasMaxLimit () const
	Returns whether a maximum limit exists, if it returns false, calling GetMaxLimit() produces undefined behavior. More...

bool	SetMaxLimit (double pMax)
	Sets a maximum property value limit. More...

double	GetMaxLimit () const
	Returns the maximum property value. More...

bool	SetLimits (double pMin, double pMax)
	Sets the minimum and maximum value limit of the property. More...

int	AddEnumValue (const char *pStringValue)
	Adds a string value at the end of the enumeration list. More...

void	InsertEnumValue (int pIndex, const char *pStringValue)
	Inserts a string value at the specific index. More...

int	GetEnumCount () const
	Returns the number of elements in the enumeration list. More...

void	SetEnumValue (int pIndex, const char *pStringValue)
	Sets a string value at the specific index. More...

void	RemoveEnumValue (int pIndex)
	Removes the string value at the specified index. More...

const char *	GetEnumValue (int pIndex) const
	Returns a string value at the specified index. More...

bool	IsRoot () const
	Judges if this property is the root property. More...

bool	IsChildOf (const FbxProperty &pParent) const
	Judges whether this property is a child of the specified property. More...

bool	IsDescendentOf (const FbxProperty &pAncestor) const
	Judges whether this property is a descendant of the specified property. More...

FbxProperty	GetParent () const
	Returns the parent property of this property. More...

FbxProperty	GetChild () const
	Returns the first child of this property. More...

FbxProperty	GetSibling () const
	Returns the sibling of this property. More...

FbxProperty	GetFirstDescendent () const
	Returns the first property that is a descendant of this property. More...

FbxProperty	GetNextDescendent (const FbxProperty &pProperty) const
	Returns the property that follows pProperty that is a descendant of this property. More...

FbxProperty	Find (const char *pName, bool pCaseSensitive=true) const
	Searches a property using its name. More...

FbxProperty	Find (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const
	Searches a property using its name and data type. More...

FbxProperty	FindHierarchical (const char *pName, bool pCaseSensitive=true) const
	Searches a property using its full name. More...

FbxProperty	FindHierarchical (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const
	Searches a property using its full name and data type. More...

void	BeginCreateOrFindProperty ()
	Internal function for building a property name map. More...

void	EndCreateOrFindProperty ()
	Internal function for clearing the property name map. More...

FbxAnimEvaluator *	GetAnimationEvaluator () const
	Retrieve the proper animation evaluator to use for this property. More...

bool	IsAnimated (FbxAnimLayer pAnimLayer=((void ) 0)) const
	Find out if the property is animated: has a curve node with curves. More...

template<class T >
T	EvaluateValue (const FbxTime &pTime=FbxTime((0x7fffffffffffffffLL)), bool pForceEval=false)
	Evaluate the value of a property if it has animation and return the result as the template type. More...

FbxPropertyValue &	EvaluateValue (const FbxTime &pTime=FbxTime((0x7fffffffffffffffLL)), bool pForceEval=false)
	Evaluate the value of a property if it has animation and return the result. More...

FbxAnimCurveNode *	CreateCurveNode (FbxAnimLayer *pAnimLayer)
	Creates a FbxAnimCurveNode on the specified layer. More...

FbxAnimCurveNode *	GetCurveNode (bool pCreate=false)
	Get the property's animation curve node on the default animation stack and base layer. More...

FbxAnimCurveNode *	GetCurveNode (FbxAnimStack *pAnimStack, bool pCreate=false)
	Get the property's animation curve node on the specified animation stack, using its base layer. More...

FbxAnimCurveNode *	GetCurveNode (FbxAnimLayer *pAnimLayer, bool pCreate=false)
	Get the property's animation curve node on the specified animation layer. More...

FbxAnimCurve *	GetCurve (FbxAnimLayer *pAnimLayer, bool pCreate=false)
	Get the FbxAnimCurve from the specified animation layer. More...

FbxAnimCurve *	GetCurve (FbxAnimLayer pAnimLayer, const char pChannel, bool pCreate=false)
	Get the FbxAnimCurve from the specified animation layer. More...

FbxAnimCurve *	GetCurve (FbxAnimLayer pAnimLayer, const char pName, const char *pChannel, bool pCreate)
	Get the FbxAnimCurve of the specified channel from the specified animation layer. More...

bool	ConnectSrcObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone)
	Connects this property to one source object. More...

bool	IsConnectedSrcObject (const FbxObject *pObject) const
	Judges whether this property connects with the source object. More...

bool	DisconnectSrcObject (FbxObject *pObject)
	Disconnects this property from one source object. More...

bool	DisconnectAllSrcObject ()
	Disconnects this property from all the source objects. More...

bool	DisconnectAllSrcObject (const FbxCriteria &pCriteria)
	Disconnects this property from all source objects that satisfy a given criteria. More...

int	GetSrcObjectCount () const
	Returns the number of source objects with which this property connects. More...

int	GetSrcObjectCount (const FbxCriteria &pCriteria) const
	Returns the number of source objects that satisfy the given criteria with which this property connects. More...

FbxObject *	GetSrcObject (const int pIndex=0) const
	Returns the source object at the specified index with which this property connects. More...

FbxObject *	GetSrcObject (const FbxCriteria &pCriteria, const int pIndex=0) const
	Returns the source object that satisfies the criteria at the specified index with which this property connects. More...

FbxObject *	FindSrcObject (const char *pName, const int pStartIndex=0) const
	Searches the source object with the specified name, starting with the specified index. More...

FbxObject *	FindSrcObject (const FbxCriteria &pCriteria, const char *pName, const int pStartIndex=0) const
	Searches the source object with the specified name which satisfies the given criteria, starting with the specified index. More...

template<class T >
bool	DisconnectAllSrcObject ()
	Disconnects this property from all source objects of the specified class type. More...

template<class T >
bool	DisconnectAllSrcObject (const FbxCriteria &pCriteria)
	Disconnects this property from all source objects which are of the specified class type and satisfy the given criteria. More...

template<class T >
int	GetSrcObjectCount () const
	Returns the number of source objects of a specific class type with which this property connects. More...

template<class T >
int	GetSrcObjectCount (const FbxCriteria &pCriteria) const
	Returns the number of source objects which are of the specified class type and satisfy the given criteria with which this property connects. More...

template<class T >
T *	GetSrcObject (const int pIndex=0) const
	Returns the source object of the specified class type at the specified index. More...

template<class T >
T *	GetSrcObject (const FbxCriteria &pCriteria, const int pIndex=0) const
	Returns the source object which is of the specified class type and satisfies the given criteria at the specified index. More...

template<class T >
T *	FindSrcObject (const char *pName, const int pStartIndex=0) const
	Searches the source object with the specified name which is of the specified class type, starting with the specified index. More...

template<class T >
T *	FindSrcObject (const FbxCriteria &pCriteria, const char *pName, const int pStartIndex=0) const
	Searches the source object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index. More...

bool	ConnectDstObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone)
	Connects this property to one destination object. More...

bool	IsConnectedDstObject (const FbxObject *pObject) const
	Judges whether this property connects with the destination object. More...

bool	DisconnectDstObject (FbxObject *pObject)
	Disconnects this property from the destination object. More...

bool	DisconnectAllDstObject ()
	Disconnects this property from all the destination objects. More...

bool	DisconnectAllDstObject (const FbxCriteria &pCriteria)
	Disconnects this property from all the destination objects that satisfy given criteria. More...

int	GetDstObjectCount () const
	Returns the number of destination objects with which this property connects. More...

int	GetDstObjectCount (const FbxCriteria &pCriteria) const
	Returns the number of destination objects that satisfy the given criteria with which this property connects. More...

FbxObject *	GetDstObject (const int pIndex=0) const
	Returns the destination object at the specified index with which this property connects. More...

FbxObject *	GetDstObject (const FbxCriteria &pCriteria, const int pIndex=0) const
	Returns the destination object that satisfies given criteria at the specified index with which this property connects. More...

FbxObject *	FindDstObject (const char *pName, const int pStartIndex=0) const
	Searches the destination object with the specified name, starting with the specified index. More...

FbxObject *	FindDstObject (const FbxCriteria &pCriteria, const char *pName, const int pStartIndex=0) const
	Searches the destination object with the specified name which satisfies the given criteria, starting with the specified index. More...

template<class T >
bool	DisconnectAllDstObject ()
	Disconnects this property from all the destination objects of the specified class type. More...

template<class T >
bool	DisconnectAllDstObject (const FbxCriteria &pCriteria)
	Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria. More...

template<class T >
int	GetDstObjectCount () const
	Returns the number of destination objects of the specified class type with which this property connects. More...

template<class T >
int	GetDstObjectCount (const FbxCriteria &pCriteria) const
	Returns the number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects. More...

template<class T >
T *	GetDstObject (const int pIndex=0) const
	Returns the destination object of the specified class type at the specified index with which this property connects. More...

template<class T >
T *	GetDstObject (const FbxCriteria &pCriteria, const int pIndex=0) const
	Returns the destination object which is of the specified class type and satisfies the given criteria at the specified index with which this property connects. More...

template<class T >
T *	FindDstObject (const char *pName, const int pStartIndex=0) const
	Searches the destination object with the specified name which is of the specified class type, starting with the specified index. More...

template<class T >
T *	FindDstObject (const FbxCriteria &pCriteria, const char *pName, const int pStartIndex=0) const
	Searches the destination object with the specified name which is of the specified class type and satisfies the given criteria, starting with the specified index. More...

bool	ConnectSrcProperty (const FbxProperty &pProperty)
	Connects this property to a source property. More...

bool	IsConnectedSrcProperty (const FbxProperty &pProperty)
	Judges whether this property connects with the specified source property. More...

bool	DisconnectSrcProperty (const FbxProperty &pProperty)
	Disconnects this property from the specified source property. More...

int	GetSrcPropertyCount () const
	Returns the number of source properties with which this property connects. More...

bool	ConnectDstProperty (const FbxProperty &pProperty)
	Connects this property to a destination property. More...

bool	IsConnectedDstProperty (const FbxProperty &pProperty)
	Judges if this property connects with the specified destination property. More...

bool	DisconnectDstProperty (const FbxProperty &pProperty)
	Disconnects this property from the specified destination property. More...

int	GetDstPropertyCount () const
	Returns the number of destination properties with which this property connects. More...

void	ClearConnectCache ()
	Clears the connection cache of this property, this cache is used to store the connections that satisfy the given criteria. More...

FbxProperty	GetSrcProperty (const int pIndex=0) const
	Returns the source property at the specified index with which this property connects. More...

FbxProperty	FindSrcProperty (const char *pName, const int pStartIndex=0) const
	Searches the source property with the specified name, starting with the specified index with which this property connects. More...

FbxProperty	GetDstProperty (const int pIndex=0) const
	Returns the destination property at the specified index with which this property connects. More...

FbxProperty	FindDstProperty (const char *pName, const int pStartIndex=0) const
	Searches the destination property with the specified name, starting with the specified index with which this property connects. More...

Static Public Member Functions inherited from FbxProperty
static FbxProperty	Create (const FbxProperty &pCompoundProperty, const FbxDataType &pDataType, const char pName, const char pLabel="", bool pCheckForDup=true, bool pWasFound=((void ) 0))
	Creates a runtime property on the specified property. More...

static FbxProperty	Create (FbxObject pObject, const FbxDataType &pDataType, const char pName, const char pLabel="", bool pCheckForDup=true, bool pWasFound=((void *) 0))
	Creates a runtime property on the specified object. More...

static FbxProperty	CreateFrom (const FbxProperty &pCompoundProperty, FbxProperty &pFromProperty, bool pCheckForDup=true)
	Creates a dynamic property from another property on the specified property. More...

static FbxProperty	CreateFrom (FbxObject *pObject, FbxProperty &pFromProperty, bool pCheckForDup=true)
	Creates a dynamic property from another property on the specified object. More...

static bool	HasDefaultValue (FbxProperty &pProperty)
	Checks if the specified property's value has changed from its default value. More...

Static Public Attributes inherited from FbxProperty
static const char *	sHierarchicalSeparator
	Hierarchical separator of properties. More...

Member Function Documentation

◆ StaticInit() [1/3]

FbxProperty& StaticInit	(	FbxObject *	pObject,
		const char *	pName,
		const T &	pValue,
		bool	pForceSet,
		FbxPropertyFlags::EFlags	pFlags = `FbxPropertyFlags::eNone`
	)

inline

Creates a property and initializes it using a specific value and flag.

Parameters

pObject	The object that contains this property.
pName	The name of the property.
pValue	The value of the property.
pForceSet	If `true`, the value is forcibly set, if `false` the value is not set when it equals the default value.
pFlags	The property flag.

Definition at line 1084 of file fbxproperty.h.

         {
             return StaticInit(pObject, pName, FbxGetDataTypeFromEnum(FbxTypeOf(*((T*)0))), pValue, pForceSet, pFlags);
         }

◆ StaticInit() [2/3]

FbxProperty& StaticInit	(	FbxObject *	pObject,
		const char *	pName,
		const FbxDataType &	pDataType,
		const T &	pValue,
		bool	pForceSet,
		FbxPropertyFlags::EFlags	pFlags = `FbxPropertyFlags::eNone`
	)

inline

Creates a property and initializes it using a specific value and flag.

Parameters

pObject	The object that contains this property.
pName	The name of the property.
pDataType	The property data type.
pValue	The property value.
pForceSet	If `true`, the value is forcibly set, if `false` the value is not set when it equals the default value.
pFlags	The property flag.

Definition at line 1097 of file fbxproperty.h.

         {
             bool lWasFound = false;
             *this = Create(pObject, pDataType, pName, "", true, &lWasFound);
             if( pForceSet || !lWasFound )
             {
                 ModifyFlag(pFlags, true);   // modify the flags before we set the value
                 FbxProperty::Set(&pValue, FbxTypeOf(pValue), false);
             }
             ModifyFlag(FbxPropertyFlags::eStatic, true);
             return *this;
         }

◆ StaticInit() [3/3]

FbxProperty& StaticInit	(	FbxProperty	pCompound,
		const char *	pName,
		const FbxDataType &	pDataType,
		const T &	pValue,
		bool	pForceSet = `true`,
		FbxPropertyFlags::EFlags	pFlags = `FbxPropertyFlags::eNone`
	)

inline

Creates a property and initializes it using a specific value and flag.

Parameters

pCompound	The parent property of this property.
pName	The name of the property.
pDataType	The property data type.
pValue	The property value.
pForceSet	If `true`, the value is forcibly set, if `false` the value is not set when it equals to the default value.
pFlags	The property flag.

Definition at line 1118 of file fbxproperty.h.

         {
             bool lWasFound = false;
             *this = Create(pCompound, pDataType, pName, "", true, &lWasFound);
             if( pForceSet || !lWasFound )
             {
                 ModifyFlag(pFlags, true);   // modify the flags before we set the value
                 FbxProperty::Set(&pValue, FbxTypeOf(pValue), false);
             }
             ModifyFlag(FbxPropertyFlags::eStatic, true);
             return *this;
         }

◆ Set()

FbxPropertyT& Set ( const T & pValue )

inline

Assignment function.

Parameters

pValue The value assigned to this property.

Returns: This property.

Definition at line 1137 of file fbxproperty.h.

1137 { FbxProperty::Set(&pValue, FbxTypeOf(pValue)); return *this; }

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

FbxProperty::Set

bool Set(const T &pValue)

Sets the value of the property.

Definition: fbxproperty.h:295

◆ Get()

T Get ( ) const

inline

Retrieve function.

Returns: The value of the property.

Definition at line 1141 of file fbxproperty.h.

1141 { T lValue; FbxProperty::Get(&lValue, FbxTypeOf(lValue)); return lValue; }

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

FbxProperty::Get

T Get() const

Gets the value of the property.

Definition: fbxproperty.h:289

◆ operator=()

FbxPropertyT& operator= ( const T & pValue )

inline

Assignment operator.

Parameters

pValue The value of type T assigned to this property.

Returns: This property.

Definition at line 1146 of file fbxproperty.h.

1146 { return Set(pValue); }

FbxPropertyT::Set

FbxPropertyT & Set(const T &pValue)

Assignment function.

Definition: fbxproperty.h:1137

◆ operator T()

operator T ( ) const

inline

Type cast operator.

Returns: The value of the property of type T.

Definition at line 1150 of file fbxproperty.h.

1150 { return Get(); }

FbxPropertyT::Get

T Get() const

Retrieve function.

Definition: fbxproperty.h:1141

◆ EvaluateValue()

T EvaluateValue	(	const FbxTime &	pTime = `FbxTime( ( 0x7fffffffffffffffLL) )`,
		bool	pForceEval = `false`
	)

inline

Evaluate the value of a property if it has animation and return the result.

Parameters

pTime	The time used for evaluate.
pForceEval	Force the evaluator to refresh the evaluation state cache even if its already up-to-date.

Returns: The property value at the specified time.

Definition at line 1159 of file fbxproperty.h.

         {
             return GetAnimationEvaluator()-> template GetPropertyValue<T>(*this, pTime, pForceEval);
         }

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

fbxsdk/core/fbxproperty.h

Class Description

template<class T> class FbxPropertyT< T >

Static initialization.

Value Management

Animation Evaluation

Additional Inherited Members

Member Function Documentation

◆ StaticInit() [1/3]

◆ StaticInit() [2/3]

◆ StaticInit() [3/3]

◆ Set()

◆ Get()

◆ operator=()

◆ operator T()

◆ EvaluateValue()

template<class T>
class FbxPropertyT< T >