KFbxProperty Class Reference

This reference page is linked to from the following overview topics: FBX SDK 2011, I/O Settings, FBX SDK Object Model, Managing Memory with the FBX SDK Manager, FBX Objects, FBX Properties, Connections, Customizing the FBX SDK, Merging Two Scenes, Animation classes and their interrelationships, List of Python FBX classes.

---

Search for all occurrences

---

Detailed Description

Class to hold user properties.

Examples:

Animation/main.cxx, ExportScene03/main.cxx, ExportScene03/MyKFbxMesh.cxx, ExportScene03/MyKFbxMesh.h, 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/Texture.cxx.

Definition at line 65 of file kfbxproperty.h.

#include <kfbxproperty.h>

Inherits FbxPropertyFlags.

Inherited by KFbxTypedProperty< T >, KFbxTypedProperty< bool >, KFbxTypedProperty< double >, KFbxTypedProperty< EAccessMode >, KFbxTypedProperty< EBlendMode >, KFbxTypedProperty< ECameraAntialiasingMethod >, KFbxTypedProperty< ECameraApertureFormat >, KFbxTypedProperty< ECameraApertureMode >, KFbxTypedProperty< ECameraAspectRatioMode >, KFbxTypedProperty< ECameraFilmRollOrder >, KFbxTypedProperty< ECameraFocusDistanceSource >, KFbxTypedProperty< ECameraFormat >, KFbxTypedProperty< ECameraFrontBackPlaneDisplayMode >, KFbxTypedProperty< ECameraFrontBackPlaneDistanceMode >, KFbxTypedProperty< ECameraGateFit >, KFbxTypedProperty< ECameraProjectionType >, KFbxTypedProperty< ECameraSafeAreaStyle >, KFbxTypedProperty< ECameraSamplingType >, KFbxTypedProperty< ECameraStereo >, KFbxTypedProperty< ECategory >, KFbxTypedProperty< EDecayType >, KFbxTypedProperty< EInterlaceMode >, KFbxTypedProperty< ELightType >, KFbxTypedProperty< ELook >, KFbxTypedProperty< EQuaternionInterpolation >, KFbxTypedProperty< ERotationOrder >, KFbxTypedProperty< ETextureUse6 >, KFbxTypedProperty< ETransformInheritType >, KFbxTypedProperty< EUnifiedMappingType >, KFbxTypedProperty< EWrapMode >, KFbxTypedProperty< fbxBlob >, KFbxTypedProperty< fbxBool1 >, KFbxTypedProperty< fbxDateTime >, KFbxTypedProperty< fbxDouble1 >, KFbxTypedProperty< fbxDouble3 >, KFbxTypedProperty< fbxEnum >, KFbxTypedProperty< fbxInteger1 >, KFbxTypedProperty< fbxReference * >, KFbxTypedProperty< fbxReference >, KFbxTypedProperty< fbxString >, KFbxTypedProperty< fbxTime >, KFbxTypedProperty< fbxULongLong1 >, KFbxTypedProperty< int >, KFbxTypedProperty< kCharacterAutoUser >, KFbxTypedProperty< kCharacterContactBehaviour >, KFbxTypedProperty< kCharacterFingerContactMode >, KFbxTypedProperty< kCharacterFloorPivot >, KFbxTypedProperty< kCharacterFootContactType >, KFbxTypedProperty< kCharacterHandContactType >, KFbxTypedProperty< kCharacterHipsTranslationMode >, KFbxTypedProperty< kCharacterOffAutoUser >, KFbxTypedProperty< kCharacterPosture >, KFbxTypedProperty< kCharacterRollExtractionMode >, KFbxTypedProperty< KFbxControlSet::EType >, and KFbxTypedProperty< KString >.

List of all members.

Classes
struct	KFbxPropertyNameCache
	This is an internal structure 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 (KFbxProperty const &pProp)
	Copies the value of a property.
Static Public Attributes
static const char *	sHierarchicalSeparator
	Hierarchical separator of properties.
Protected Member Functions
	KFbxProperty (KFbxObject *pObject, char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="")
	Constructor / Destructor.
	KFbxProperty (KFbxProperty const &pParent, char const *pName, KFbxDataType const &pDataType, char const *pLabel)
Friends
class	KFbxObject
void	KMarkObject (KFbxObject *pObject, KMap< KFbxObject *, int > &pObjectDstDisconnectCount, KSet2< KFbxObject * > &pObjectsToDeleted, KArrayTemplate< KFbxObject * > &pObjectToDeletedInSequence)
void	KCleanUpConnectionsAtDestructionBoundary (KFbxScene *pObject, KArrayTemplate< KFbxObject * > &pObjectToDeletedInSequence)
Constructor and Destructor.
typedef FbxPropertyFlags::eFbxPropertyFlags	EFlags
enum	eFbxPropertyFlags
	Flags of FBX property. More...
static KFbxProperty	Create (KFbxProperty const &pCompoundProperty, KFbxDataType const &pDataType, char const *pName, char const *pLabel="", bool pCheckForDup=true, bool *pWasFound=NULL)
	Creates a runtime property on the specified property.
static KFbxProperty	Create (KFbxObject *pObject, KFbxDataType const &pDataType, char const *pName, char const *pLabel="", bool pCheckForDup=true, bool *pWasFound=NULL)
	Creates a runtime property on the specified object.
static KFbxProperty	CreateFrom (KFbxProperty const &pCompoundProperty, KFbxProperty &pFromProperty, bool pCheckForDup=true)
	Creates a dynamic property from another property on the specified property.
static KFbxProperty	CreateFrom (KFbxObject *pObject, KFbxProperty &pFromProperty, bool pCheckForDup=true)
	Creates a dynamic property from another property on the specified object.
void	Destroy ()
	Destroys a dynamic property.
void	DestroyRecursively ()
	Destroys a dynamic property and its children.
void	DestroyChildren ()
	Destroys children of a dynamic property.
	KFbxProperty ()
	Static property constructor.
	KFbxProperty (KFbxProperty const &pProperty)
	Copy constructor for properties.
	KFbxProperty (KFbxPropertyHandle const &pPropertyHandle)
	Copy constructor for properties.
	~KFbxProperty ()
	Static property destructor.
Property Identification.
KFbxDataType	GetPropertyDataType () const
	Returns the property data type.
KString	GetName () const
	Returns the internal name of the property.
KString	GetHierarchicalName () const
	Returns the hierarchical name of the property.
KString	GetLabel (bool pReturnNameIfEmpty=true) const
	Returns the property label.
void	SetLabel (const KString &pLabel)
	Sets a label for the property.
KFbxObject *	GetFbxObject () const
	Returns the object that contains the property.
User data
void	SetUserTag (int pTag)
	Sets the user tag.
int	GetUserTag ()
	Gets the user tag.
void	SetUserDataPtr (void *pUserData)
	Sets the user data pointer.
void *	GetUserDataPtr ()
	Gets the user data pointer.
Property Flags.
void	ModifyFlag (eFbxPropertyFlags pFlag, bool pValue)
	Changes the property attribute.
bool	GetFlag (eFbxPropertyFlags pFlag) const
	Returns the state of the property attribute.
KFbxInheritType	GetFlagInheritType (eFbxPropertyFlags pFlag) const
	Returns the inheritance type of the given flag, similar to GetValueInheritType().
bool	SetFlagInheritType (eFbxPropertyFlags pFlag, KFbxInheritType pType)
	Sets the inheritance type for the specific flag, similar to SetValueInheritType().
bool	ModifiedFlag (eFbxPropertyFlags pFlag) const
	Checks if the property flag has been modified from its default value.
Assignment and comparison operators
KFbxProperty &	operator= (KFbxProperty const &pKProperty)
	Assignment operator.
bool	operator== (KFbxProperty const &pKProperty) const
	Equivalence operator.
bool	operator!= (KFbxProperty const &pKProperty) const
	Non-equivalence operator.
bool	operator== (int pValue) const
	Equivalence operator.
bool	operator!= (int pValue) const
	Non-equivalence operator.
bool	CompareValue (KFbxProperty const &pProp) const
	Compares this property's value to another property's value.
Value management.
static bool	HasDefaultValue (KFbxProperty &pProperty)
	Checks if the specified property's value has changed from its default value.
bool	IsValid () const
	Judges the property's validity.
bool	Set (void const *pValue, EFbxType pValueType, bool pCheckForValueEquality)
	Sets the value of this property.
bool	Set (void const *pValue, EFbxType pValueType)
	Sets the value of this function.
bool	Get (void *pValue, EFbxType pValueType) const
	Returns the value of the property.
template<class T >
bool	Set (T const &pValue)
	Sets the value of the property.
template<class T >
T	Get (T const *pFBX_TYPE) const
	Gets the value of the property.
KFbxInheritType	GetValueInheritType () const
	Queries the inheritance type of the property.
bool	SetValueInheritType (KFbxInheritType pType)
	Sets the inheritance type of the property.
bool	Modified () const
	Checks if the property's value has been modified from its default value.
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.Note: 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.
void	SetMinLimit (double pMin)
	Sets a minimum property value limit.
bool	HasMinLimit () const
	Returns whether a minimum limit exists, if it returns false, calling GetMinLimit() produces undefined behavior.
double	GetMinLimit () const
	Returns the minimum property value limit.
bool	HasMaxLimit () const
	Returns whether a maximum limit exists, if it returns false, calling GetMaxLimit() produces undefined behavior.
void	SetMaxLimit (double pMax)
	Sets a maximum property value limit.
double	GetMaxLimit () const
	Returns the maximum property value.
void	SetLimits (double pMin, double pMax)
	Sets the minimum and maximum value limit of the property.
Enum and property list
int	AddEnumValue (char const *pStringValue)
	Adds a string value at the end of the enumeration list.
void	InsertEnumValue (int pIndex, char const *pStringValue)
	Inserts a string value at the specific index.
int	GetEnumCount () const
	Returns the number of elements in the enumeration list.
void	SetEnumValue (int pIndex, char const *pStringValue)
	Sets a string value at the specific index.
void	RemoveEnumValue (int pIndex)
	Removes the string value at the specified index.
const char *	GetEnumValue (int pIndex) const
	Returns a string value at the specified index.
Hierarchical properties
bool	IsRoot () const
	Judges if this property is the root property.
bool	IsChildOf (KFbxProperty const &pParent) const
	Judges whether this property is a child of the specified property.
bool	IsDescendentOf (KFbxProperty const &pAncestor) const
	Judges whether this property is a descendant of the specified property.
KFbxProperty	GetParent () const
	Returns the parent property of this property.
bool	SetParent (const KFbxProperty &pOther)
	Sets the parent for this property (this function has not been implemented, so it always return false).
KFbxProperty	GetChild () const
	Returns the first child of this property.
KFbxProperty	GetSibling () const
	Returns the sibling of this property.
KFbxProperty	GetFirstDescendent () const
	Returns the first property that is a descendant of this property.
KFbxProperty	GetNextDescendent (KFbxProperty const &pProperty) const
	Returns the property that follows pProperty that is a descendant of this property.
KFbxProperty	Find (char const *pName, bool pCaseSensitive=true) const
	Searches a property using its name.
KFbxProperty	Find (char const *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const
	Searches a property using its name and data type.
KFbxProperty	FindHierarchical (char const *pName, bool pCaseSensitive=true) const
	Searches a property using its full name.
KFbxProperty	FindHierarchical (char const *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const
	Searches a property using its full name and data type.
Optimizations
void	BeginCreateOrFindProperty ()
	Internal function for building a property name map.
void	EndCreateOrFindProperty ()
	Internal function for clearing the property name map.
Array Management
bool	SetArraySize (int pSize, bool pVariableArray)
	Sets the array size(not implemented).
int	GetArraySize () const
	Returns the array size(not implemented).
KFbxProperty	GetArrayItem (int pIndex) const
	Returns the (pIndex)th array item.
KFbxProperty	operator[] (int pIndex) const
	Returns the (pIndex)th array item.
Curve Management
KFbxAnimCurveNode *	CreateCurveNode (KFbxAnimLayer *pAnimLayer)
	Creates a KFbxAnimCurveNode on the specified layer.
KFbxAnimCurveNode *	GetCurveNode (KFbxAnimLayer *pAnimLayer, bool pCreateAsNeeded=false)
	Get the KFbxAnimCurveNode of the property that is connected to the specified animation layer.
KFbxAnimCurveNode *	GetCurveNode (bool pCreateAsNeeded=false, const char *pAnimStackName=NULL)
	Use the animation stack name to look for the AnimStack and retrieves the first layer from the stack.
template<class T >
T *	GetCurve (KFbxAnimLayer *pAnimLayer, bool pCreateAsNeeded=false)
	Get the KFbxAnimCurve from the specified animation layer.
template<class T >
T *	GetCurve (KFbxAnimLayer *pAnimLayer, const char *pChannel, bool pCreateAsNeeded=false)
	Get the KFbxAnimCurve from the specified animation layer.
template<class T >
T *	GetCurve (KFbxAnimLayer *pAnimLayer, const char *pName, const char *pChannel, bool pCreateAsNeeded=false)
	Get the KFbxAnimCurve of the specified channel from the specified animation layer.
General Object Connection and Relationship Management
bool	ConnectSrcObject (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone)
	Connects this property to one source object.
bool	IsConnectedSrcObject (const KFbxObject *pObject) const
	Judges whether this property connects with the source object.
bool	DisconnectSrcObject (KFbxObject *pObject)
	Disconnects this property from one source object.
bool	DisconnectAllSrcObject ()
	Disconnects this property from all the source objects.
bool	DisconnectAllSrcObject (KFbxCriteria const &pCriteria)
	Disconnects this property from all source objects that satisfy a given criteria.
bool	DisconnectAllSrcObject (const kFbxClassId &pClassId)
	Disconnects this property from all the source objects of a specific class type.
bool	DisconnectAllSrcObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria)
	Disconnects this property from all the source objects of a specific class type that satisfy the given criteria.
int	GetSrcObjectCount () const
	Returns the number of source objects with which this property connects.
int	GetSrcObjectCount (KFbxCriteria const &pCriteria) const
	Returns the number of source objects that satisfy the given criteria with which this property connects.
int	GetSrcObjectCount (const kFbxClassId &pClassId) const
	Returns the number of source objects of the specific class type with which this property connects.
int	GetSrcObjectCount (const kFbxClassId &pClassId, KFbxCriteria const &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.
KFbxObject *	GetSrcObject (int pIndex=0) const
	Returns the source object at the specified index with which this property connects.
KFbxObject *	GetSrcObject (KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the source object that satisfies the criteria at the specified index with which this property connects.
KFbxObject *	GetSrcObject (const kFbxClassId &pClassId, int pIndex=0) const
	Returns the source object of the specified class type at the specified index with which this property connects.
KFbxObject *	GetSrcObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the source object which is of the specified class type and satisfies the given criteria at the specified index.
KFbxObject *	FindSrcObject (const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name, starting with the specified index.
KFbxObject *	FindSrcObject (KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name which satisfies the given criteria, starting with the specified index.
KFbxObject *	FindSrcObject (const kFbxClassId &pClassId, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name which is of the specified class type, starting with the specified index.
KFbxObject *	FindSrcObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, const char *pName, 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.
template<class T >
bool	DisconnectAllSrcObject (T const *pFBX_TYPE)
	Disconnects this property from all source objects of the specified class type.
template<class T >
bool	DisconnectAllSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria)
	Disconnects this property from all source objects which are of the specified class type and satisfy the given criteria.
template<class T >
int	GetSrcObjectCount (T const *pFBX_TYPE) const
	Returns the number of source objects of a specific class type with which this property connects.
template<class T >
int	GetSrcObjectCount (T const *pFBX_TYPE, KFbxCriteria const &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.
template<class T >
T *	GetSrcObject (T const *pFBX_TYPE, int pIndex=0) const
	Returns the source object of the specified class type at the specified index.
template<class T >
T *	GetSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the source object which is of the specified class type and satisfies the given criteria at the specified index.
template<class T >
T *	FindSrcObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name which is of the specified class type, starting with the specified index.
template<class T >
T *	FindSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, const char *pName, 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.
bool	ConnectDstObject (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone)
	Connects this property to one destination object.
bool	IsConnectedDstObject (const KFbxObject *pObject) const
	Judges whether this property connects with the destination object.
bool	DisconnectDstObject (KFbxObject *pObject)
	Disconnects this property from the destination object.
bool	DisconnectAllDstObject ()
	Disconnects this property from all the destination objects.
bool	DisconnectAllDstObject (KFbxCriteria const &pCriteria)
	Disconnects this property from all the destination objects that satisfy given criteria.
bool	DisconnectAllDstObject (const kFbxClassId &pClassId)
	Disconnects this property from all the destination objects of the specified class type.
bool	DisconnectAllDstObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria)
	Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria.
int	GetDstObjectCount () const
	Returns the number of destination objects with which this property connects.
int	GetDstObjectCount (KFbxCriteria const &pCriteria) const
	Returns the number of destination objects that satisfy the given criteria with which this property connects.
int	GetDstObjectCount (const kFbxClassId &pClassId) const
	Returns the number of destination objects of the specified class type with which this property connects.
int	GetDstObjectCount (const kFbxClassId &pClassId, KFbxCriteria const &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.
KFbxObject *	GetDstObject (int pIndex=0) const
	Returns the destination object at the specified index with which this property connects.
KFbxObject *	GetDstObject (KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the destination object that satisfies given criteria at the specified index with which this property connects.
KFbxObject *	GetDstObject (const kFbxClassId &pClassId, int pIndex=0) const
	Returns the destination object of the specified class type at the specified index with which this property connects.
KFbxObject *	GetDstObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, 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.
KFbxObject *	FindDstObject (const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name, starting with the specified index.
KFbxObject *	FindDstObject (KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name which satisfies the given criteria, starting with the specified index.
KFbxObject *	FindDstObject (const kFbxClassId &pClassId, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name which is of the specified class type, starting with the specified index.
KFbxObject *	FindDstObject (const kFbxClassId &pClassId, KFbxCriteria const &pCriteria, const char *pName, 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.
template<class T >
bool	DisconnectAllDstObject (T const *pFBX_TYPE)
	Disconnects this property from all the destination objects of the specified class type.
template<class T >
bool	DisconnectAllDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria)
	Disconnects this property from all the destination objects which are of the specified class type and satisfy the given criteria.
template<class T >
int	GetDstObjectCount (T const *pFBX_TYPE) const
	Returns the number of destination objects of the specified class type with which this property connects.
template<class T >
int	GetDstObjectCount (T const *pFBX_TYPE, KFbxCriteria const &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.
template<class T >
T *	GetDstObject (T const *pFBX_TYPE, int pIndex=0) const
	Returns the destination object of the specified class type at the specified index with which this property connects.
template<class T >
T *	GetDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, 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.
template<class T >
T *	FindDstObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name which is of the specified class type, starting with the specified index.
template<class T >
T *	FindDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, const char *pName, 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.
General Property Connection and Relationship Management
bool	ConnectSrcProperty (KFbxProperty const &pProperty)
	Connects this property to a source property.
bool	IsConnectedSrcProperty (KFbxProperty const &pProperty)
	Judges whether this property connects with the specified source property.
bool	DisconnectSrcProperty (KFbxProperty const &pProperty)
	Disconnects this property from the specified source property.
int	GetSrcPropertyCount () const
	Returns the number of source properties with which this property connects.
KFbxProperty	GetSrcProperty (int pIndex=0) const
	Returns the source property at the specified index with which this property connects.
KFbxProperty	FindSrcProperty (const char *pName, int pStartIndex=0) const
	Searches the source property with the specified name, starting with the specified index with which this property connects.
bool	ConnectDstProperty (KFbxProperty const &pProperty)
	Connects this property to a destination property.
bool	IsConnectedDstProperty (KFbxProperty const &pProperty)
	Judges if this property connects with the specified destination property.
bool	DisconnectDstProperty (KFbxProperty const &pProperty)
	Disconnects this property from the specified destination property.
int	GetDstPropertyCount () const
	Returns the number of destination properties with which this property connects.
KFbxProperty	GetDstProperty (int pIndex=0) const
	Returns the destination property at the specified index with which this property connects.
KFbxProperty	FindDstProperty (const char *pName, int pStartIndex=0) const
	Searches the destination property with the specified name, starting with the specified index with which this property connects.
void	ClearConnectCache ()
	Clears the connection cache of this property, this cache is used to store the connections that satisfy the given criteria.

---

Member Typedef Documentation

typedef FbxPropertyFlags::eFbxPropertyFlags EFlags

Search for all occurrences

Definition at line 91 of file kfbxproperty.h.

---

Member Enumeration Documentation

enum eFbxPropertyFlags

Search for all occurrences

Flags of FBX property.

Definition at line 54 of file kfbxpropertydef.h.

        {
            eNO_FLAG        = 0,     
            eANIMATABLE     = 1,     
            eUSER           = 1<<1,  
            eTEMPORARY      = 1<<2,  
            ePUBLISHED      = 1<<3,  
            ePSTATIC        = 1<<4,

            eNOT_SAVABLE    = 1<<5,  
            eHIDDEN         = 1<<6,  

            eUI_DISABLED    = 1<<7,  
            eUI_GROUP       = 1<<8,  
            eUI_BOOLGROUP   = 1<<9,  
            eUI_EXPANDED    = 1<<10, 
            eUI_NOCAPTION   = 1<<11, 
            eUI_PANEL       = 1<<12, 
            eUI_LEFTLABEL   = 1<<13, 
            eUI_HIDDEN      = 1<<14  
        };

---

Constructor & Destructor Documentation

KFbxProperty

(

)

Static property constructor.

KFbxProperty

(

KFbxProperty const &

pProperty

)

Copy constructor for properties.

Parameters:

pProperty

The property copied to this one.

KFbxProperty

(

KFbxPropertyHandle const &

pPropertyHandle

)

Copy constructor for properties.

Parameters:

pPropertyHandle

The property handle copied to this property handle.

~KFbxProperty

(

)

Static property destructor.

KFbxProperty	(	KFbxObject *	pObject,
		char const *	pName,
		KFbxDataType const &	pDataType = KFbxDataType(),
		char const *	pLabel = ""
	)		[protected]

Constructor / Destructor.

KFbxProperty	(	KFbxProperty const &	pParent,
		char const *	pName,
		KFbxDataType const &	pDataType,
		char const *	pLabel
	)		[protected]

---

Member Function Documentation

static KFbxProperty Create	(	KFbxProperty const &	pCompoundProperty,
		KFbxDataType const &	pDataType,
		char const *	pName,
		char const *	pLabel = "",
		bool	pCheckForDup = true,
		bool *	pWasFound = NULL
	)		[static]

Search for all occurrences

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, ProceduralTexture/main.cxx, and UserProperties/main.cxx.

static KFbxProperty Create	(	KFbxObject *	pObject,
		KFbxDataType const &	pDataType,
		char const *	pName,
		char const *	pLabel = "",
		bool	pCheckForDup = true,
		bool *	pWasFound = NULL
	)		[static]

Search for all occurrences

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.

static KFbxProperty CreateFrom	(	KFbxProperty const &	pCompoundProperty,
		KFbxProperty &	pFromProperty,
		bool	pCheckForDup = true
	)		[static]

Search for all occurrences

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.

static KFbxProperty CreateFrom	(	KFbxObject *	pObject,
		KFbxProperty &	pFromProperty,
		bool	pCheckForDup = true
	)		[static]

Search for all occurrences

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.

void Destroy

(

)

Search for all occurrences

Destroys a dynamic property.

void DestroyRecursively

(

)

Search for all occurrences

Destroys a dynamic property and its children.

Remarks:

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

void DestroyChildren

(

)

Search for all occurrences

Destroys children of a dynamic property.

Remarks:

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

KFbxDataType GetPropertyDataType

(

)

const

Search for all occurrences

Returns the property data type.

Returns:

The property data type.

Examples:

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

KString GetName

(

)

const

Search for all occurrences

Returns the internal name of the property.

Returns:

Property internal name string.

Examples:

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

KString GetHierarchicalName

(

)

const

Search for all occurrences

Returns the hierarchical name of the property.

Returns:

Property hierarchical name string.

KString GetLabel

(

bool

pReturnNameIfEmpty = true

)

const

Search for all occurrences

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.

void SetLabel

(

const KString &

pLabel

)

Search for all occurrences

Sets a label for the property.

Parameters:

pLabel

Label string.

KFbxObject* GetFbxObject

(

)

const

Search for all occurrences

Returns the object that contains the property.

Returns:

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

void SetUserTag

(

int

pTag

)

Search for all occurrences

Sets the user tag.

Parameters:

pTag	The user tag to be set.

int GetUserTag

(

)

Search for all occurrences

Gets the user tag.

void SetUserDataPtr

(

void *

pUserData

)

Search for all occurrences

Sets the user data pointer.

Parameters:

pUserData

The user data pointer.

void* GetUserDataPtr

(

)

Search for all occurrences

Gets the user data pointer.

Returns:

The user data pointer.

void ModifyFlag	(	eFbxPropertyFlags	pFlag,
		bool	pValue
	)

Search for all occurrences

Changes the property attribute.

Parameters:

pFlag	Property attribute identifier.
pValue	New state of pFlag.

Examples:

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

bool GetFlag

(

eFbxPropertyFlags

pFlag

)

const

Search for all occurrences

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.

KFbxInheritType GetFlagInheritType

(

eFbxPropertyFlags

pFlag

)

const

Search for all occurrences

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.

bool SetFlagInheritType	(	eFbxPropertyFlags	pFlag,
		KFbxInheritType	pType
	)

Search for all occurrences

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.

bool ModifiedFlag

(

eFbxPropertyFlags

pFlag

)

const

Search for all occurrences

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

KFbxProperty& operator=

(

KFbxProperty const &

pKProperty

)

Assignment operator.

Parameters:

pKProperty

The property assigned to this property.

Returns:

This property.

bool operator==

(

KFbxProperty const &

pKProperty

)

const

Equivalence operator.

Parameters:

pKProperty

The property compared to this property.

Returns:

True if equal, false otherwise.

bool operator!=

(

KFbxProperty const &

pKProperty

)

const

Non-equivalence operator.

Parameters:

pKProperty

The property compared to this property.

Returns:

True if unequal, false otherwise.

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 294 of file kfbxproperty.h.

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

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 300 of file kfbxproperty.h.

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

bool CompareValue

(

KFbxProperty const &

pProp

)

const

Search for all occurrences

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

Parameters:

pProp

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

Returns:

True if equal, false otherwise.

bool CopyValue

(

KFbxProperty const &

pProp

)

Search for all occurrences

Copies the value of a property.

Parameters:

pProp

The property from which to derive the value.

Returns:

True if value has been copied successfully, false otherwise.

bool IsValid

(

)

const

Search for all occurrences

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/Texture.cxx.

static bool HasDefaultValue

(

KFbxProperty &

pProperty

)

[static]

Search for all occurrences

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 eFbxOverride, pProperty's value should have been modified, so pProperty doesn't have the default value. If the inheritance type of pProperty's value is eFbxInherit, that means pProperty's value inherits the referenced object's property value, so pProperty has the default value.

bool Set	(	void const *	pValue,
		EFbxType	pValueType,
		bool	pCheckForValueEquality
	)

Search for all occurrences

Sets the value of this property.

Parameters:

pValue	Pointer to the new value
pValueType	The data type of the new value
pCheckForValueEquality	If true, the value is not set when it is equal to the default value.

Returns:

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

Examples:

ExportScene03/main.cxx, ExportScene05/main.cxx, and UserProperties/main.cxx.

bool Set	(	void const *	pValue,
		EFbxType	pValueType
	)		[inline]

Search for all occurrences

Sets the value of this function.

Parameters:

pValue	Pointer to the new value
pValueType	The data type of the new value

Returns:

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

Definition at line 349 of file kfbxproperty.h.

{ return Set( pValue, pValueType, true ); }

bool Get	(	void *	pValue,
		EFbxType	pValueType
	)		const

Search for all occurrences

Returns the value of the property.

Parameters:

pValue	Pointer to the value
pValueType	The data type of the value.

Returns:

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

Examples:

StereoCamera/main.cxx, and ViewScene/Texture.cxx.

bool Set

(

T const &

pValue

)

[inline]

Search for all occurrences

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.

Reimplemented in KFbxTypedProperty< T >.

Definition at line 362 of file kfbxproperty.h.

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

T Get

(

T const *

pFBX_TYPE

)

const [inline]

Search for all occurrences

Gets the value of the property.

Parameters:

pFBX_TYPE

The data type of the value.

Returns:

The property value.

Definition at line 368 of file kfbxproperty.h.

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

KFbxInheritType GetValueInheritType

(

)

const

Search for all occurrences

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.

bool SetValueInheritType

(

KFbxInheritType

pType

)

Search for all occurrences

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.

bool Modified

(

)

const

Search for all occurrences

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 eFbxOverride, the property's value should have been modified, it returns true. If the inheritance type of the property's value is eFbxInherit, 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.

void SetMinLimit

(

double

pMin

)

Search for all occurrences

Sets a minimum property value limit.

Parameters:

pMin	Minimum value allowed.

bool HasMinLimit

(

)

const

Search for all occurrences

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.

double GetMinLimit

(

)

const

Search for all occurrences

Returns the minimum property value limit.

Returns:

The minimum value limit.

Examples:

ImportScene/DisplayGenericInfo.cxx.

bool HasMaxLimit

(

)

const

Search for all occurrences

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.

void SetMaxLimit

(

double

pMax

)

Search for all occurrences

Sets a maximum property value limit.

Parameters:

pMax	Maximum value allowed.

double GetMaxLimit

(

)

const

Search for all occurrences

Returns the maximum property value.

Returns:

The maximum value limit.

Examples:

ImportScene/DisplayGenericInfo.cxx.

void SetLimits	(	double	pMin,
		double	pMax
	)

Search for all occurrences

Sets the minimum and maximum value limit of the property.

Parameters:

pMin	Minimum value allowed.
pMax	Maximum value allowed.

Examples:

UserProperties/main.cxx.

int AddEnumValue

(

char const *

pStringValue

)

Search for all occurrences

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.

Remarks:

This function is only valid if the property type is eENUM. Empty strings are not allowed.

Examples:

UserProperties/main.cxx.

void InsertEnumValue	(	int	pIndex,
		char const *	pStringValue
	)

Search for all occurrences

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 eENUM. pIndex must be in the range [0, ListValueGetCount()]. Empty strings are not allowed.

Examples:

UserProperties/main.cxx.

int GetEnumCount

(

)

const

Search for all occurrences

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

void SetEnumValue	(	int	pIndex,
		char const *	pStringValue
	)

Search for all occurrences

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

void RemoveEnumValue

(

int

pIndex

)

Search for all occurrences

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

const char* GetEnumValue

(

int

pIndex

)

const

Search for all occurrences

Returns a string value at the specified index.

Parameters:

pIndex

Zero bound index.

Remarks:

This function is only valid if the property type is eENUM.

Examples:

ImportScene/DisplayAnimation.cxx.

bool IsRoot

(

)

const [inline]

Search for all occurrences

Judges if this property is the root property.

Returns:

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

Definition at line 510 of file kfbxproperty.h.

{ return mPropertyHandle.IsRoot(); }

bool IsChildOf

(

KFbxProperty const &

pParent

)

const [inline]

Search for all occurrences

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 516 of file kfbxproperty.h.

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

bool IsDescendentOf

(

KFbxProperty const &

pAncestor

)

const [inline]

Search for all occurrences

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 522 of file kfbxproperty.h.

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

KFbxProperty GetParent

(

)

const [inline]

Search for all occurrences

Returns the parent property of this property.

Returns:

The parent of this property.

Definition at line 527 of file kfbxproperty.h.

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

bool SetParent

(

const KFbxProperty &

pOther

)

Search for all occurrences

Sets the parent for this property (this function has not been implemented, so it always return false).

Parameters:

pOther

The parent to be set.

Returns:

True on success, false otherwise.

KFbxProperty GetChild

(

)

const [inline]

Search for all occurrences

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 538 of file kfbxproperty.h.

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

KFbxProperty GetSibling

(

)

const [inline]

Search for all occurrences

Returns the sibling of this property.

Returns:

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

Definition at line 543 of file kfbxproperty.h.

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

KFbxProperty GetFirstDescendent

(

)

const [inline]

Search for all occurrences

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 548 of file kfbxproperty.h.

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

KFbxProperty GetNextDescendent

(

KFbxProperty const &

pProperty

)

const [inline]

Search for all occurrences

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 554 of file kfbxproperty.h.

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

KFbxProperty Find	(	char const *	pName,
		bool	pCaseSensitive = true
	)		const [inline]

Search for all occurrences

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 KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Examples:

ProceduralTexture/main.cxx.

Definition at line 562 of file kfbxproperty.h.

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

KFbxProperty Find	(	char const *	pName,
		KFbxDataType const &	pDataType,
		bool	pCaseSensitive = true
	)		const [inline]

Search for all occurrences

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 KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 571 of file kfbxproperty.h.

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

KFbxProperty FindHierarchical	(	char const *	pName,
		bool	pCaseSensitive = true
	)		const [inline]

Search for all occurrences

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 KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Examples:

ImportScene/DisplayMaterial.cxx.

Definition at line 579 of file kfbxproperty.h.

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

KFbxProperty FindHierarchical	(	char const *	pName,
		KFbxDataType const &	pDataType,
		bool	pCaseSensitive = true
	)		const [inline]

Search for all occurrences

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 KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 588 of file kfbxproperty.h.

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

void BeginCreateOrFindProperty

(

)

[inline]

Search for all occurrences

Internal function for building a property name map.

Definition at line 597 of file kfbxproperty.h.

{ mPropertyHandle.BeginCreateOrFindProperty();  }

void EndCreateOrFindProperty

(

)

[inline]

Search for all occurrences

Internal function for clearing the property name map.

Definition at line 600 of file kfbxproperty.h.

{ mPropertyHandle.EndCreateOrFindProperty();    }

bool SetArraySize	(	int	pSize,
		bool	pVariableArray
	)

Search for all occurrences

Sets the array size(not implemented).

Parameters:

pSize
pVariableArray

int GetArraySize

(

)

const

Search for all occurrences

Returns the array size(not implemented).

KFbxProperty GetArrayItem

(

int

pIndex

)

const

Search for all occurrences

Returns the (pIndex)th array item.

Parameters:

pIndex

The item index.

Returns:

The (pIndex)th array item.

KFbxProperty operator[]

(

int

pIndex

)

const [inline]

Returns the (pIndex)th array item.

Parameters:

pIndex

The item index.

Returns:

The (pIndex)th array item.

Definition at line 650 of file kfbxproperty.h.

{ return GetArrayItem(pIndex); }

KFbxAnimCurveNode* CreateCurveNode

(

KFbxAnimLayer *

pAnimLayer

)

Search for all occurrences

Creates a KFbxAnimCurveNode on the specified layer.

Parameters:

pAnimLayer

The animation layer the KFbxAnimCurveNode object is attached to.

Returns:

Pointer to the created KFbxAnimCurveNode.

Remarks:

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

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

The created KFbxAnimCurveNode does not automatically allocate anim curves.

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

Examples:

ExportScene03/main.cxx.

KFbxAnimCurveNode* GetCurveNode	(	KFbxAnimLayer *	pAnimLayer,
		bool	pCreateAsNeeded = false
	)

Search for all occurrences

Get the KFbxAnimCurveNode of the property that is connected to the specified animation layer.

Parameters:

pAnimLayer	The searched animation layer.
pCreateAsNeeded	Creates a KFbxAnimCurveNode if it does not exist.

Returns:

Pointer to the created KFbxAnimCurveNode or NULL if an error occurred.

Remarks:

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

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

A created KFbxAnimCurveNode does not allocate anim curves.

Examples:

ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, Instances/main.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, and UserProperties/main.cxx.

KFbxAnimCurveNode* GetCurveNode	(	bool	pCreateAsNeeded = false,
		const char *	pAnimStackName = NULL
	)

Search for all occurrences

Use the animation stack name to look for the AnimStack and retrieves the first layer from the stack.

This layer is then used to get the curve node.

Parameters:

pCreateAsNeeded	Creates a KFbxAnimCurveNode if it does not exist.
pAnimStackName	The name of the animation stack.

T* GetCurve	(	KFbxAnimLayer *	pAnimLayer,
		bool	pCreateAsNeeded = false
	)		[inline]

Search for all occurrences

Get the KFbxAnimCurve from the specified animation layer.

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

Parameters:

pAnimLayer	The searched animation layer.
pCreateAsNeeded	Create a KFbxAnimCurve if not found.

Returns:

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

Remarks:

If the KFbxAnimCurveNode does not exists but the property has the eANIMATABLE flag set and pCreateAsNeeded is true, then this function will first create the KFbxAnimCurveNode object and then the KFbxAnimCurve.

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

Examples:

ExportScene01/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, Pivot/main.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, UserProperties/main.cxx, ViewScene/DrawScene.cxx, and ViewScene/SetCamera.cxx.

Definition at line 697 of file kfbxproperty.h.

            {
                return KFbxCast<T>(GetCurve(pAnimLayer, GetName(), NULL, pCreateAsNeeded));
            }

T* GetCurve	(	KFbxAnimLayer *	pAnimLayer,
		const char *	pChannel,
		bool	pCreateAsNeeded = false
	)		[inline]

Search for all occurrences

Get the KFbxAnimCurve from the specified animation layer.

This function expects to find a KFbxAnimCurveNode object with the same name as the property and it attempts to retrieve the KFbxAnimCurve 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.
pCreateAsNeeded	Create a KFbxAnimCurve if not found.

Returns:

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

Remarks:

If the KFbxAnimCurveNode does not exists but the property has the eANIMATABLE flag set and pCreateAsNeeded is true, then this function will first create the KFbxAnimCurveNode object and then the KFbxAnimCurve.

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

Definition at line 717 of file kfbxproperty.h.

            {
                return KFbxCast<T>(GetCurve(pAnimLayer, GetName(), pChannel, pCreateAsNeeded));
            }

T* GetCurve	(	KFbxAnimLayer *	pAnimLayer,
		const char *	pName,
		const char *	pChannel,
		bool	pCreateAsNeeded = false
	)		[inline]

Search for all occurrences

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

This function looks for the KFbxAnimCurveNode named pName and the channel pChannel. It will retrieves the KFbxAnimCurve 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.
pCreateAsNeeded	Create a KFbxAnimCurve if not found.

Returns:

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

Remarks:

If the KFbxAnimCurveNode does not exists but the property has the eANIMATABLE flag set and pCreateAsNeeded is true, then this function will first create the KFbxAnimCurveNode object and then the KFbxAnimCurve.

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

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

Definition at line 739 of file kfbxproperty.h.

            {
                return KFbxCast<T>(GetCurve(pAnimLayer, pName, pChannel, pCreateAsNeeded));
            }

bool ConnectSrcObject	(	KFbxObject *	pObject,
		kFbxConnectionType	pType = eFbxConnectionNone
	)

Search for all occurrences

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:

ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, Layers/main.cxx, ProceduralTexture/main.cxx, and UIExamples/CubeCreator/SDK_Utility.cxx.

bool IsConnectedSrcObject

(

const KFbxObject *

pObject

)

const

Search for all occurrences

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.

bool DisconnectSrcObject

(

KFbxObject *

pObject

)

Search for all occurrences

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.

bool DisconnectAllSrcObject

(

)

Search for all occurrences

Disconnects this property from all the source objects.

Returns:

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

bool DisconnectAllSrcObject

(

KFbxCriteria const &

pCriteria

)

Search for all occurrences

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.

bool DisconnectAllSrcObject

(

const kFbxClassId &

pClassId

)

Search for all occurrences

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

Parameters:

pClassId

The specific class type.

Returns:

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

bool DisconnectAllSrcObject	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria
	)

Search for all occurrences

Disconnects this property from all the source objects of a specific class type that satisfy the given criteria.

Parameters:

pClassId	The specific class type.
pCriteria	The given criteria.

Returns:

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

int GetSrcObjectCount

(

)

const

Search for all occurrences

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, UIExamples/CubeCreator/SDK_Utility.cxx, and ViewScene/Texture.cxx.

int GetSrcObjectCount

(

KFbxCriteria const &

pCriteria

)

const

Search for all occurrences

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.

int GetSrcObjectCount

(

const kFbxClassId &

pClassId

)

const

Search for all occurrences

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

Parameters:

pClassId

The specific class type.

Returns:

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

int GetSrcObjectCount	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria
	)		const

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
pCriteria	The given criteria.

Returns:

The number of source objects.

KFbxObject* GetSrcObject

(

int

pIndex = 0

)

const

Search for all occurrences

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/Texture.cxx.

KFbxObject* GetSrcObject	(	KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)		const

Search for all occurrences

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.

KFbxObject* GetSrcObject	(	const kFbxClassId &	pClassId,
		int	pIndex = 0
	)		const

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
pIndex	The specified index whose default value is 0.

Returns:

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

KFbxObject* GetSrcObject	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)		const

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
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.

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

Search for all occurrences

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.

KFbxObject* FindSrcObject	(	KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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.

KFbxObject* FindSrcObject	(	const kFbxClassId &	pClassId,
		const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
pName	The object name.
pStartIndex	The start index.

Returns:

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

KFbxObject* FindSrcObject	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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.

Parameters:

pClassId	The specified class type.
pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns:

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

bool DisconnectAllSrcObject

(

T const *

pFBX_TYPE

)

[inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE

The specified class type.

Returns:

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

Definition at line 882 of file kfbxproperty.h.

{ return DisconnectAllSrcObject(T::ClassId);}

bool DisconnectAllSrcObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)		[inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
pCriteria	The given criteria.

Returns:

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

Definition at line 889 of file kfbxproperty.h.

{ return DisconnectAllSrcObject(T::ClassId,pCriteria);  }

int GetSrcObjectCount

(

T const *

pFBX_TYPE

)

const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE

The specified class type.

Returns:

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

Definition at line 895 of file kfbxproperty.h.

{ return GetSrcObjectCount(T::ClassId); }

int GetSrcObjectCount	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)		const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
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 902 of file kfbxproperty.h.

{ return GetSrcObjectCount(T::ClassId,pCriteria); }

T* GetSrcObject	(	T const *	pFBX_TYPE,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
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 909 of file kfbxproperty.h.

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

T* GetSrcObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
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 917 of file kfbxproperty.h.

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

T* FindSrcObject	(	T const *	pFBX_TYPE,
		const char *	pName,
		int	pStartIndex = 0
	)		const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
pName	The object name.
pStartIndex	The start index.

Returns:

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

Definition at line 925 of file kfbxproperty.h.

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

T* FindSrcObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)		const [inline]

Search for all occurrences

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.

Parameters:

pFBX_TYPE	The specified class type.
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 934 of file kfbxproperty.h.

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

bool ConnectDstObject	(	KFbxObject *	pObject,
		kFbxConnectionType	pType = eFbxConnectionNone
	)

Search for all occurrences

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.

bool IsConnectedDstObject

(

const KFbxObject *

pObject

)

const

Search for all occurrences

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.

bool DisconnectDstObject

(

KFbxObject *

pObject

)

Search for all occurrences

Disconnects this property from the destination object.

Parameters:

pObject

The destination object from which this property disconnects from.

Returns:

True on success, false otherwise.

bool DisconnectAllDstObject

(

)

Search for all occurrences

Disconnects this property from all the destination objects.

Returns:

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

bool DisconnectAllDstObject

(

KFbxCriteria const &

pCriteria

)

Search for all occurrences

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.

bool DisconnectAllDstObject

(

const kFbxClassId &

pClassId

)

Search for all occurrences

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

Parameters:

pClassId

The specified class type.

Returns:

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

bool DisconnectAllDstObject	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria
	)

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
pCriteria	The given criteria.

Returns:

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

int GetDstObjectCount

(

)

const

Search for all occurrences

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

Returns:

The number of destination objects with which this property connects.

int GetDstObjectCount

(

KFbxCriteria const &

pCriteria

)

const

Search for all occurrences

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.

int GetDstObjectCount

(

const kFbxClassId &

pClassId

)

const

Search for all occurrences

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

Parameters:

pClassId

The specified class type.

Returns:

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

int GetDstObjectCount	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria
	)		const

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
pCriteria	The given criteria.

Returns:

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

KFbxObject* GetDstObject

(

int

pIndex = 0

)

const

Search for all occurrences

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.

KFbxObject* GetDstObject	(	KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)		const

Search for all occurrences

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.

KFbxObject* GetDstObject	(	const kFbxClassId &	pClassId,
		int	pIndex = 0
	)		const

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
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.

KFbxObject* GetDstObject	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)		const

Search for all occurrences

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.

Parameters:

pClassId	The specified class type.
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.

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

Search for all occurrences

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.

KFbxObject* FindDstObject	(	KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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.

KFbxObject* FindDstObject	(	const kFbxClassId &	pClassId,
		const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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

Parameters:

pClassId	The specified class type.
pName	The object name.
pStartIndex	The start index.

Returns:

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

KFbxObject* FindDstObject	(	const kFbxClassId &	pClassId,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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.

Parameters:

pClassId	The specified class type.
pCriteria	The given criteria.
pName	The object name.
pStartIndex	The start index.

Returns:

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

bool DisconnectAllDstObject

(

T const *

pFBX_TYPE

)

[inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE

The specified class type.

Returns:

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

Definition at line 1068 of file kfbxproperty.h.

{ return DisconnectAllDstObject(T::ClassId);    }

bool DisconnectAllDstObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)		[inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
pCriteria	The given criteria.

Returns:

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

Definition at line 1075 of file kfbxproperty.h.

{ return DisconnectAllDstObject(T::ClassId,pCriteria);  }

int GetDstObjectCount

(

T const *

pFBX_TYPE

)

const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE

The specified class type.

Returns:

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

Definition at line 1081 of file kfbxproperty.h.

{ return GetDstObjectCount(T::ClassId); }

int GetDstObjectCount	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)		const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
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 1088 of file kfbxproperty.h.

{ return GetDstObjectCount(T::ClassId,pCriteria); }

T* GetDstObject	(	T const *	pFBX_TYPE,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
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 1095 of file kfbxproperty.h.

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

T* GetDstObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

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.

Parameters:

pFBX_TYPE	The specified class type.
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 1103 of file kfbxproperty.h.

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

T* FindDstObject	(	T const *	pFBX_TYPE,
		const char *	pName,
		int	pStartIndex = 0
	)		const [inline]

Search for all occurrences

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

Parameters:

pFBX_TYPE	The specified class type.
pName	The object name.
pStartIndex	The start index.

Returns:

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

Definition at line 1111 of file kfbxproperty.h.

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

T* FindDstObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)		const [inline]

Search for all occurrences

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.

Parameters:

pFBX_TYPE	The specified class type.
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 1120 of file kfbxproperty.h.

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

bool ConnectSrcProperty

(

KFbxProperty const &

pProperty

)

Search for all occurrences

Connects this property to a source property.

Parameters:

pProperty

The source property with which this property connects.

Returns:

True on success, false otherwise.

bool IsConnectedSrcProperty

(

KFbxProperty const &

pProperty

)

Search for all occurrences

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.

bool DisconnectSrcProperty

(

KFbxProperty const &

pProperty

)

Search for all occurrences

Disconnects this property from the specified source property.

Parameters:

pProperty

The specified source property.

Returns:

True on success, false otherwise.

int GetSrcPropertyCount

(

)

const

Search for all occurrences

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

Returns:

The number of source properties with which this property connects.

KFbxProperty GetSrcProperty

(

int

pIndex = 0

)

const

Search for all occurrences

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.

KFbxProperty FindSrcProperty	(	const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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.

bool ConnectDstProperty

(

KFbxProperty const &

pProperty

)

Search for all occurrences

Connects this property to a destination property.

Parameters:

pProperty

The destination property with which this property connects.

Returns:

True on success, false otherwise.

bool IsConnectedDstProperty

(

KFbxProperty const &

pProperty

)

Search for all occurrences

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.

bool DisconnectDstProperty

(

KFbxProperty const &

pProperty

)

Search for all occurrences

Disconnects this property from the specified destination property.

Parameters:

pProperty

The specified destination property.

Returns:

True on success, false otherwise.

int GetDstPropertyCount

(

)

const

Search for all occurrences

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

Returns:

The number of destination properties with which this property connects.

KFbxProperty GetDstProperty

(

int

pIndex = 0

)

const

Search for all occurrences

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.

KFbxProperty FindDstProperty	(	const char *	pName,
		int	pStartIndex = 0
	)		const

Search for all occurrences

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.

void ClearConnectCache

(

)

Search for all occurrences

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

---

Friends And Related Function Documentation

friend class KFbxObject [friend]

Search for all occurrences

Reimplemented in KFbxTypedProperty< T >, KFbxTypedProperty< fbxReference * >, KFbxTypedProperty< ECategory >, KFbxTypedProperty< kCharacterHandContactType >, KFbxTypedProperty< kCharacterFingerContactMode >, KFbxTypedProperty< ELook >, KFbxTypedProperty< KFbxControlSet::EType >, KFbxTypedProperty< ECameraGateFit >, KFbxTypedProperty< EWrapMode >, KFbxTypedProperty< fbxInteger1 >, KFbxTypedProperty< double >, KFbxTypedProperty< ECameraStereo >, KFbxTypedProperty< EQuaternionInterpolation >, KFbxTypedProperty< EInterlaceMode >, KFbxTypedProperty< ECameraFrontBackPlaneDisplayMode >, KFbxTypedProperty< ECameraFormat >, KFbxTypedProperty< ECameraApertureMode >, KFbxTypedProperty< fbxReference >, KFbxTypedProperty< kCharacterHipsTranslationMode >, KFbxTypedProperty< kCharacterFootContactType >, KFbxTypedProperty< ECameraFilmRollOrder >, KFbxTypedProperty< ETextureUse6 >, KFbxTypedProperty< int >, KFbxTypedProperty< fbxBlob >, KFbxTypedProperty< kCharacterOffAutoUser >, KFbxTypedProperty< ECameraProjectionType >, KFbxTypedProperty< ECameraFrontBackPlaneDistanceMode >, KFbxTypedProperty< kCharacterContactBehaviour >, KFbxTypedProperty< ECameraSamplingType >, KFbxTypedProperty< fbxString >, KFbxTypedProperty< EBlendMode >, KFbxTypedProperty< ELightType >, KFbxTypedProperty< fbxEnum >, KFbxTypedProperty< kCharacterRollExtractionMode >, KFbxTypedProperty< EUnifiedMappingType >, KFbxTypedProperty< EDecayType >, KFbxTypedProperty< fbxBool1 >, KFbxTypedProperty< fbxDouble1 >, KFbxTypedProperty< EAccessMode >, KFbxTypedProperty< ERotationOrder >, KFbxTypedProperty< ECameraSafeAreaStyle >, KFbxTypedProperty< ECameraApertureFormat >, KFbxTypedProperty< bool >, KFbxTypedProperty< ECameraFocusDistanceSource >, KFbxTypedProperty< ETransformInheritType >, KFbxTypedProperty< kCharacterFloorPivot >, KFbxTypedProperty< fbxDateTime >, KFbxTypedProperty< fbxULongLong1 >, KFbxTypedProperty< ECameraAntialiasingMethod >, KFbxTypedProperty< ECameraAspectRatioMode >, KFbxTypedProperty< KString >, KFbxTypedProperty< kCharacterAutoUser >, KFbxTypedProperty< kCharacterPosture >, KFbxTypedProperty< fbxTime >, and KFbxTypedProperty< fbxDouble3 >.

Definition at line 1251 of file kfbxproperty.h.

void KMarkObject	(	KFbxObject *	pObject,
		KMap< KFbxObject *, int > &	pObjectDstDisconnectCount,
		KSet2< KFbxObject * > &	pObjectsToDeleted,
		KArrayTemplate< KFbxObject * > &	pObjectToDeletedInSequence
	)		[friend]

Search for all occurrences

void KCleanUpConnectionsAtDestructionBoundary	(	KFbxScene *	pObject,
		KArrayTemplate< KFbxObject * > &	pObjectToDeletedInSequence
	)		[friend]

Search for all occurrences

---

Member Data Documentation

const char* sHierarchicalSeparator [static]

Search for all occurrences

Hierarchical separator of properties.

Definition at line 1207 of file kfbxproperty.h.

---

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

• fbxfilesdk/kfbxplugins/kfbxproperty.h