FbxProperty Class Reference

#include <fbxproperty.h>

Class Description

Class to hold user properties.

Examples:

Animation/main.cxx, ExportScene03/main.cxx, ExportScene03/MyKFbxMesh.cxx, ExportScene03/MyKFbxMesh.h, ExportShader/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayMaterial.cxx, ImportScene/DisplayMesh.cxx, ImportScene/DisplayTexture.cxx, ImportScene/DisplayTexture.h, ImportScene/DisplayUserProperties.cxx, ProceduralTexture/main.cxx, StereoCamera/main.cxx, UserProperties/main.cxx, and ViewScene/SceneCache.cxx.

Definition at line 37 of file fbxproperty.h.

Inheritance diagram for FbxProperty:

Classes
class	FbxPropertyNameCache
	This is an internal class that you can use to build and clear the name map of properties. You can use the name map to speed up searching for property names. More...

Public Member Functions
bool	CopyValue (const FbxProperty &pProperty)
	Copies the value of a property. More...

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

Constructor and Destructor.
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...
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...

Property Identification.
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...

User data
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...

Property Flags.
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...

Assignment and comparison operators
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...

Value management.
static bool	HasDefaultValue (FbxProperty &pProperty)
	Checks if the specified property's value has changed from its default 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...

Property Limits.
Property limits are provided for convenience if some applications desire to bound the range of possible values for a given type property. FBX will never apply these limits internally, however it will store and retrieve the limits values from files, and will assure that they are persistent in memory while the property exists. Notes: The limit value is truncated to the property data type. These limits are meaningless for the boolean type. It is the responsibility of the calling application to implement the necessary instructions to limit the property of boolean type. The SetMinLimit/SetMaxLimit methods will do nothing if SupportSetLimitsAsDoube() returns false.
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...

Enum and property list
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...

Hierarchical properties
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...

Optimizations
void	BeginCreateOrFindProperty ()
	Internal function for building a property name map. More...
void	EndCreateOrFindProperty ()
	Internal function for clearing the property name map. More...

Animation Curve Management
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...

General Object Connection and Relationship Management
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...

General Property Connection and Relationship Management
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...

Constructor & Destructor Documentation

FbxProperty() [1/3]

FbxProperty

(

)

Static property constructor.

FbxProperty() [2/3]

FbxProperty

(

const FbxProperty &

pProperty

)

Copy constructor for properties.

Parameters

pProperty

The property copied to this one.

FbxProperty() [3/3]

FbxProperty

(

const FbxPropertyHandle &

pPropertyHandle

)

Copy constructor for properties.

Parameters

pPropertyHandle

The property handle copied to this property handle.

~FbxProperty()

~FbxProperty

(

)

Static property destructor.

Member Function Documentation

Create() [1/2]

static FbxProperty Create ( const FbxProperty &  pCompoundProperty, const FbxDataType &  pDataType, const char *  pName, const char *  pLabel = "", bool  pCheckForDup = true, bool *  pWasFound = ((void *) 0)  )

static

Creates a runtime property on the specified property.

Parameters

pCompoundProperty	The parent property of this property.
pDataType	The data type of this property.
pName	The property name.
pLabel	The label of this property.
pCheckForDup	If true, parent property checks if it has a child property already with pName, if false, the new property is created.
pWasFound	If pCheckForDup is true, this flag is set to indicate whether the pCompoundProperty already has a child property with pName.

Examples:

Animation/main.cxx, ExportScene03/MyKFbxMesh.cxx, ExportScene05/main.cxx, ExportShader/main.cxx, ProceduralTexture/main.cxx, and UserProperties/main.cxx.

Create() [2/2]

static FbxProperty Create ( FbxObject *  pObject, const FbxDataType &  pDataType, const char *  pName, const char *  pLabel = "", bool  pCheckForDup = true, bool *  pWasFound = ((void *) 0)  )

static

Creates a runtime property on the specified object.

Parameters

pObject	The object on which the property will be created.
pDataType	The data type of this property.
pName	The property name.
pLabel	The label of this property.
pCheckForDup	If true, pObject checks whether it already has a property with pName, if false, a new property is created.
pWasFound	If pCheckForDup is true, this flag is set to indicate whether the pObject already has a child property with pName.

CreateFrom() [1/2]

static FbxProperty CreateFrom ( const FbxProperty &  pCompoundProperty, FbxProperty &  pFromProperty, bool  pCheckForDup = true  )

static

Creates a dynamic property from another property on the specified property.

Parameters

pCompoundProperty	The parent property of this property.
pFromProperty	The property copied by this property.
pCheckForDup	If true, parent property checks if it already has a child property that has the name of pFromProperty, if false, a new property is created.

Remarks

Only the property name, label, min/max, enums and flags are copied.

CreateFrom() [2/2]

static FbxProperty CreateFrom ( FbxObject *  pObject, FbxProperty &  pFromProperty, bool  pCheckForDup = true  )

static

Creates a dynamic property from another property on the specified object.

Parameters

pObject	The object that contains this property.
pFromProperty	The property copied by this property.
pCheckForDup	If true, pObject checks if it already has a property that has the name of pFromProperty, if false, a new property is created.

Remarks

Only the property name, label, min/max, enums and flags are copied.

Destroy()

void Destroy

(

)

Destroys a dynamic property.

DestroyRecursively()

void DestroyRecursively

(

)

Destroys a dynamic property and its children.

Remarks

Destroy all children of current property, and current property will also be destroyed.

DestroyChildren()

void DestroyChildren

(

)

Destroys children of a dynamic property.

Remarks

Destroy all children of current property, and current property will not be destroyed.

GetPropertyDataType()

FbxDataType GetPropertyDataType

(

)

const

Returns the property data type.

Returns

The property data type.

Examples:

ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, and ImportScene/DisplayMaterial.cxx.

GetName()

FbxString GetName

(

)

const

Returns the internal name of the property.

Returns

Property internal name string.

Examples:

ExportShader/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayMesh.cxx, and ImportScene/DisplayTexture.cxx.

GetNameAsCStr()

const char* GetNameAsCStr

(

)

const

Returns the internal name of the property.

Returns

Property internal name string.

GetHierarchicalName()

FbxString GetHierarchicalName

(

)

const

Returns the hierarchical name of the property.

Returns

Property hierarchical name string.

Examples:

ExportShader/main.cxx.

GetLabel()

FbxString GetLabel

(

bool

pReturnNameIfEmpty = true

)

const

Returns the property label.

Parameters

pReturnNameIfEmpty

If true, lets this method return the internal name if the label is empty.

Returns

The property label if set, or the property internal name if the pReturnNameIfEmpty flag is set to true and the label has not been defined.

Remarks

Some applications may ignore the label field and work uniquely with the internal name. Therefore, it should not be taken for granted that a label exists. Also, remember that the label does not get saved in the FBX file. It only exists while the property object is in memory.

Examples:

ImportScene/DisplayAnimation.cxx, and ImportScene/DisplayGenericInfo.cxx.

SetLabel()

void SetLabel

(

const FbxString &

pLabel

)

Sets a label for the property.

Parameters

pLabel

Label string.

GetFbxObject()

FbxObject* GetFbxObject

(

)

const

Returns the object that contains the property.

Returns

The property object owner (or null if the property is an orphan).

SetUserTag()

void SetUserTag

(

int

pTag

)

Sets the user tag.

Parameters

pTag	The user tag to be set.

GetUserTag()

int GetUserTag

(

)

Gets the user tag.

SetUserDataPtr()

void SetUserDataPtr

(

void *

pUserData

)

Sets the user data pointer.

Parameters

pUserData

The user data pointer.

GetUserDataPtr()

void* GetUserDataPtr

(

)

Gets the user data pointer.

Returns

The user data pointer.

ModifyFlag()

void ModifyFlag	(	FbxPropertyFlags::EFlags	pFlag,
		bool	pValue
	)

Changes the property attribute.

Parameters

pFlag	Property attribute identifier.
pValue	New state of pFlag.

Examples:

Animation/main.cxx, ExportScene03/main.cxx, ExportShader/main.cxx, and UserProperties/main.cxx.

GetFlag()

bool GetFlag

(

FbxPropertyFlags::EFlags

pFlag

)

const

Returns the state of the property attribute.

Parameters

pFlag

Property attribute identifier.

Returns

The state of the property attribute(pFlag).

Examples:

ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, and ImportScene/DisplayUserProperties.cxx.

GetFlags()

FbxPropertyFlags::EFlags GetFlags

(

)

const

Returns the state of all of the property attributes.

Returns

The state of the property attributes(pFlags).

GetFlagInheritType()

FbxPropertyFlags::EInheritType GetFlagInheritType

(

FbxPropertyFlags::EFlags

pFlag

)

const

Returns the inheritance type of the given flag, similar to GetValueInheritType().

Parameters

pFlag

The flag to be queried.

Returns

The inheritance type of the specific flag.

SetFlagInheritType()

bool SetFlagInheritType	(	FbxPropertyFlags::EFlags	pFlag,
		FbxPropertyFlags::EInheritType	pType
	)

Sets the inheritance type for the specific flag, similar to SetValueInheritType().

Parameters

pFlag	The flag to be set.
pType	The inheritance type to be set.

Returns

True on success, false otherwise.

ModifiedFlag()

bool ModifiedFlag

(

FbxPropertyFlags::EFlags

pFlag

)

const

Checks if the property flag has been modified from its default value.

Parameters

pFlag

The flag to be queried.

Returns

True if the value of this property has changed, false otherwise

operator=()

FbxProperty& operator=

(

const FbxProperty &

pProperty

)

Assignment operator.

Parameters

pProperty

The property assigned to this property.

Returns

This property.

operator==() [1/2]

bool operator==

(

const FbxProperty &

pProperty

)

const

Equivalence operator.

Parameters

pProperty

The property compared to this property.

Returns

True if equal, false otherwise.

operator!=() [1/2]

bool operator!=

(

const FbxProperty &

pProperty

)

const

Non-equivalence operator.

Parameters

pProperty

The property compared to this property.

Returns

True if unequal, false otherwise.

operator<()< h2="">

bool operator<

(

const FbxProperty &

pProperty

)

const

Lesser operator, used to sort property in map.

Parameters

pProperty

The property compared to this property.

Returns

true if less, false otherwise.

operator>()

bool operator>

(

const FbxProperty &

pProperty

)

const

Greater operator, used to sort property in map.

Parameters

pProperty

The property compared to this property.

Returns

true if greater, false otherwise.

operator==() [2/2]

bool operator== ( int  pValue ) const

inline

Equivalence operator.

Parameters

pValue

The value compared to this property.

Returns

True if this property is valid and pValue doesn't equal zero, or this property is invalid and pValue equals zero, false otherwise.

Definition at line 260 of file fbxproperty.h.

{ return (pValue == 0) ? !IsValid() : IsValid(); }

operator!=() [2/2]

bool operator!= ( int  pValue ) const

inline

Non-equivalence operator.

Parameters

pValue

The value compared to this property.

Returns

True if this property is valid and pValue equals zero, or this property is invalid and pValue doesn't equal zero, false otherwise.

Definition at line 266 of file fbxproperty.h.

{ return (pValue != 0) ? !IsValid() : IsValid(); }

CompareValue()

bool CompareValue

(

const FbxProperty &

pProperty

)

const

Compares this property's value to another property's value.

Parameters

pProperty

The property whose value is compared with this property's value.

Returns

True if equal, false otherwise.

CopyValue()

bool CopyValue

(

const FbxProperty &

pProperty

)

Copies the value of a property.

Parameters

pProperty

The property from which to derive the value.

Returns

True if value has been copied successfully, false otherwise.

Get()

T Get ( ) const

inline

Gets the value of the property.

Template Parameters

T	The data type of the value.

Returns

The property value.

Examples:

ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayMaterial.cxx, ProceduralTexture/main.cxx, StereoCamera/main.cxx, and ViewScene/SceneCache.cxx.

Definition at line 289 of file fbxproperty.h.

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

Set()

bool Set ( const T &  pValue )

inline

Sets the value of the property.

Parameters

pValue

The new value

Returns

True if type is compatible and the value is set successfully, false otherwise.

Examples:

Animation/main.cxx, Audio/main.cxx, ExportScene03/main.cxx, ExportScene05/main.cxx, ExportShader/main.cxx, ProceduralTexture/main.cxx, and UserProperties/main.cxx.

Definition at line 295 of file fbxproperty.h.

{ return Set(&pValue, FbxTypeOf(pValue)); }

IsValid()

bool IsValid

(

)

const

Judges the property's validity.

Returns

True if this property is valid, false otherwise.

Examples:

ExportScene03/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayMaterial.cxx, ImportScene/DisplayTexture.cxx, ImportScene/DisplayUserProperties.cxx, ProceduralTexture/main.cxx, StereoCamera/main.cxx, and ViewScene/SceneCache.cxx.

HasDefaultValue()

static bool HasDefaultValue ( FbxProperty &  pProperty )

static

Checks if the specified property's value has changed from its default value.

Parameters

pProperty

Property that is tested.

Returns

True if the property value is still the default, false otherwise.

Remarks

If the inheritance type of pProperty's value is eOverride, pProperty's value should have been modified, so pProperty doesn't have the default value. If the inheritance type of pProperty's value is eInherit, that means pProperty's value inherits the referenced object's property value, so pProperty has the default value.

GetValueInheritType()

FbxPropertyFlags::EInheritType GetValueInheritType

(

)

const

Queries the inheritance type of the property.

Use this method to determine if this property's value is overridden from the default value, or from the referenced object, if this object is a clone.

Returns

The inheritance type of the property.

SetValueInheritType()

bool SetValueInheritType

(

FbxPropertyFlags::EInheritType

pType

)

Sets the inheritance type of the property.

Use the method to explicitly override the default value of the property, or the referenced object's property value, if this object is a clone.

You can also use this to explicitly inherit the default value of the property, or the referenced object's property value, if this object is a clone.

Parameters

pType

The new inheritance type.

Returns

True on success, false otherwise.

Modified()

bool Modified

(

)

const

Checks if the property's value has been modified from its default value.

Returns

True if the value of the property has changed, false otherwise.

Remarks

If the inheritance type of the property's value is eOverride, the property's value should have been modified, it returns true. If the inheritance type of the property's value is eInherit, that means the property's value inherits the referenced object's property value, so the property's value is not modified and it returns false.

SupportSetLimitAsDouble()

bool SupportSetLimitAsDouble

(

)

const

Returns whether setting limits as a double number on this property type is allowed.

Returns

True if allowed, false otherwise.

SetMinLimit()

bool SetMinLimit

(

double

pMin

)

Sets a minimum property value limit.

Parameters

pMin	Minimum value allowed.

Returns

True if the limit has been set, false otherwise.

HasMinLimit()

bool HasMinLimit

(

)

const

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

Returns

True when a minimum limit exists, false otherwise.

Examples:

ImportScene/DisplayGenericInfo.cxx.

GetMinLimit()

double GetMinLimit

(

)

const

Returns the minimum property value limit.

Returns

The minimum value limit.

Examples:

ImportScene/DisplayGenericInfo.cxx.

HasMaxLimit()

bool HasMaxLimit

(

)

const

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

Returns

True when a maximum limit exists, false otherwise.

Examples:

ImportScene/DisplayGenericInfo.cxx.

SetMaxLimit()

bool SetMaxLimit

(

double

pMax

)

Sets a maximum property value limit.

Parameters

pMax	Maximum value allowed.

Returns

True if the limit has been set, false otherwise.

GetMaxLimit()

double GetMaxLimit

(

)

const

Returns the maximum property value.

Returns

The maximum value limit.

Examples:

ImportScene/DisplayGenericInfo.cxx.

SetLimits()

bool SetLimits	(	double	pMin,
		double	pMax
	)

Sets the minimum and maximum value limit of the property.

Parameters

pMin	Minimum value allowed.
pMax	Maximum value allowed.

Returns

True if both the min and max limit have been set, false otherwise.

Examples:

UserProperties/main.cxx.

AddEnumValue()

int AddEnumValue

(

const char *

pStringValue

)

Adds a string value at the end of the enumeration list.

Parameters

pStringValue

The string value to be added.

Returns

The index in the list where the string is added or -1 if the action failed.

Remarks

This function is only valid if the property type is eFbxEnum or eFbxEnumM.

If the property is of type eFbxEnum, trying to add a value that is already in the enumeration list will fail. Empty strings are not allowed.

Examples:

UserProperties/main.cxx.

InsertEnumValue()

void InsertEnumValue	(	int	pIndex,
		const char *	pStringValue
	)

Inserts a string value at the specific index.

Parameters

pIndex	Zero bound index.
pStringValue	The string value to be inserted.

Remarks

This function is only valid if the property type is eFbxEnum or eFbxEnumM.

If the property is of type eFbxEnum, trying to insert a value that is already in the enumeration list will fail. pIndex must be in the range [0, ListValueGetCount()]. Empty strings are not allowed.

Examples:

UserProperties/main.cxx.

GetEnumCount()

int GetEnumCount

(

)

const

Returns the number of elements in the enumeration list.

Returns

The number of elements in the enumeration list.

Remarks

This function returns 0 if the property type is not eFbxEnum or eFbxEnumM.

SetEnumValue()

void SetEnumValue	(	int	pIndex,
		const char *	pStringValue
	)

Sets a string value at the specific index.

Parameters

pIndex	Zero bound index.
pStringValue	The string value at the specific index.

Remarks

This function is only valid if the property type is eFbxEnum or eFbxEnumM.

If the property is of type eFbxEnum, trying to set a value that is already in the enumeration list will fail. The function assigns the string value to the specific index. A string value must exist at the specific index in order to be changed. Empty strings are not allowed.

RemoveEnumValue()

void RemoveEnumValue

(

int

pIndex

)

Removes the string value at the specified index.

Parameters

pIndex

Index of the string value to be removed.

Remarks

This function is only valid if the property type is eFbxEnum or eFbxEnuM.

GetEnumValue()

const char* GetEnumValue

(

int

pIndex

)

const

Returns a string value at the specified index.

Parameters

pIndex

Zero bound index.

Remarks

This function is only valid if the property type is eFbxEnum or eFbxEnumM.

Examples:

ImportScene/DisplayAnimation.cxx.

IsRoot()

bool IsRoot ( ) const

inline

Judges if this property is the root property.

Returns

True when this property is a root property, false otherwise.

Definition at line 468 of file fbxproperty.h.

{ return mPropertyHandle.IsRoot(); }

IsChildOf()

bool IsChildOf ( const FbxProperty &  pParent ) const

inline

Judges whether this property is a child of the specified property.

Parameters

pParent

The specified property.

Returns

True when this property is a child of the specified property, false otherwise.

Definition at line 474 of file fbxproperty.h.

{ return mPropertyHandle.IsChildOf(pParent.mPropertyHandle); }

IsDescendentOf()

bool IsDescendentOf ( const FbxProperty &  pAncestor ) const

inline

Judges whether this property is a descendant of the specified property.

Parameters

pAncestor

The specified property.

Returns

True when this property is a descendant of the specified property, false otherwise.

Definition at line 480 of file fbxproperty.h.

{ return mPropertyHandle.IsDescendentOf(pAncestor.mPropertyHandle); }

GetParent()

FbxProperty GetParent ( ) const

inline

Returns the parent property of this property.

Returns

The parent of this property.

Definition at line 485 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.GetParent());  }

GetChild()

FbxProperty GetChild ( ) const

inline

Returns the first child of this property.

Returns

The first child of this property, if there is none, an invalid property is returned.

Definition at line 490 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.GetChild());   }

GetSibling()

FbxProperty GetSibling ( ) const

inline

Returns the sibling of this property.

Returns

The sibling of this property, if there is none, an invalid property is returned.

Definition at line 495 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.GetSibling()); }

GetFirstDescendent()

FbxProperty GetFirstDescendent ( ) const

inline

Returns the first property that is a descendant of this property.

Returns

The first descendant of this property, if there is none, an invalid property is returned.

Definition at line 500 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.GetFirstDescendent());   }

GetNextDescendent()

FbxProperty GetNextDescendent ( const FbxProperty &  pProperty ) const

inline

Returns the property that follows pProperty that is a descendant of this property.

Parameters

pProperty

The last found descendant.

Returns

The property that follows pProperty, if there is none, an invalid property is returned.

Definition at line 506 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.GetNextDescendent(pProperty.mPropertyHandle)); }

Find() [1/2]

FbxProperty Find ( const char *  pName, bool  pCaseSensitive = true  ) const

inline

Searches a property using its name.

Parameters

pName	The name of the property as a NULL terminated string.
pCaseSensitive	Whether the name is case-sensitive.

Returns

A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Examples:

ProceduralTexture/main.cxx.

Definition at line 514 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.Find(pName,pCaseSensitive));  }

Find() [2/2]

FbxProperty Find ( const char *  pName, const FbxDataType &  pDataType, bool  pCaseSensitive = true  ) const

inline

Searches a property using its name and data type.

Parameters

pName	The name of the property as a NULL terminated string.
pDataType	The data type of the property.
pCaseSensitive	Whether the name is case-sensitive.

Returns

A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Definition at line 523 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.Find(pName,pDataType.GetTypeInfoHandle(),pCaseSensitive));  }

FindHierarchical() [1/2]

FbxProperty FindHierarchical ( const char *  pName, bool  pCaseSensitive = true  ) const

inline

Searches a property using its full name.

Parameters

pName	The full name of the property as a NULL terminated string.
pCaseSensitive	whether the name is case-sensitive.

Returns

A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Examples:

ImportScene/DisplayMaterial.cxx.

Definition at line 531 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.Find(pName,sHierarchicalSeparator,pCaseSensitive));  }

FindHierarchical() [2/2]

FbxProperty FindHierarchical ( const char *  pName, const FbxDataType &  pDataType, bool  pCaseSensitive = true  ) const

inline

Searches a property using its full name and data type.

Parameters

pName	The full name of the property as a NULL terminated string.
pDataType	The data type of the property.
pCaseSensitive	whether the name is case-sensitive.

Returns

A valid FbxProperty if the property is found, else an invalid FbxProperty. See FbxProperty::IsValid()

Definition at line 540 of file fbxproperty.h.

{ return FbxProperty(mPropertyHandle.Find(pName,sHierarchicalSeparator,pDataType.GetTypeInfoHandle(),pCaseSensitive));  }

BeginCreateOrFindProperty()

void BeginCreateOrFindProperty ( )

inline

Internal function for building a property name map.

Definition at line 548 of file fbxproperty.h.

{ mPropertyHandle.BeginCreateOrFindProperty(); }

EndCreateOrFindProperty()

void EndCreateOrFindProperty ( )

inline

Internal function for clearing the property name map.

Definition at line 551 of file fbxproperty.h.

{ mPropertyHandle.EndCreateOrFindProperty(); }

GetAnimationEvaluator()

FbxAnimEvaluator* GetAnimationEvaluator

(

)

const

Retrieve the proper animation evaluator to use for this property.

Returns

If the object has no scene, returns the default evaluator, otherwise the object's scene evaluator.

IsAnimated()

bool IsAnimated

(

FbxAnimLayer *

pAnimLayer = ((void *) 0)

)

const

Find out if the property is animated: has a curve node with curves.

Parameters

pAnimLayer

The animation layer to test for curve presence. Set to NULL if you want to use the default animation layer of the default animation stack.

Returns

true if the property is animated.

EvaluateValue() [1/2]

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.

Parameters

pTime	The time used for evaluate. If FBXSDK_TIME_INFINITE is used, this returns the default value, without animation curves evaluation.
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 converted to the template type provided, if possible.

Remarks

If the property type versus the template cannot be converted, the result is unknown.

Examples:

Animation/main.cxx.

EvaluateValue() [2/2]

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

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

Parameters

pTime	The time used for evaluate. If FBXSDK_TIME_INFINITE is used, this returns the default value, without animation curves evaluation.
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.

CreateCurveNode()

FbxAnimCurveNode* CreateCurveNode

(

FbxAnimLayer *

pAnimLayer

)

Creates a FbxAnimCurveNode on the specified layer.

Parameters

pAnimLayer

The animation layer the FbxAnimCurveNode object is attached to.

Returns

Pointer to the created FbxAnimCurveNode.

Remarks

This function check the property FbxPropertyFlags::eAnimatable flag and fails to execute if it is not set.

If created, the FbxAnimCurveNode is automatically connected to the property and the animation layer.

The created FbxAnimCurveNode does not automatically allocate anim curves.

On the successful execution of this function, the property eAnimated flag is set to true.

Examples:

ExportScene03/main.cxx.

GetCurveNode() [1/3]

FbxAnimCurveNode* GetCurveNode

(

bool

pCreate = false

)

Get the property's animation curve node on the default animation stack and base layer.

Parameters

pCreate

If true, create the animation curve node and return it if none were found.

Returns

The animation curve node of this property, if found or created, otherwise NULL.

Remarks

If the property flag FbxPropertyFlags::eAnimatable is not set, creating the curve node will fail.

Examples:

Animation/main.cxx, ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, and UserProperties/main.cxx.

GetCurveNode() [2/3]

FbxAnimCurveNode* GetCurveNode	(	FbxAnimStack *	pAnimStack,
		bool	pCreate = false
	)

Get the property's animation curve node on the specified animation stack, using its base layer.

Parameters

pAnimStack	The animation stack to use to get or create the property's animation curve node. NULL can be passed to automatically specify the default animation stack.
pCreate	If true, create the animation curve node and return it if none were found.

Returns

The animation curve node of this property, if found or created, otherwise NULL.

Remarks

If the property flag FbxPropertyFlags::eAnimatable is not set, creating the curve node will fail.

GetCurveNode() [3/3]

FbxAnimCurveNode* GetCurveNode	(	FbxAnimLayer *	pAnimLayer,
		bool	pCreate = false
	)

Get the property's animation curve node on the specified animation layer.

Parameters

pAnimLayer	The animation layer to use to get or create the property's animation curve node. Cannot be NULL.
pCreate	If true, create the animation curve node and return it if none were found.

Returns

The animation curve node of this property, if found or created, otherwise NULL.

Remarks

If the property flag FbxPropertyFlags::eAnimatable is not set, creating the curve node will fail.

GetCurve() [1/3]

FbxAnimCurve* GetCurve ( FbxAnimLayer *  pAnimLayer, bool  pCreate = false  )

inline

Get the FbxAnimCurve from the specified animation layer.

This function expects to find a FbxAnimCurveNode object with the same name as the property and it attempts to retrieve the FbxAnimCurve from it.

Parameters

pAnimLayer	The searched animation layer.
pCreate	Create a FbxAnimCurve if not found.

Returns

Pointer to the FbxAnimCurve. Returns NULL in case of errors or pCreate is false and the curve is not found.

Remarks

If the FbxAnimCurveNode does not exists but the property has the FbxPropertyFlags::eAnimatable flag set and pCreate is true, then this function will first create the FbxAnimCurveNode object and then the FbxAnimCurve.

If more than one FbxAnimCurveNode matching the name criteria are connected, the first one is returned.

Examples:

Animation/main.cxx, Audio/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, ViewScene/DrawScene.cxx, ViewScene/SceneCache.cxx, and ViewScene/SetCamera.cxx.

Definition at line 636 of file fbxproperty.h.

        {
            return GetCurve(pAnimLayer, GetName(), NULL, pCreate);
        }

GetCurve() [2/3]

FbxAnimCurve* GetCurve ( FbxAnimLayer *  pAnimLayer, const char *  pChannel, bool  pCreate = false  )

inline

Get the FbxAnimCurve from the specified animation layer.

This function expects to find a FbxAnimCurveNode object with the same name as the property and it attempts to retrieve the FbxAnimCurve from it.

Parameters

pAnimLayer	The searched animation layer.
pChannel	Name of the channel we are looking for the animation curve. If NULL use the first defined channel.
pCreate	Create a FbxAnimCurve if not found.

Returns

Pointer to the FbxAnimCurve. Returns NULL in case of errors or pCreate is false and the curve is not found.

Remarks

If the FbxAnimCurveNode does not exists but the property has the FbxPropertyFlags::eAnimatable flag set and pCreate is true, then this function will first create the FbxAnimCurveNode object and then the FbxAnimCurve.

If more than one FbxAnimCurveNode matching the name criteria are connected, the first one is returned.

Definition at line 651 of file fbxproperty.h.

        {
            return GetCurve(pAnimLayer, GetName(), pChannel, pCreate);
        }

GetCurve() [3/3]

FbxAnimCurve* GetCurve	(	FbxAnimLayer *	pAnimLayer,
		const char *	pName,
		const char *	pChannel,
		bool	pCreate
	)

Get the FbxAnimCurve of the specified channel from the specified animation layer.

This function looks for the FbxAnimCurveNode named pName and the channel pChannel. It will retrieves the FbxAnimCurve from it.

Parameters

pAnimLayer	The searched animation layer.
pName	Name of the curve node. It is an error to leave this field empty.
pChannel	Name of the channel we are looking for the animation curve. If NULL use the first defined channel.
pCreate	Create a FbxAnimCurve if not found.

Returns

Pointer to the FbxAnimCurve. Returns NULL in case of errors or pCreate is false and the curve is not found.

Remarks

If the FbxAnimCurveNode does not exists but the property has the FbxPropertyFlags::eAnimatable flag set and pCreate is true, then this function will first create the FbxAnimCurveNode object and then the FbxAnimCurve.

If more than one FbxAnimCurveNode matching the name criteria are connected, the first one is returned.

If pChannel is NULL, this function is the equivalent of GetCurve(FbxAnimLayer*, bool).

ConnectSrcObject()

bool ConnectSrcObject	(	FbxObject *	pObject,
		FbxConnection::EType	pType = FbxConnection::eNone
	)

Connects this property to one source object.

Parameters

pObject	The source object to which this property connects.
pType	The connection type between the property and the object.

Returns

True on success, false otherwise.

Examples:

Animation/main.cxx.

IsConnectedSrcObject()

bool IsConnectedSrcObject

(

const FbxObject *

pObject

)

const

Judges whether this property connects with the source object.

Parameters

pObject

The source object.

Returns

True if this property connects with the source object, false otherwise.

DisconnectSrcObject()

bool DisconnectSrcObject

(

FbxObject *

pObject

)

Disconnects this property from one source object.

Parameters

pObject

The source object from which this property will be disconnected.

Returns

True on success, false otherwise.

DisconnectAllSrcObject() [1/4]

bool DisconnectAllSrcObject

(

)

Disconnects this property from all the source objects.

Returns

True if it disconnects all the source objects successfully, false otherwise.

DisconnectAllSrcObject() [2/4]

bool DisconnectAllSrcObject

(

const FbxCriteria &

pCriteria

)

Disconnects this property from all source objects that satisfy a given criteria.

Parameters

pCriteria

The given criteria.

Returns

True if it disconnects all the source objects successfully, false otherwise.

GetSrcObjectCount() [1/4]

int GetSrcObjectCount

(

)

const

Returns the number of source objects with which this property connects.

Returns

The number of source objects with which this property connects.

Examples:

ImportScene/DisplayMaterial.cxx, ImportScene/DisplayMesh.cxx, ImportScene/DisplayTexture.cxx, and ViewScene/SceneCache.cxx.

GetSrcObjectCount() [2/4]

int GetSrcObjectCount

(

const FbxCriteria &

pCriteria

)

const

Returns the number of source objects that satisfy the given criteria with which this property connects.

Parameters

pCriteria

The given criteria.

Returns

The number of source objects that satisfy the given criteria with which this property connects.

GetSrcObject() [1/4]

FbxObject* GetSrcObject

(

const int

pIndex = 0

)

const

Returns the source object at the specified index with which this property connects.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The source object at the specified index, NULL if not found.

Examples:

ImportScene/DisplayMaterial.cxx, ImportScene/DisplayMesh.cxx, ImportScene/DisplayTexture.cxx, and ViewScene/SceneCache.cxx.

GetSrcObject() [2/4]

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.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The source object that satisfies the given criteria at the specified index, NULL if not found.

FindSrcObject() [1/4]

FbxObject* FindSrcObject	(	const char *	pName,
		const int	pStartIndex = 0
	)		const

Searches the source object with the specified name, starting with the specified index.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

FindSrcObject() [2/4]

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.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

DisconnectAllSrcObject() [3/4]

bool DisconnectAllSrcObject ( )

inline

Disconnects this property from all source objects of the specified class type.

Template Parameters

T	The specified class type.

Returns

True if it disconnects all source objects successfully, false otherwise.

Definition at line 749 of file fbxproperty.h.

{ return DisconnectAllSrcObject(FbxCriteria::ObjectType(T::ClassId)); }

DisconnectAllSrcObject() [4/4]

bool DisconnectAllSrcObject ( const FbxCriteria &  pCriteria )

inline

Disconnects this property from all source objects which are of the specified class type and satisfy the given criteria.

Template Parameters

T	The specified class type.

Parameters

pCriteria

The given criteria.

Returns

True if it disconnects all source objects successfully, false otherwise.

Definition at line 756 of file fbxproperty.h.

{ return DisconnectAllSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

GetSrcObjectCount() [3/4]

int GetSrcObjectCount ( ) const

inline

Returns the number of source objects of a specific class type with which this property connects.

Template Parameters

T	The specified class type.

Returns

The number of source objects of the specified class type with which this property connects.

Definition at line 762 of file fbxproperty.h.

{ return GetSrcObjectCount(FbxCriteria::ObjectType(T::ClassId)); }

GetSrcObjectCount() [4/4]

int GetSrcObjectCount ( const FbxCriteria &  pCriteria ) const

inline

Returns the number of source objects which are of the specified class type and satisfy the given criteria with which this property connects.

Template Parameters

T	The specified class type.

Parameters

pCriteria

The given criteria.

Returns

The number of source objects which are of the specified class type and satisfy the given criteria.

Definition at line 769 of file fbxproperty.h.

{ return GetSrcObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

GetSrcObject() [3/4]

T* GetSrcObject ( const int  pIndex = 0 ) const

inline

Returns the source object of the specified class type at the specified index.

Template Parameters

T	The specified class type.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The source object of a specified class type at the specified index, NULL if not found.

Definition at line 776 of file fbxproperty.h.

{ return (T*)GetSrcObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }

GetSrcObject() [4/4]

T* GetSrcObject ( const FbxCriteria &  pCriteria, const int  pIndex = 0  ) const

inline

Returns the source object which is of the specified class type and satisfies the given criteria at the specified index.

Template Parameters

T	The specified class type.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The source object which is of the specified class type and satisfies the given criteria at the specified index, NULL if not found.

Definition at line 784 of file fbxproperty.h.

{ return (T*)GetSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pIndex); }

FindSrcObject() [3/4]

T* FindSrcObject ( const char *  pName, const int  pStartIndex = 0  ) const

inline

Searches the source object with the specified name which is of the specified class type, starting with the specified index.

Template Parameters

T	The specified class type.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 792 of file fbxproperty.h.

{ return (T*)FindSrcObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }

FindSrcObject() [4/4]

T* FindSrcObject ( const FbxCriteria &  pCriteria, const char *  pName, const int  pStartIndex = 0  ) const

inline

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.

Template Parameters

T	The specified class type.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 801 of file fbxproperty.h.

{ return (T*)FindSrcObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pName, pStartIndex); }

ConnectDstObject()

bool ConnectDstObject	(	FbxObject *	pObject,
		FbxConnection::EType	pType = FbxConnection::eNone
	)

Connects this property to one destination object.

Parameters

pObject	The destination object with which this property connects.
pType	The connection type between this property and the object.

Returns

True on success, false otherwise.

IsConnectedDstObject()

bool IsConnectedDstObject

(

const FbxObject *

pObject

)

const

Judges whether this property connects with the destination object.

Parameters

pObject

The destination object.

Returns

True if this property connects with the destination object, false otherwise.

DisconnectDstObject()

bool DisconnectDstObject

(

FbxObject *

pObject

)

Disconnects this property from the destination object.

Parameters

pObject

The destination object from which this property disconnects from.

Returns

True on success, false otherwise.

DisconnectAllDstObject() [1/4]

bool DisconnectAllDstObject

(

)

Disconnects this property from all the destination objects.

Returns

True if it disconnects all the destination objects successfully, false otherwise.

DisconnectAllDstObject() [2/4]

bool DisconnectAllDstObject

(

const FbxCriteria &

pCriteria

)

Disconnects this property from all the destination objects that satisfy given criteria.

Parameters

pCriteria

The given criteria.

Returns

True if it disconnects all the destination objects successfully, false otherwise.

GetDstObjectCount() [1/4]

int GetDstObjectCount

(

)

const

Returns the number of destination objects with which this property connects.

Returns

The number of destination objects with which this property connects.

GetDstObjectCount() [2/4]

int GetDstObjectCount

(

const FbxCriteria &

pCriteria

)

const

Returns the number of destination objects that satisfy the given criteria with which this property connects.

Parameters

pCriteria

The given criteria.

Returns

The number of destination objects that satisfy given criteria with which this property connects.

GetDstObject() [1/4]

FbxObject* GetDstObject

(

const int

pIndex = 0

)

const

Returns the destination object at the specified index with which this property connects.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The destination object at the specified index, NULL if not found.

GetDstObject() [2/4]

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.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The destination object that satisfies given criteria at the specified index, NULL if not found.

FindDstObject() [1/4]

FbxObject* FindDstObject	(	const char *	pName,
		const int	pStartIndex = 0
	)		const

Searches the destination object with the specified name, starting with the specified index.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The destination object with the name, NULL if not found.

FindDstObject() [2/4]

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.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The destination object with the name, NULL if not found.

DisconnectAllDstObject() [3/4]

bool DisconnectAllDstObject ( )

inline

Disconnects this property from all the destination objects of the specified class type.

Template Parameters

T	The specified class type.

Returns

True if it disconnects all the destination objects successfully, false otherwise.

Definition at line 876 of file fbxproperty.h.

{ return DisconnectAllDstObject(FbxCriteria::ObjectType(T::ClassId)); }

DisconnectAllDstObject() [4/4]

bool DisconnectAllDstObject ( const FbxCriteria &  pCriteria )

inline

Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria.

Template Parameters

T	The specified class type.

Parameters

pCriteria

The given criteria.

Returns

True if it disconnects all the destination objects successfully, false otherwise.

Definition at line 883 of file fbxproperty.h.

{ return DisconnectAllDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

GetDstObjectCount() [3/4]

int GetDstObjectCount ( ) const

inline

Returns the number of destination objects of the specified class type with which this property connects.

Template Parameters

T	The specified class type.

Returns

The number of destination objects of the specified class type with which this property connects.

Definition at line 889 of file fbxproperty.h.

{ return GetDstObjectCount(FbxCriteria::ObjectType(T::ClassId)); }

GetDstObjectCount() [4/4]

int GetDstObjectCount ( const FbxCriteria &  pCriteria ) const

inline

Returns the number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects.

Template Parameters

T	The specified class type.

Parameters

pCriteria

The given criteria.

Returns

The number of destination objects which are of the specified class type and satisfy the given criteria with which this property connects.

Definition at line 896 of file fbxproperty.h.

{ return GetDstObjectCount(FbxCriteria::ObjectType(T::ClassId) && pCriteria); }

GetDstObject() [3/4]

T* GetDstObject ( const int  pIndex = 0 ) const

inline

Returns the destination object of the specified class type at the specified index with which this property connects.

Template Parameters

T	The specified class type.

Parameters

pIndex

The specified index whose default value is 0.

Returns

The destination object of the specified class type at the specified index, NULL if not found.

Definition at line 903 of file fbxproperty.h.

{ return (T*)GetDstObject(FbxCriteria::ObjectType(T::ClassId), pIndex); }

GetDstObject() [4/4]

T* GetDstObject ( const FbxCriteria &  pCriteria, const int  pIndex = 0  ) const

inline

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.

Template Parameters

T	The specified class type.

Parameters

pCriteria	The given criteria.
pIndex	The specified index whose default value is 0.

Returns

The destination object which is of the specified class type and satisfies the given criteria at the specified index, NULL if not found.

Definition at line 911 of file fbxproperty.h.

{ return (T*)GetDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pIndex); }

FindDstObject() [3/4]

T* FindDstObject ( const char *  pName, const int  pStartIndex = 0  ) const

inline

Searches the destination object with the specified name which is of the specified class type, starting with the specified index.

Template Parameters

T	The specified class type.

Parameters

pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 919 of file fbxproperty.h.

{ return (T*)FindDstObject(FbxCriteria::ObjectType(T::ClassId), pName, pStartIndex); }

FindDstObject() [4/4]

T* FindDstObject ( const FbxCriteria &  pCriteria, const char *  pName, const int  pStartIndex = 0  ) const

inline

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.

Template Parameters

T	The specified class type.

Parameters

pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns

The source object with the name, NULL if not found.

Definition at line 928 of file fbxproperty.h.

{ return (T*)FindDstObject(FbxCriteria::ObjectType(T::ClassId) && pCriteria, pName, pStartIndex); }

ConnectSrcProperty()

bool ConnectSrcProperty

(

const FbxProperty &

pProperty

)

Connects this property to a source property.

Parameters

pProperty

The source property with which this property connects.

Returns

True on success, false otherwise.

IsConnectedSrcProperty()

bool IsConnectedSrcProperty

(

const FbxProperty &

pProperty

)

Judges whether this property connects with the specified source property.

Parameters

pProperty

The specified source property.

Returns

True if this property connects with the specified source property, false otherwise.

DisconnectSrcProperty()

bool DisconnectSrcProperty

(

const FbxProperty &

pProperty

)

Disconnects this property from the specified source property.

Parameters

pProperty

The specified source property.

Returns

True on success, false otherwise.

GetSrcPropertyCount()

int GetSrcPropertyCount

(

)

const

Returns the number of source properties with which this property connects.

Returns

The number of source properties with which this property connects.

ConnectDstProperty()

bool ConnectDstProperty

(

const FbxProperty &

pProperty

)

Connects this property to a destination property.

Parameters

pProperty

The destination property with which this property connects.

Returns

True on success, false otherwise.

IsConnectedDstProperty()

bool IsConnectedDstProperty

(

const FbxProperty &

pProperty

)

Judges if this property connects with the specified destination property.

Parameters

pProperty

The specified destination property.

Returns

True if this property connects with the specified destination property, false otherwise.

DisconnectDstProperty()

bool DisconnectDstProperty

(

const FbxProperty &

pProperty

)

Disconnects this property from the specified destination property.

Parameters

pProperty

The specified destination property.

Returns

True on success, false otherwise.

GetDstPropertyCount()

int GetDstPropertyCount

(

)

const

Returns the number of destination properties with which this property connects.

Returns

The number of destination properties with which this property connects.

ClearConnectCache()

void ClearConnectCache

(

)

Clears the connection cache of this property, this cache is used to store the connections that satisfy the given criteria.

GetSrcProperty()

FbxProperty GetSrcProperty

(

const int

pIndex = 0

)

const

Returns the source property at the specified index with which this property connects.

Parameters

pIndex

The specified index.

Returns

The source property at the specified index.

Examples:

StereoCamera/main.cxx.

FindSrcProperty()

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.

Parameters

pName	The specified property name.
pStartIndex	The start index.

Returns

The source property with the specified name.

GetDstProperty()

FbxProperty GetDstProperty

(

const int

pIndex = 0

)

const

Returns the destination property at the specified index with which this property connects.

Parameters

pIndex

The specified index.

Returns

The destination property at the specified index.

FindDstProperty()

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.

Parameters

pName	The specified property name.
pStartIndex	The start index.

Returns

The destination property with the specified name.

Member Data Documentation

sHierarchicalSeparator

const char* sHierarchicalSeparator

static

Hierarchical separator of properties.

Definition at line 1013 of file fbxproperty.h.

---

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

• fbxsdk/core/fbxproperty.h