#include<kfbxproperty.h>

Inherits FbxPropertyFlags.

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

Detailed Description

Class to hold user properties.

Definition at line58of filekfbxproperty.h.


Constructor and Destructor.
typedef FbxPropertyFlags::eFbxPropertyFlags	EFlags
staticKFbxProperty	Create(KFbxPropertyconst&pCompoundProperty, char const pName,KFbxDataTypeconst&pDataType=KFbxDataType(), char const pLabel="", bool pCheckForDuplicate=true, bool *pWasFound=NULL)
	Create a property.
template<typename T>
staticKFbxProperty	Create(KFbxPropertyconst&pParentProperty, char const *pName,KFbxDataTypeconst&pDataType, T const&pValue, eFbxPropertyFlags pFlags=eNO_FLAG, bool pCheckForDuplicate=true, bool pForceSet=true)
	Create a property.
staticKFbxProperty	Create(KFbxObjectpObject, char const pName,KFbxDataTypeconst&pDataType=KFbxDataType(), char const pLabel="", bool pCheckForDuplicate=true, bool pWasFound=NULL)
	Create a dynamic property.
staticKFbxProperty	Create(KFbxObject*pObject,KFbxProperty&pFromProperty, bool pCheckForDuplicate=true)
	Create a dynamic property from an other property.
staticKFbxProperty	Create(KFbxPropertyconst&pCompoundProperty,KFbxProperty&pFromProperty, bool pCheckForDuplicate=true)
	Create a dynamic property from an other property.
void	Destroy(bool pRecursive=true, bool pDependents=false)
	Destroy a dynamic property.
	KFbxProperty()
	Static Property Constructors.
	KFbxProperty(KFbxPropertyconst&pProperty)
	Copy constructor for properties.
	KFbxProperty(KFbxPropertyHandleconst&pProperty)
	Copy constructor for properties.
	~KFbxProperty()
	Static Property destructor.
Value management.
static bool	HasDefaultValue(KFbxProperty&pProperty)
	check if the given property value has changed from its default.
bool	IsValid() const
	Judge validity.
bool	Set(void const *pValue, EFbxType pValueType, bool pCheckForValueEquality)
	set value function
bool	Set(void const *pValue, EFbxType pValueType)
	set value function
bool	Get(void *pValue, EFbxType pValueType) const
	get value function
bool	Get(void pValue, EFbxType pValueType,KFbxEvaluationInfoconst pEvaluateInfo)
	get and evaluate pulls on a value
template<class T>
bool	Set(T const&pValue)
	set value function
template<class T>
T	Get(T const *pFBX_TYPE) const
	get value function
template<class T>
T	Get(T const pFBX_TYPE,KFbxEvaluationInfoconst pEvaluateInfo)
	get value function
template<class T>
T	Get(KFbxEvaluationInfoconst *pEvaluateInfo)
	get value function
bool	Get(void pValue, EFbxType pValueType,KFbxEvaluationInfopEvaluateInfo) const
	get and evaluate pulls on a value
KFbxInheritType	GetValueInheritType() const
	Query the inheritance type of the property.
bool	SetValueInheritType(KFbxInheritType pType)
	Set 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
	Get the property data type definition.
KString	GetName() const
	Get the property internal name.
KString	GetHierarchicalName() const
	Get the property internal name.
KString	GetLabel(bool pReturnNameIfEmpty=true)
	Get the property label.
void	SetLabel(KStringpLabel)
	Set a label to the property.
KFbxObject*	GetFbxObject() const
	Get the object that contains the property.
User data
void	SetUserTag(int pTag)
int	GetUserTag()
void	SetUserDataPtr(void *pUserData)
void *	GetUserDataPtr()
Property Flags.
void	ModifyFlag(eFbxPropertyFlags pFlag, bool pValue)
	Change the attributes of the property.
bool	GetFlag(eFbxPropertyFlags pFlag)
	Get the property attribute state.
KFbxInheritType	GetFlagInheritType(eFbxPropertyFlags pFlag) const
	Gets the inheritance type for the given flag.
bool	SetFlagInheritType(eFbxPropertyFlags pFlag, KFbxInheritType pType)
	Sets the inheritance type for the given flag.
bool	ModifiedFlag(eFbxPropertyFlags pFlag) const
	Checks if the property's flag has been modified from its default value.
Assignment and comparison operators
KFbxProperty&	operator=(KFbxPropertyconst&pKProperty)
bool	operator==(KFbxPropertyconst&pKProperty) const
bool	operator!=(KFbxPropertyconst&pKProperty) const
bool	operator==(int pValue) const
bool	operator!=(int pValue) const
bool	CompareValue(KFbxPropertyconst&pProp) const
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 that 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.
void	SetMinLimit(double pMin)
	Set the minimum limit value of the property.
bool	HasMinLimit() const
	Returns whether a limit exists; callingGetMinLimit()when this returns false will return in undefined behavior.
double	GetMinLimit() const
	Get the minimum limit value of the property.
bool	HasMaxLimit() const
	Returns whether a limit exists; callingGetMinLimit()when this returns false will return in undefined behavior.
void	SetMaxLimit(double pMax)
	Set the maximum limit value of the property.
double	GetMaxLimit() const
	Get the maximum limit value of the property.
void	SetLimits(double pMin, double pMax)
	Set the minimum and maximum limit value of the property.
Enum and property list
int	AddEnumValue(char const *pStringValue)
	Add a string value at the end of the list.
void	InsertEnumValue(int pIndex, char const *pStringValue)
	Insert a string value at the specified index.
int	GetEnumCount()
	Get the number of elements in the list.
void	SetEnumValue(int pIndex, char const *pStringValue)
	Set a string value for the specified index.
void	RemoveEnumValue(int pIndex)
	Remove the string value at the specified index.
char *	GetEnumValue(int pIndex)
	Get a string value for the specified index.
Hierarchical properties
bool	IsRoot() const
bool	IsChildOf(KFbxPropertyconst&pParent) const
bool	IsDescendentOf(KFbxPropertyconst&pAncestor) const
KFbxProperty	GetParent() const
bool	SetParent(constKFbxProperty&pOther)
KFbxProperty	GetChild() const
KFbxProperty	GetSibling() const
KFbxProperty	GetFirstDescendent() const
	Get the first property that is a descendent to this property.
KFbxProperty	GetNextDescendent(KFbxPropertyconst&pProperty) const
	Get the next property following pProperty that is a descendent to this property.
KFbxProperty	Find(char const *pName, bool pCaseSensitive=true) const
	Find a property using its name and its data type.
KFbxProperty	Find(char const *pName,KFbxDataTypeconst&pDataType, bool pCaseSensitive=true) const
KFbxProperty	FindHierarchical(char const *pName, bool pCaseSensitive=true) const
	Fullname find.
KFbxProperty	FindHierarchical(char const *pName,KFbxDataTypeconst&pDataType, bool pCaseSensitive=true) const
Optimizations
void	BeginCreateOrFindProperty()
void	EndCreateOrFindProperty()
Array Management
bool	SetArraySize(int pSize, bool pVariableArray)
int	GetArraySize() const
KFbxProperty	GetArrayItem(int pIndex) const
KFbxProperty	operator[](int pIndex) const
FCurve Management
KFCurveNode*	CreateKFCurveNode(const char *pTakeName=NULL)
	Create aKFCurveNodeon a take.
KFCurveNode*	GetKFCurveNode(bool pCreateAsNeeded=false, const char *pTakeName=NULL)
	Get theKFCurveNodefrom a take.
KFCurve*	GetKFCurve(const char *pChannel=NULL)
	Tries to get theKFCurveof the specified channel from the current take.
KFCurve*	GetKFCurve(const char pChannel, const char pTakeName)
	Tries to get theKFCurveof the specified channel from the given take.
Evaluation management
bool	Evaluate(KFbxEvaluationInfoconst *pEvaluationInfo)
General Object Connection and Relationship Management
bool	ConnectSrcObject(KFbxObject*pObject, kFbxConnectionType pType=eFbxConnectionNone)
bool	IsConnectedSrcObject(constKFbxObject*pObject) const
bool	DisconnectSrcObject(KFbxObject*pObject)
bool	DisconnectAllSrcObject()
bool	DisconnectAllSrcObject(KFbxCriteriaconst&pCriteria)
bool	DisconnectAllSrcObject(constkFbxClassId&pClassId)
bool	DisconnectAllSrcObject(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria)
int	GetSrcObjectCount() const
int	GetSrcObjectCount(KFbxCriteriaconst&pCriteria) const
int	GetSrcObjectCount(constkFbxClassId&pClassId) const
int	GetSrcObjectCount(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria) const
KFbxObject*	GetSrcObject(int pIndex=0) const
KFbxObject*	GetSrcObject(KFbxCriteriaconst&pCriteria, int pIndex=0) const
KFbxObject*	GetSrcObject(constkFbxClassId&pClassId, int pIndex=0) const
KFbxObject*	GetSrcObject(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria, int pIndex=0) const
KFbxObject*	FindSrcObject(const char *pName, int pStartIndex=0) const
KFbxObject*	FindSrcObject(KFbxCriteriaconst&pCriteria, const char *pName, int pStartIndex=0) const
KFbxObject*	FindSrcObject(constkFbxClassId&pClassId, const char *pName, int pStartIndex=0) const
KFbxObject*	FindSrcObject(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria, const char *pName, int pStartIndex=0) const
template<class T>
bool	DisconnectAllSrcObject(T const *pFBX_TYPE)
template<class T>
bool	DisconnectAllSrcObject(T const *pFBX_TYPE,KFbxCriteriaconst&pCriteria)
template<class T>
int	GetSrcObjectCount(T const *pFBX_TYPE) const
template<class T>
int	GetSrcObjectCount(T const *pFBX_TYPE,KFbxCriteriaconst&pCriteria) const
template<class T>
T *	GetSrcObject(T const *pFBX_TYPE, int pIndex=0) const
template<class T>
T *	GetSrcObject(T const *pFBX_TYPE,KFbxCriteriaconst&pCriteria, int pIndex=0) const
template<class T>
T *	FindSrcObject(T const pFBX_TYPE, const char pName, int pStartIndex=0) const
template<class T>
T *	FindSrcObject(T const pFBX_TYPE,KFbxCriteriaconst&pCriteria, const char pName, int pStartIndex=0) const
bool	ConnectDstObject(KFbxObject*pObject, kFbxConnectionType pType=eFbxConnectionNone)
bool	IsConnectedDstObject(constKFbxObject*pObject) const
bool	DisconnectDstObject(KFbxObject*pObject)
bool	DisconnectAllDstObject()
bool	DisconnectAllDstObject(KFbxCriteriaconst&pCriteria)
bool	DisconnectAllDstObject(constkFbxClassId&pClassId)
bool	DisconnectAllDstObject(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria)
int	GetDstObjectCount() const
int	GetDstObjectCount(KFbxCriteriaconst&pCriteria) const
int	GetDstObjectCount(constkFbxClassId&pClassId) const
int	GetDstObjectCount(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria) const
KFbxObject*	GetDstObject(int pIndex=0) const
KFbxObject*	GetDstObject(KFbxCriteriaconst&pCriteria, int pIndex=0) const
KFbxObject*	GetDstObject(constkFbxClassId&pClassId, int pIndex=0) const
KFbxObject*	GetDstObject(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria, int pIndex=0) const
KFbxObject*	FindDstObject(const char *pName, int pStartIndex=0) const
KFbxObject*	FindDstObject(KFbxCriteriaconst&pCriteria, const char *pName, int pStartIndex=0) const
KFbxObject*	FindDstObject(constkFbxClassId&pClassId, const char *pName, int pStartIndex=0) const
KFbxObject*	FindDstObject(constkFbxClassId&pClassId,KFbxCriteriaconst&pCriteria, const char *pName, int pStartIndex=0) const
template<class T>
bool	DisconnectAllDstObject(T const *pFBX_TYPE)
template<class T>
bool	DisconnectAllDstObject(T const *pFBX_TYPE,KFbxCriteriaconst&pCriteria)
template<class T>
int	GetDstObjectCount(T const *pFBX_TYPE) const
template<class T>
int	GetDstObjectCount(T const *pFBX_TYPE,KFbxCriteriaconst&pCriteria) const
template<class T>
T *	GetDstObject(T const *pFBX_TYPE, int pIndex=0) const
template<class T>
T *	GetDstObject(T const *pFBX_TYPE,KFbxCriteriaconst&pCriteria, int pIndex=0) const
template<class T>
T *	FindDstObject(T const pFBX_TYPE, const char pName, int pStartIndex=0) const
template<class T>
T *	FindDstObject(T const pFBX_TYPE,KFbxCriteriaconst&pCriteria, const char pName, int pStartIndex=0) const
General Property Connection and Relationship Management
bool	ConnectSrcProperty(KFbxPropertyconst&pProperty)
bool	IsConnectedSrcProperty(KFbxPropertyconst&pProperty)
bool	DisconnectSrcProperty(KFbxPropertyconst&pProperty)
int	GetSrcPropertyCount() const
KFbxProperty	GetSrcProperty(int pIndex=0) const
KFbxProperty	FindSrcProperty(const char *pName, int pStartIndex=0) const
bool	ConnectDstProperty(KFbxPropertyconst&pProperty)
bool	IsConnectedDstProperty(KFbxPropertyconst&pProperty)
bool	DisconnectDstProperty(KFbxPropertyconst&pProperty)
int	GetDstPropertyCount() const
KFbxProperty	GetDstProperty(int pIndex=0) const
KFbxProperty	FindDstProperty(const char *pName, int pStartIndex=0) const
void	ClearConnectCache()
Public Member Functions
bool	CopyValue(KFbxPropertyconst&pProp)
	Copy value of a property.

Constructor&Destructor Documentation

KFbxProperty ( )

Static Property Constructors.

KFbxProperty ( KFbxPropertyconst& pProperty )

Copy constructor for properties.

Parameters:

pProperty

KFbxProperty ( KFbxPropertyHandleconst& pProperty )

Copy constructor for properties.

Parameters:

pProperty

~KFbxProperty ( )

Static Property destructor.

Member Function Documentation

staticKFbxPropertyCreate	(	KFbxPropertyconst&	pCompoundProperty,
		char const *	pName,
		KFbxDataTypeconst&	pDataType=`KFbxDataType()`,
		char const *	pLabel=`""`,
		bool	pCheckForDuplicate=`true`,
		bool *	pWasFound=`NULL`
	)			`[static]`

Create a property.

Parameters:

	pCompoundProperty
	pName
	pDataType
	pLabel
	pCheckForDuplicate
	pWasFound

staticKFbxPropertyCreate	(	KFbxPropertyconst&	pParentProperty,
		char const *	pName,
		KFbxDataTypeconst&	pDataType,
		T const&	pValue,
		eFbxPropertyFlags	pFlags=`eNO_FLAG`,
		bool	pCheckForDuplicate=`true`,
		bool	pForceSet=`true`
	)			`[inline, static]`

Create a property.

Parameters:

	pParentProperty
	pName
	pDataType
	pValue
	pFlags
	pCheckForDuplicate
	pForceSet

Definition at line104of filekfbxproperty.h.

ReferencesFind(),IsValid(),ModifyFlag(), andSet().

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

Create a dynamic property.

Parameters:

	pObject
	pName
	pDataType
	pLabel
	pCheckForDuplicate
	pWasFound

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

Create a dynamic property from an other property.

Parameters:

	pObject
	pFromProperty
	pCheckForDuplicate

staticKFbxPropertyCreate	(	KFbxPropertyconst&	pCompoundProperty,
		KFbxProperty&	pFromProperty,
		bool	pCheckForDuplicate=`true`
	)			`[static]`

Create a dynamic property from an other property.

Parameters:

	pCompoundProperty
	pFromProperty
	pCheckForDuplicate

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

Destroy a dynamic property.

Parameters:

	pRecursive
	pDependents

KFbxDataTypeGetPropertyDataType ( ) const

Get the property data type definition.

Returns:: The propertiesKFbxDataType

Referenced byKFbxStreamOptions::SetOption().

KStringGetName ( ) const

Get the property internal name.

Returns:: Property internal name string.

KStringGetHierarchicalName ( ) const

Get the property internal name.

Returns:: Property internal name string.

KStringGetLabel ( bool pReturnNameIfEmpty=true )

Get the property label.

Parameters:

pReturnNameIfEmpty Iftrue, allow this method to return the internal name.

Returns:: The property label if set, or the property internal name if the pReturnNameIfEmpty flag is set totrueand the label has not been defined.

Remarks:: Some applications may choose to 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 exist while the property object is in memory.

void SetLabel ( KString pLabel )

Set a label to the property.

Parameters:

pLabel

Label string.

KFbxObject* GetFbxObject ( ) const

Get the object that contains the property.

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

void ModifyFlag	(	eFbxPropertyFlags	pFlag,
		bool	pValue
	)

Change the attributes of the property.

Parameters:

	pFlag	Property attribute identifier.
	pValue	New state.

Referenced byCreate().

bool GetFlag ( eFbxPropertyFlags pFlag )

Get the property attribute state.

Parameters:

pFlag

Property attribute identifier.

Returns:: The currently set property attribute state.

KFbxInheritType GetFlagInheritType ( eFbxPropertyFlags pFlag ) const

Gets the inheritance type for the given flag.

Similar toGetValueInheritType().

Parameters:

pFlag

The flag to query

Returns:: The inheritance type of the given flag

bool SetFlagInheritType	(	eFbxPropertyFlags	pFlag,
		KFbxInheritType	pType
	)

Sets the inheritance type for the given flag.

Similar toSetValueInheritType().

Parameters:

	pFlag	The flag to set
	pType	The inheritance type to set

Returns:: true on success, false otherwise.

bool ModifiedFlag ( eFbxPropertyFlags pFlag ) const

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

Parameters:

pFlag

The flag to query

Returns:: true if the value of this property has changed, false otherwise

bool CopyValue ( KFbxPropertyconst& pProp )

Copy value of a property.

Parameters:

pProp

Property to get value from.

Returns:: true if value has been copied, false if not.

bool IsValid ( ) const

Judge validity.

Referenced byCreate(), andKFbxStreamOptions::SetOption().

static bool HasDefaultValue ( KFbxProperty& pProperty ) [static]

check if the given property value has changed from its default.

Parameters:

pProperty

Property object that is tested.

Returns:: true if the the property value is still the default one.

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

set value function

Parameters:

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

Returns:: true if it was succesfull and type were compatible.

Referenced byCreate(),KFbxStreamOptionsDxfReader::SetCreateRootNode(),KFbxStreamOptionsMotionWriter::SetFrameCount(),KFbxStreamOptionsMotionReader::SetFrameCount(),KFbxStreamOptions::SetOption(),KFbxStreamOptionsMotionWriter::SetStart(),KFbxStreamOptionsMotionReader::SetStart(), andKFbxStreamOptionsDxfReader::SetWeldVertices().

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

set value function

Parameters:

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

Returns:: true if it was succesfull and type were compatible.

Definition at line318of filekfbxproperty.h.

bool Get	(	void *	pValue,
		EFbxType	pValueType
	)			const

get value function

Parameters:

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

Returns:: true if it was succesfull and type were compatible.

bool Get	(	void *	pValue,
		EFbxType	pValueType,
		KFbxEvaluationInfoconst *	pEvaluateInfo
	)

get and evaluate pulls on a value

Parameters:

	pValue	Pointer to the value.
	pValueType	The data type of the value.
	pEvaluateInfo	The evaluation information.

Returns:: true if it was succesfull and type were compatible.

bool Set ( T const& pValue ) [inline]

set value function

Parameters:

pValue

Pointer to the new value

Returns:: true if it was succesfull and type were compatible.

Definition at line339of filekfbxproperty.h.

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

get value function

Parameters:

pFBX_TYPE

The data type of the value.

Returns:: The value in a temporary variable.

Definition at line345of filekfbxproperty.h.

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

get value function

Parameters:

	pFBX_TYPE	The data type of the value.
	pEvaluateInfo	The evaluation information.

Returns:: The value in a temporary variable.

Definition at line352of filekfbxproperty.h.

T Get ( KFbxEvaluationInfoconst * pEvaluateInfo ) [inline]

get value function

Parameters:

pEvaluateInfo

The evaluation information.

Returns:: The value in a temporary variable.

Definition at line358of filekfbxproperty.h.

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

get and evaluate pulls on a value

Parameters:

	pValue	Pointer to the value.
	pValueType	The data type of the value.
	pEvaluateInfo	The evaluation information.

Returns:: true if it was succesfull and type were compatible.

KFbxInheritType GetValueInheritType ( ) const

Query the inheritance type of the property.

Use this method to determine if this property's value is overriden 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 )

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

It can also be used 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 this property has changed, false otherwise

void SetMinLimit ( double pMin )

Set the minimum limit value of the property.

Parameters:

pMin

Minimum value allowed.

bool HasMinLimit ( ) const

Returns whether a limit exists; callingGetMinLimit()when this returns false will return in undefined behavior.

Returns:: Whether or not a minimum limit has been set.

double GetMinLimit ( ) const

Get the minimum limit value of the property.

Returns:: Currently set minimum limit value.

bool HasMaxLimit ( ) const

Returns whether a limit exists; callingGetMinLimit()when this returns false will return in undefined behavior.

Returns:: Whether or not a minimum limit has been set.

void SetMaxLimit ( double pMax )

Set the maximum limit value of the property.

Parameters:

pMax

Maximum value allowed.

double GetMaxLimit ( ) const

Get the maximum limit value of the property.

Returns:: Currently set maximum limit value.

void SetLimits	(	double	pMin,
		double	pMax
	)

Set the minimum and maximum limit value of the property.

Parameters:

	pMin	Minimum value allowed.
	pMax	Maximum value allowed.

int AddEnumValue ( char const * pStringValue )

Add a string value at the end of the list.

Parameters:

pStringValue

Value of the string to be added.

Returns:: The index in the list where the string was added.

Remarks:: This function is only valid when the property type is eENUM. Empty strings are not allowed.

void InsertEnumValue	(	int	pIndex,
		char const *	pStringValue
	)

Insert a string value at the specified index.

Parameters:

	pIndex	Zero bound index.
	pStringValue	Value of the string for the specified index.

Remarks:: This function is only valid when the property type is eENUM. pIndex must be in the range [0, ListValueGetCount()]. Empty strings are not allowed.

int GetEnumCount ( )

Get the number of elements in the list.

Returns:: The number of elements in the list.

Remarks:: This function will return -1 if the property type is not eENUM.

void SetEnumValue	(	int	pIndex,
		char const *	pStringValue
	)

Set a string value for the specified index.

Parameters:

	pIndex	Zero bound index.
	pStringValue	Value of the string for the specified index.

Remarks:: This function is only valid when the property type is eENUM. The function will assign the specified string to the specified index. A string value must exists at the specified index in order to be changed. Empty strings are not allowed.

void RemoveEnumValue ( int pIndex )

Remove the string value at the specified index.

Parameters:

pIndex

of the string value to be removed.

char* GetEnumValue ( int pIndex )

Get a string value for the specified index.

Parameters:

pIndex

Zero bound index.

Remarks:: This function is only valid when the property type is eENUM.

KFbxPropertyGetFirstDescendent ( ) const[inline]

Get the first property that is a descendent to this property.

Returns:: A validKFbxPropertyif the property was found, else an invalidKFbxProperty. SeeKFbxProperty::IsValid()

Definition at line507of filekfbxproperty.h.

KFbxPropertyGetNextDescendent ( KFbxPropertyconst& pProperty ) const[inline]

Get the next property following pProperty that is a descendent to this property.

Parameters:

pProperty

The last found descendent.

Returns:: A validKFbxPropertyif the property was found, else an invalidKFbxProperty. SeeKFbxProperty::IsValid()

Definition at line513of filekfbxproperty.h.

KFbxPropertyFind	(	char const *	pName,
		bool	pCaseSensitive=`true`
	)			const`[inline]`

Find a property using its name and its data type.

Parameters:

	pCaseSensitive
	pName	The name of the property as a`NULL`terminated string.

Returns:: A validKFbxPropertyif the property was found, else an invalidKFbxProperty. SeeKFbxProperty::IsValid()

Definition at line521of filekfbxproperty.h.

Referenced byCreate().

KFbxPropertyFindHierarchical	(	char const *	pName,
		bool	pCaseSensitive=`true`
	)			const`[inline]`

Fullname find.

Parameters:

	pCaseSensitive
	pName	The name of the property as a`NULL`terminated string.

Returns:: A validKFbxPropertyif the property was found, else an invalidKFbxProperty. SeeKFbxProperty::IsValid()

Definition at line529of filekfbxproperty.h.

KFCurveNode* CreateKFCurveNode ( const char * pTakeName=NULL )

Create aKFCurveNodeon a take.

Parameters:

pTakeName

Name of the take to create theKFCurveNodeon

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

Get theKFCurveNodefrom a take.

Parameters:

	pTakeName	Name of the take to get theKFCurveNodefrom
	pCreateAsNeeded	Create theKFCurveNodeif not found.

Returns:: Pointer to theKFCurveNodeof the proprety on the given take.

KFCurve* GetKFCurve ( const char * pChannel=NULL )

Tries to get theKFCurveof the specified channel from the current take.

Parameters:

pChannel

Name of the fcurve channel we are looking for.

Returns:: Pointer to the FCurve if found, NULL in any other case.

Remarks:: This method will fail if theKFCurveNodedoes not exist.
If the pChannel is left NULL, this method retrieve the FCurve directly from theKFCurveNodeotherwise it will look recursively to find it.

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

Tries to get theKFCurveof the specified channel from the given take.

Parameters:

	pChannel	Name of the fcurve channel we are looking for.
	pTakeName	Name of the take to get theKFCurvefrom.

Returns:: Pointer to the FCurve if found, NULL in any other case.

Remarks:

This method will fail if theKFCurveNodedoes not exist.

If pTakeName is NULL, this function will look in the current take.

If the pChannel is left NULL, this method retrieve the FCurve directly from theKFCurveNodeotherwise it will look recursively to find it.

Detailed Description

Constructor and Destructor.

Value management.

Property Identification.

User data

Property Flags.

Assignment and comparison operators

Property Limits.

Enum and property list

Hierarchical properties

Optimizations

Array Management

FCurve Management

Evaluation management

General Object Connection and Relationship Management

General Property Connection and Relationship Management

Public Member Functions

Constructor&Destructor Documentation

Member Function Documentation