KFbxProperty Class Reference

#include <kfbxproperty.h>
Inheritance diagram for KFbxProperty:
Inheritance graph
[legend]

List of all members.

Detailed Description

Class to hold user properties.

Definition at line 58 of file kfbxproperty.h.


Constructor and Destructor.
typedef
FbxPropertyFlags::eFbxPropertyFlags 		 EFlags
static KFbxProperty  Create (KFbxProperty const &pCompoundProperty, char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="", bool pCheckForDuplicate=true, bool *pWasFound=NULL)
  Creates a property.
template<typename T>
static KFbxProperty  Create (KFbxProperty const &pParentProperty, char const *pName, KFbxDataType const &pDataType, T const &pValue, eFbxPropertyFlags pFlags=eNO_FLAG, bool pCheckForDuplicate=true, bool pForceSet=true)
  Creates a property.
static KFbxProperty  Create (KFbxObject *pObject, char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="", bool pCheckForDuplicate=true, bool *pWasFound=NULL)
  Creates a dynamic property.
static KFbxProperty  Create (KFbxObject *pObject, KFbxProperty &pFromProperty, bool pCheckForDuplicate=true)
  Creates a dynamic property from another property.
static KFbxProperty  Create (KFbxProperty const &pCompoundProperty, KFbxProperty &pFromProperty, bool pCheckForDuplicate=true)
  Creates a dynamic property from another property.
void  Destroy (bool pRecursive=true, bool pDependents=false)
  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.

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.
bool  Get (void *pValue, EFbxType pValueType, KFbxEvaluationInfo const *pEvaluateInfo)
  Evaluates the KFCurve value of the property at the specific time, then 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.
template<class T>
T  Get (T const *pFBX_TYPE, KFbxEvaluationInfo const *pEvaluateInfo)
  Evaluates the KFCurve value of the property at the specific time, then returns the value of the property.
template<class T>
T  Get (KFbxEvaluationInfo const *pEvaluateInfo)
  Evaluates the KFCurve value of the property at the specific time, then returns the value of the property.
bool  Get (void *pValue, EFbxType pValueType, KFbxEvaluationInfo *pEvaluateInfo) const
  Evaluates the KFCurve value of the property at the specific time, then returns 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 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)
  Returns the property label.
void  SetLabel (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)
  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.

Property Limits.
Property limits are provided for convenience if some applications desire to bound the range of possible values for a given type property.

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 ()
  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.
char *  GetEnumValue (int pIndex)
  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.

FCurve Management
KFCurveNode *  CreateKFCurveNode (const char *pTakeName=NULL)
  Creates a KFCurveNode on a take.
KFCurveNode *  GetKFCurveNode (bool pCreateAsNeeded=false, const char *pTakeName=NULL)
  Returns the KFCurveNode of the property from a take.
KFCurve *  GetKFCurve (const char *pChannel=NULL)
  Tries to get the KFCurve of the specified channel from the current take.
KFCurve *  GetKFCurve (const char *pChannel, const char *pTakeName)
  Tries to get the KFCurve of the specified channel from the given take.

Evaluation management
bool  Evaluate (KFbxEvaluationInfo const *pEvaluationInfo)
  Evaluates the KFCurve value of this property at the specified time, then sets the property value as the KFCurve value.

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.

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.

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

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.

Member Function Documentation

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

Creates a property.

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

Referenced by KFbxTypedProperty< fbxReference * >::StaticInit(), and KFbxTypedProperty< KFbxMarker::ELook >::StaticInit().

static KFbxProperty Create ( KFbxProperty const &  pParentProperty,
char const *  pName,
KFbxDataType const &  pDataType,
T const &  pValue,
eFbxPropertyFlags  pFlags = eNO_FLAG,
bool  pCheckForDuplicate = true,
bool  pForceSet = true  
) [inline, static]

Creates a property.

Parameters:
pParentProperty  The parent property of this property.
pName  The property name.
pDataType  The data type of this property.
pValue  The value of this property.
pFlags  The property flag.
pCheckForDuplicate  If true, parent property checks whether it already has a child property with pName, if false, the new property is created.
pForceSet  If true, the value will be set forcibly, if false the value is not set when it is equal to the default value.

Definition at line 104 of file kfbxproperty.h.

References Find(), IsValid(), ModifyFlag(), and Set().

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

Creates a dynamic property.

Parameters:
pObject  The object that contains this property.
pName  The property name.
pDataType  The data type of this property.
pLabel  The label of this property.
pCheckForDuplicate  If true, pObject checks whether it already has a property with pName, if false, a new property is created.
pWasFound  If pCheckForDuplicate is true, this flag is set to indicate whether the pObject already has a child property with pName.

static KFbxProperty Create ( KFbxObject *  pObject,
KFbxProperty &  pFromProperty,
bool  pCheckForDuplicate = true  
) [static]

Creates a dynamic property from another property.

Parameters:
pObject  The object that contains this property.
pFromProperty  The property copied by this property.
pCheckForDuplicate  If true, pObject checks if it already has a property with pName, if false, a new property is created.

static KFbxProperty Create ( KFbxProperty const &  pCompoundProperty,
KFbxProperty &  pFromProperty,
bool  pCheckForDuplicate = true  
) [static]

Creates a dynamic property from another property.

Parameters:
pCompoundProperty  The parent property of this property.
pFromProperty  The property copied by this property.
pCheckForDuplicate  If true, parent property checks if it already has a child property with pName, if false, a new property is created.

void Destroy ( bool  pRecursive = true,
bool  pDependents = false  
)

Destroys a dynamic property.

Parameters:
pRecursive 
pDependents 
Remarks:
Before destroying, disconnect it from all the source and destination properties, then remove it from the object containing it and destroy it. The two parameters are useless in this function.

void DestroyRecursively (  ) 

Destroys a dynamic property and its children.

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

void DestroyChildren (  ) 

Destroys children of a dynamic property.

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

KFbxDataType GetPropertyDataType (  )  const

Returns the property data type.

Returns:
The property data type.

Referenced by KFbxStreamOptions::SetOption().

KString GetName (  )  const

Returns the internal name of the property.

Returns:
Property internal name string.

KString GetHierarchicalName (  )  const

Returns the hierarchical name of the property.

Returns:
Property hierarchical name string.

KString GetLabel ( bool  pReturnNameIfEmpty = true  ) 

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.

void SetLabel ( KString  pLabel  ) 

Sets a label for the property.

Parameters:
pLabel  Label string.

KFbxObject* GetFbxObject (  )  const

Returns the object that contains the property.

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

void SetUserTag ( int  pTag  ) 

Sets the user tag.

Parameters:
pTag  The user tag to be set.

int GetUserTag (  ) 

Gets the user tag.

void SetUserDataPtr ( void *  pUserData  ) 

Sets the user data pointer.

Parameters:
pUserData  The user data pointer.

void* GetUserDataPtr (  ) 

Gets the user data pointer.

Returns:
The user data pointer.

void ModifyFlag ( eFbxPropertyFlags  pFlag,
bool  pValue  
)

Changes the property attribute.

Parameters:
pFlag  Property attribute identifier.
pValue  New state of pFlag.

Referenced by Create(), KFbxTypedProperty< fbxReference * >::StaticInit(), and KFbxTypedProperty< KFbxMarker::ELook >::StaticInit().

bool GetFlag ( eFbxPropertyFlags  pFlag  ) 

Returns the state of the property attribute.

Parameters:
pFlag  Property attribute identifier.
Returns:
The state of the property attribute(pFlag).

KFbxInheritType GetFlagInheritType ( eFbxPropertyFlags  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.

bool SetFlagInheritType ( eFbxPropertyFlags  pFlag,
KFbxInheritType  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.

bool ModifiedFlag ( eFbxPropertyFlags  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

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

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

bool CompareValue ( KFbxProperty const &  pProp  )  const

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  ) 

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

Judges the property’s validity.

Returns:
True if this property is valid, false otherwise.

Referenced by Create(), and KFbxStreamOptions::SetOption().

static bool HasDefaultValue ( KFbxProperty &  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 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  
)

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.

Referenced by Create(), KFbxStreamOptionsMotionWriter::SetFrameCount(), KFbxStreamOptionsMotionReader::SetFrameCount(), KFbxStreamOptions::SetOption(), KFbxStreamOptionsMotionWriter::SetStart(), and KFbxStreamOptionsMotionReader::SetStart().

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

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

bool Get ( void *  pValue,
EFbxType  pValueType  
) const

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.

bool Get ( void *  pValue,
EFbxType  pValueType,
KFbxEvaluationInfo const *  pEvaluateInfo  
)

Evaluates the KFCurve value of the property at the specific time, then returns the value of the property .

Parameters:
pValue  Pointer to the value.
pValueType  The data type of the value.
pEvaluateInfo  Contains the time of evaluation.
Returns:
True if type is compatible and value is returned successfully, false otherwise.
Remarks:
When evaluated, the property value is set as the KFCurve value.

bool Set ( T const &  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.

Reimplemented in KFbxTypedProperty.

Definition at line 401 of file kfbxproperty.h.

T Get ( T const *  pFBX_TYPE  )  const [inline]

Gets the value of the property.

Parameters:
pFBX_TYPE  The data type of the value.
Returns:
The property value.

Definition at line 407 of file kfbxproperty.h.

T Get ( T const *  pFBX_TYPE,
KFbxEvaluationInfo const *  pEvaluateInfo  
) [inline]

Evaluates the KFCurve value of the property at the specific time, then returns the value of the property.

Parameters:
pFBX_TYPE  The data type of the value.
pEvaluateInfo  Contains the time of evaluation.
Returns:
The value of the property after evaluation.
Remarks:
When evaluated, the property value is set as the KFCurve value.

Definition at line 415 of file kfbxproperty.h.

T Get ( KFbxEvaluationInfo const *  pEvaluateInfo  )  [inline]

Evaluates the KFCurve value of the property at the specific time, then returns the value of the property.

Parameters:
pEvaluateInfo  Contains the time of evaluation.
Returns:
The value of the property after evaluation.
Remarks:
When evaluated, the property value is set as the KFCurve value.

Reimplemented in KFbxTypedProperty, KFbxTypedProperty< KFbxNull::ELook >, KFbxTypedProperty< kCharacterHandContactType >, KFbxTypedProperty< kCharacterFingerContactMode >, KFbxTypedProperty< KFbxCamera::ECameraSamplingType >, KFbxTypedProperty< KFbxCamera::ECameraAntialiasingMethod >, KFbxTypedProperty< KFbxCamera::ECameraFocusDistanceSource >, KFbxTypedProperty< KFbxCamera::ECameraProjectionType >, KFbxTypedProperty< KFbxTexture::EBlendMode >, KFbxTypedProperty< KFbxControlSet::EType >, KFbxTypedProperty< double >, KFbxTypedProperty< KFbxTexture::EUnifiedMappingType >, KFbxTypedProperty< KFbxTexture::ETextureUse6 >, KFbxTypedProperty< fbxReference >, KFbxTypedProperty< kCharacterHipsTranslationMode >, KFbxTypedProperty< kCharacterFootContactType >, KFbxTypedProperty< KFbxCamera::ECameraFrontBackPlaneDisplayMode >, KFbxTypedProperty< KFbxCamera::ECameraApertureFormat >, KFbxTypedProperty< int >, KFbxTypedProperty< KFbxCameraStereo::ECameraStereo >, KFbxTypedProperty< kCharacterOffAutoUser >, KFbxTypedProperty< KFbxCamera::ECameraFrontBackPlaneDistanceMode >, KFbxTypedProperty< KFbxCamera::ECameraGateFit >, KFbxTypedProperty< KFbxCamera::ECameraApertureMode >, KFbxTypedProperty< KFbxXMatrix >, KFbxTypedProperty< kCharacterContactBehaviour >, KFbxTypedProperty< KFbxLight::EDecayType >, KFbxTypedProperty< kCharacterRollExtractionMode >, KFbxTypedProperty< KFbxCamera::ECameraFilmRollOrder >, KFbxTypedProperty< fbxVectorTemplate2 >, KFbxTypedProperty< KFbxCamera::ECameraFormat >, KFbxTypedProperty< KFbxCamera::ECameraSafeAreaStyle >, KFbxTypedProperty< KFbxTexture::EWrapMode >, KFbxTypedProperty< fbxVectorTemplate3 >, KFbxTypedProperty< ERotationOrder >, KFbxTypedProperty< KFbxLight::ELightType >, KFbxTypedProperty< bool >, KFbxTypedProperty< ETransformInheritType >, KFbxTypedProperty< kCharacterFloorPivot >, KFbxTypedProperty< fbxDateTime >, KFbxTypedProperty< KFbxCamera::ECameraAspectRatioMode >, KFbxTypedProperty< KString >, KFbxTypedProperty< kCharacterAutoUser >, KFbxTypedProperty< kCharacterPosture >, and KFbxTypedProperty< KFbxMarker::ELook >.

Definition at line 422 of file kfbxproperty.h.

bool Get ( void *  pValue,
EFbxType  pValueType,
KFbxEvaluationInfo *  pEvaluateInfo  
) const

Evaluates the KFCurve value of the property at the specific time, then returns the value of the property .

Parameters:
pValue  Pointer to the value.
pValueType  The data type of the value.
pEvaluateInfo  Contains the time of evaluation.
Returns:
True if type is compatible and value is returned successfully.
Remarks:
When evaluated, the property value is set as the KFCurve value.

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

bool SetValueInheritType ( KFbxInheritType  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.

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

Sets a minimum property value limit.

Parameters:
pMin  Minimum value allowed.

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.

double GetMinLimit (  )  const

Returns the minimum property value limit.

Returns:
The minimum value limit.

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.

void SetMaxLimit ( double  pMax  ) 

Sets a maximum property value limit.

Parameters:
pMax  Maximum value allowed.

double GetMaxLimit (  )  const

Returns the maximum property value.

Returns:
The maximum value limit.

void SetLimits ( double  pMin,
double  pMax  
)

Sets the minimum and maximum value limit of the property.

Parameters:
pMin  Minimum value allowed.
pMax  Maximum value allowed.

int AddEnumValue ( char const *  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.
Remarks:
This function is only valid if the property type is eENUM. Empty strings are not allowed.

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

int GetEnumCount (  ) 

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  
)

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  ) 

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.

char* GetEnumValue ( int  pIndex  ) 

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.

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

bool IsChildOf ( KFbxProperty const &  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 575 of file kfbxproperty.h.

bool IsDescendentOf ( KFbxProperty const &  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 581 of file kfbxproperty.h.

KFbxProperty GetParent (  )  const [inline]

Returns the parent property of this property.

Returns:
The parent of this property.

Definition at line 586 of file kfbxproperty.h.

bool SetParent ( const KFbxProperty &  pOther  ) 

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]

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

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

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

KFbxProperty GetNextDescendent ( KFbxProperty const &  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 613 of file kfbxproperty.h.

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

Definition at line 621 of file kfbxproperty.h.

Referenced by Create().

KFbxProperty Find ( char const *  pName,
KFbxDataType const &  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 KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 630 of file kfbxproperty.h.

References KFbxDataType::GetTypeInfoHandle().

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

Definition at line 638 of file kfbxproperty.h.

KFbxProperty FindHierarchical ( char const *  pName,
KFbxDataType const &  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 KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 647 of file kfbxproperty.h.

References KFbxDataType::GetTypeInfoHandle().

void BeginCreateOrFindProperty (  )  [inline]

Internal function for building a property name map.

Definition at line 656 of file kfbxproperty.h.

void EndCreateOrFindProperty (  )  [inline]

Internal function for clearing the property name map.

Definition at line 659 of file kfbxproperty.h.

bool SetArraySize ( int  pSize,
bool  pVariableArray  
)

Sets the array size(not implemented).

Parameters:
pSize 
pVariableArray 

int GetArraySize (  )  const

Returns the array size(not implemented).

KFbxProperty GetArrayItem ( int  pIndex  )  const

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

KFCurveNode* CreateKFCurveNode ( const char *  pTakeName = NULL  ) 

Creates a KFCurveNode on a take.

Parameters:
pTakeName  Name of the take to create the KFCurveNode on.

KFCurveNode* GetKFCurveNode ( bool  pCreateAsNeeded = false,
const char *  pTakeName = NULL  
)

Returns the KFCurveNode of the property from a take.

Parameters:
pTakeName  Name of the take from which to get the KFCurveNode.
pCreateAsNeeded  Creates a KFCurveNode if not found.
Returns:
Pointer to the KFCurveNode of the property on the given take.
Remarks:
The returned pointer is not persistent and should not be stored for later use.

KFCurve* GetKFCurve ( const char *  pChannel = NULL  ) 

Tries to get the KFCurve of the specified channel from the current take.

Parameters:
pChannel  Name of the KFCurve channel we are looking for.
Returns:
Pointer to the KFCurve of the specified channel if found, NULL in any other case.
Remarks:
This method fails if the KFCurveNode does not exist. If the pChannel is left NULL, this method retrieves the KFCurve directly from the KFCurveNode of the property, Otherwise it searches recursively to find the KFCurve of the specified channel.

KFCurve* GetKFCurve ( const char *  pChannel,
const char *  pTakeName  
)

Tries to get the KFCurve of the specified channel from the given take.

Parameters:
pChannel  Name of the KFCurve channel we are looking for.
pTakeName  Name of the take from which to get the KFCurve.
Returns:
Pointer to the KFCurve if found, NULL in any other case.
Remarks:
This method fails if the KFCurveNode does not exist. If pTakeName is NULL, this function searches in the current take. If the pChannel is left NULL, this method retrieves the KFCurve directly from the KFCurveNode of the property. Otherwise it searches recursively to find the KFCurve of the specified channel.

bool Evaluate ( KFbxEvaluationInfo const *  pEvaluationInfo  ) 

Evaluates the KFCurve value of this property at the specified time, then sets the property value as the KFCurve value.

Parameters:
pEvaluationInfo  Contains the time of evaluation.
Returns:
True on success, false otherwise.
Remarks:
When evaluated, the property value is set as the KFCurve value.

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

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.

Referenced by KFbxTypedProperty< fbxReference * >::Set().

bool IsConnectedSrcObject ( const KFbxObject *  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.

bool DisconnectSrcObject ( KFbxObject *  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.

bool DisconnectAllSrcObject (  ) 

Disconnects this property from all the source objects.

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

Referenced by KFbxTypedProperty< fbxReference * >::Set().

bool DisconnectAllSrcObject ( KFbxCriteria const &  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.

bool DisconnectAllSrcObject ( const kFbxClassId &  pClassId  ) 

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  
)

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

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

Returns:
The number of source objects with which this property connects.

Referenced by KFbxTypedProperty< fbxReference * >::Get().

int GetSrcObjectCount ( KFbxCriteria const &  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.

int GetSrcObjectCount ( const kFbxClassId &  pClassId  )  const

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

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

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.

Referenced by KFbxTypedProperty< fbxReference * >::Get().

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.

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

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

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

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

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

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

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]

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

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

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

int GetSrcObjectCount ( T const *  pFBX_TYPE  )  const [inline]

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

int GetSrcObjectCount ( T const *  pFBX_TYPE,
KFbxCriteria const &  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.

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

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

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

T* GetSrcObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
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.

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

T* FindSrcObject ( T const *  pFBX_TYPE,
const char *  pName,
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.

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

T* FindSrcObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
const char *  pName,
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.

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

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

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

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  ) 

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

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  ) 

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  ) 

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  
)

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

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

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

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

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

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

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

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

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

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

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

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

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]

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

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

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

int GetDstObjectCount ( T const *  pFBX_TYPE  )  const [inline]

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

int GetDstObjectCount ( T const *  pFBX_TYPE,
KFbxCriteria const &  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.

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

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

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

T* GetDstObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
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.

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

T* FindDstObject ( T const *  pFBX_TYPE,
const char *  pName,
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.

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

T* FindDstObject ( T const *  pFBX_TYPE,
KFbxCriteria const &  pCriteria,
const char *  pName,
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.

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

bool ConnectSrcProperty ( KFbxProperty const &  pProperty  ) 

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  ) 

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  ) 

Disconnects this property from the specified source property.

Parameters:
pProperty  The specified source property.
Returns:
True on success, false otherwise.

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.

KFbxProperty GetSrcProperty ( 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.

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.

Parameters:
pName  The specified property name.
pStartIndex  The start index.
Returns:
The source property with the specified name.

bool ConnectDstProperty ( KFbxProperty const &  pProperty  ) 

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  ) 

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  ) 

Disconnects this property from the specified destination property.

Parameters:
pProperty  The specified destination property.
Returns:
True on success, false otherwise.

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.

KFbxProperty GetDstProperty ( 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.

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.

Parameters:
pName  The specified property name.
pStartIndex  The start index.
Returns:
The destination property with the specified name.

void ClearConnectCache (  ) 

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

Member Data Documentation

const char* sHierarchicalSeparator [static]

Hierarchical separator of properties.

Definition at line 1225 of file kfbxproperty.h.

KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty
KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty KFbxProperty