#include <fbxpropertyhandle.h>

Class Description

Class to manage property handle.

Definition at line 29 of file fbxpropertyhandle.h.

Public Member Functions
Assignment and basic info
FbxPropertyHandle &	operator= (const FbxPropertyHandle &pHandle)
	FbxPropertyHandle assignment operator. More...

bool	operator== (const FbxPropertyHandle &pHandle) const
	Equality operator. More...

bool	operator!= (const FbxPropertyHandle &pHandle) const
	Inequality operator. More...

bool	operator< (const FbxPropertyHandle &pHandle) const
	Lesser operator, used to sort property handle in map. More...

bool	operator> (const FbxPropertyHandle &pHandle) const
	Greater operator, used to sort property handle in map. More...

bool	Is (const FbxPropertyHandle &pHandle) const
	Compare type info together. More...

bool	Valid () const
	Judge validity. More...

const char *	GetName () const
	Get the property name. More...

const char *	GetLabel () const
	Get the property label. More...

bool	SetLabel (const char *pLabel)
	Set a label to the property. More...

EFbxType	GetType () const
	Get the property type. More...

FbxPropertyHandle	GetTypeInfo () const
	Get the property type info. More...

FbxPropertyFlags::EFlags	GetFlags () const
	Get the property attribute state. More...

FbxPropertyFlags::EInheritType	GetFlagsInheritType (FbxPropertyFlags::EFlags pFlags, bool pCheckReferences) const
	Gets the inheritance type for the given flag. More...

bool	ModifyFlags (FbxPropertyFlags::EFlags pFlags, bool pValue)
	According the given parameter Change the attributes of the property. More...

bool	SetFlagsInheritType (FbxPropertyFlags::EFlags pFlags, FbxPropertyFlags::EInheritType pType)
	Sets the inheritance type for the given flag. More...

void *	GetUserData () const
	Get the property user data. More...

bool	SetUserData (const void *pUserData)
	Set user data to the property. More...

int	GetUserTag () const
	Get the property user tag. More...

bool	SetUserTag (int pUserData)
	Set user tag to the property. More...

Enum management
int	AddEnumValue (const char *pStringValue)
	Add new value at the end of the enum list in the property. More...

void	InsertEnumValue (int pIndex, const char *pStringValue)
	Insert new value at the given index of the enum list in property. More...

int	GetEnumCount ()
	Get the enum count of enum list in property. More...

void	SetEnumValue (int pIndex, const char *pStringValue)
	Set value at the given index of the enum list in the property. More...

void	RemoveEnumValue (int pIndex)
	Remove the value at the index of the enum list in the property. More...

char *	GetEnumValue (int pIndex)
	Get the value at the index of enum list in the property. More...

Child and Struct management
void	BeginCreateOrFindProperty ()
	Create the map for find property in the property page. More...

void	EndCreateOrFindProperty ()
	Clear the map which created for find property. More...

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

bool	IsChildOf (const FbxPropertyHandle &pParent) const
	Judge if the property is the child property of the given parent property. More...

bool	IsDescendentOf (const FbxPropertyHandle &pParent) const
	Judge if the property is descendent property of the given property. More...

bool	SetParent (const FbxPropertyHandle &pOther)
	Set parent property handle.No matter what enters,the result is always false. More...

FbxPropertyHandle	Add (const char *pName, const FbxPropertyHandle &pTypeInfo)
	Add a property to the property page. More...

FbxPropertyHandle	GetParent () const
	Get parent property. More...

FbxPropertyHandle	GetChild () const
	Get child property. More...

FbxPropertyHandle	GetSibling () const
	Get sibling property. More...

FbxPropertyHandle	GetFirstDescendent () const
	Get first descendent property. More...

FbxPropertyHandle	GetNextDescendent (const FbxPropertyHandle &pHandle) const
	Get first descendent property which after the given property. More...

FbxPropertyHandle	Find (const char *pName, bool pCaseSensitive) const
	Find the property with given name. More...

FbxPropertyHandle	Find (const char *pName, const FbxPropertyHandle &pTypeInfo, bool pCaseSensitive) const
	Find the property with given name and type info. More...

FbxPropertyHandle	Find (const char pName, const char pChildrenSeparator, bool pCaseSensitive) const
	Separate the given name by children separator string and then find the property.The step is strip the first part of the name and search, if the property can be found, strip the second part of the name and continue search, until no property be found,then return the last found property. More...

FbxPropertyHandle	Find (const char pName, const char pChildrenSeparator, const FbxPropertyHandle &pTypeInfo, bool pCaseSensitive) const
	Separate the given name by children separator string and then find the property.The step is strip the first part of the name and search, if the property can be found, strip the second part of the name and continue search, until no property be found,then return the last found property. More...

Connection management
bool	ConnectSrc (const FbxPropertyHandle &pSrc, const FbxConnection::EType pType=FbxConnection::eDefault)
	Connect source property. More...

int	GetSrcCount (FbxConnectionPointFilter *pFilter=0) const
	Get source properties' count. More...

FbxPropertyHandle	GetSrc (FbxConnectionPointFilter *pFilter=0, int pIndex=0) const
	Get source property with the given index. More...

bool	DisconnectSrc (const FbxPropertyHandle &pSrc)
	Disconnect source property. More...

bool	IsConnectedSrc (const FbxPropertyHandle &pSrc)
	Judge if it is connected with the given source property. More...

bool	ConnectDst (const FbxPropertyHandle &pDst, const FbxConnection::EType pType=FbxConnection::eDefault)
	Connect destination property. More...

int	GetDstCount (FbxConnectionPointFilter *pFilter=0) const
	Get destination properties' count. More...

FbxPropertyHandle	GetDst (FbxConnectionPointFilter *pFilter=0, int pIndex=0) const
	Get destination property with the given index. More...

bool	DisconnectDst (const FbxPropertyHandle &pDst)
	Disconnect destination property. More...

bool	IsConnectedDst (const FbxPropertyHandle &pDst)
	Judge if it is connected with the given destination property. More...

void	ClearConnectCache ()
	Clear connect cache. More...

void	WipeAllConnections ()
	Clear all connect without sending any notification (Internal use ONLY) More...

Limits Functions
Minimum and maximum value limits can be associated with properties, but FBX will not verify that these limits are respected. FBX however will store and retrieve limits from files, and will assure that they are persistent in memory while the property handle object exists. Soft minimums and maximums values are specifying a second set of limits that can be used for UI objects such as sliders. FBX will handle them the same way it does with the normal limits.
bool	HasMin () const
	Judge if this property has a minimum value. More...

bool	GetMin (void *pValue, EFbxType pValueType) const
	Get the minimum value and value type of this property. More...

bool	SetMin (const void *pValue, EFbxType pValueType)
	Set the minimum value and value type for this property. More...

template<class T >
bool	SetMin (const T &pValue)
	According the given value and its value type, set the minimum value and value type for this property. More...

template<class T >
T	GetMin (const T *pFBX_TYPE) const
	Get the minimum value of this property. More...

bool	HasSoftMin () const
	Judge if this property has soft minimum value. More...

bool	GetSoftMin (void *pValue, EFbxType pValueType) const
	Get the soft minimum value and value type of this property. More...

bool	SetSoftMin (const void *pValue, EFbxType pValueType)
	Set the soft minimum value and value type for this property. More...

template<class T >
bool	SetSoftMin (const T &pValue)
	According the given value and its value type, set the soft minimum value and value type for this property. More...

template<class T >
T	GetSoftMin (const T *pFBX_TYPE) const
	Get the soft minimum value of this property. More...

bool	HasMax () const
	Judge if this property has maximum value. More...

bool	GetMax (void *pValue, EFbxType pValueType) const
	Get the maximum value and value type of this property. More...

bool	SetMax (const void *pValue, EFbxType pValueType)
	Set the maximum value and value type for this property. More...

template<class T >
bool	SetMax (const T &pValue)
	According the given value and its value type, set the maximum value and value type for this property. More...

template<class T >
T	GetMax (const T *pFBX_TYPE) const
	Get the maximum value of this property. More...

bool	HasSoftMax () const
	Judge if this property has soft maximum value. More...

bool	GetSoftMax (void *pValue, EFbxType pValueType) const
	Get the soft maximum value and value type of this property. More...

bool	SetSoftMax (const void *pValue, EFbxType pValueType)
	Set the soft maximum value and value type for this property. More...

template<class T >
bool	SetSoftMax (const T &pValue)
	According the given value and its value type, set the soft maximum value and value type for this property. More...

template<class T >
T	GetSoftMax (const T *pFBX_TYPE) const
	Get the soft maximum value of this property. More...

Value
FbxPropertyFlags::EInheritType	GetValueInheritType (bool pCheckReferences) const
	Get value inherit type of this property. More...

bool	SetValueInheritType (FbxPropertyFlags::EInheritType pType)
	Set value inherit type for this property . More...

bool	GetDefaultValue (void *pValue, EFbxType pValueType) const
	Get default value and value type of this property . More...

bool	Get (void *pValue, EFbxType pValueType) const
	Get value and value type of this property . More...

bool	Set (const void *pValue, EFbxType pValueType, bool pCheckValueEquality)
	Set property value and value type for this property. More...

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

template<class T >
T	Get (const T *pFBX_TYPE) const
	get property value. More...

Page settings
void	SetPageDataPtr (void *pData)
	Set the property page data pointer. More...

void *	GetPageDataPtr () const
	Get property page data pointer. More...

Page Internal Entry Management
bool	PushPropertiesToParentInstance ()
	Push properties to parent instance. More...

Reference Management
bool	IsAReferenceTo (void) const
	Judge if this property page is a instance of other page. More...

void *	GetReferenceTo (void) const
	Get the property page which this property page make reference to. More...

bool	IsReferencedBy (void) const
	Judge if this property page is referenced by other pages. More...

int	GetReferencedByCount (void) const
	Get the count of property pages which make reference to this property page. More...

void *	GetReferencedBy (int pIndex) const
	According the given index,get the property page which make reference to this property page. More...

Constructor and Destructor
static FbxPropertyHandle	Create ()
	Create an instance. More...

static FbxPropertyHandle	Create (const FbxPropertyHandle &pInstanceOf)
	Create an instance with given instance. More...

static FbxPropertyHandle	Create (const char *pName, EFbxType pType=eFbxUndefined)
	Create an instance with given name and type. More...

static FbxPropertyHandle	Create (const char *pName, FbxPropertyHandle pTypeInfo)
	Create an instance with given name and type info. More...

bool	Destroy ()
	If this property is root property, delete the property page, otherwise delete the property. More...

	FbxPropertyHandle ()
	Default constructor. More...

	FbxPropertyHandle (const FbxPropertyHandle &pAddress)
	Copy constructor. More...

	~FbxPropertyHandle ()
	Destructor. More...

	FbxPropertyHandle (FbxPropertyPage *pPage, FbxInt pId=0)
	Character constructor. More...

Constructor & Destructor Documentation

◆ FbxPropertyHandle() [1/3]

FbxPropertyHandle ( )

Default constructor.

◆ FbxPropertyHandle() [2/3]

FbxPropertyHandle ( const FbxPropertyHandle & pAddress )

Copy constructor.

Parameters

pAddress FbxPropertyHandle copied to this one.

◆ ~FbxPropertyHandle()

~FbxPropertyHandle ( )

Destructor.

◆ FbxPropertyHandle() [3/3]

FbxPropertyHandle	(	FbxPropertyPage *	pPage,
		FbxInt	pId = `0`
	)

Character constructor.

Parameters

pPage
pId

Member Function Documentation

◆ Create() [1/4]

static FbxPropertyHandle Create ( )

static

Create an instance.

◆ Create() [2/4]

static FbxPropertyHandle Create ( const FbxPropertyHandle & pInstanceOf )

static

Create an instance with given instance.

Parameters

pInstanceOf The given instance.

◆ Create() [3/4]

static FbxPropertyHandle Create	(	const char *	pName,
		EFbxType	pType = `eFbxUndefined`
	)

static

Create an instance with given name and type.

Parameters

pName	Property name.
pType	Property type.

◆ Create() [4/4]

static FbxPropertyHandle Create	(	const char *	pName,
		FbxPropertyHandle	pTypeInfo
	)

static

Create an instance with given name and type info.

Parameters

pName
pTypeInfo

◆ Destroy()

bool Destroy ( )

If this property is root property, delete the property page, otherwise delete the property.

Returns: If succeed, return true.

◆ operator=()

FbxPropertyHandle& operator= ( const FbxPropertyHandle & pHandle )

FbxPropertyHandle assignment operator.

Parameters

pHandle FbxPropertyHandle assigned to this one.

◆ operator==()

bool operator== ( const FbxPropertyHandle & pHandle ) const

Equality operator.

Parameters

pHandle FbxPropertyHandle compared with this one.

Returns: True if equal, false otherwise.

◆ operator!=()

bool operator!= ( const FbxPropertyHandle & pHandle ) const

Inequality operator.

Parameters

pHandle FbxPropertyHandle compared with this one.

Returns: True if unequal, false otherwise.

◆ operator<()< h2="">

bool operator< ( const FbxPropertyHandle & pHandle ) const

Lesser operator, used to sort property handle in map.

Parameters

pHandle The property handle compared to this property handle.

Returns
`true` if less, `false` otherwise.

◆ operator>()

bool operator> ( const FbxPropertyHandle & pHandle ) const

Greater operator, used to sort property handle in map.

Parameters

pProperty The property handle compared to this property handle.

Returns: true if greater, false otherwise.

◆ Is()

bool Is ( const FbxPropertyHandle & pHandle ) const

Compare type info together.

Parameters

pHandle FbxPropertyHandle compared with this one.

Returns: True if equal, false otherwise.

◆ Valid()

bool Valid ( ) const

Judge validity.

◆ GetName()

const char* GetName ( ) const

Get the property name.

◆ GetLabel()

const char* GetLabel ( ) const

Get the property label.

◆ SetLabel()

bool SetLabel ( const char * pLabel )

Set a label to the property.

Parameters

pLabel The given label string

Returns: true if successful.

◆ GetType()

EFbxType GetType ( ) const

Get the property type.

◆ GetTypeInfo()

FbxPropertyHandle GetTypeInfo ( ) const

Get the property type info.

◆ GetFlags()

FbxPropertyFlags::EFlags GetFlags ( ) const

Get the property attribute state.

◆ GetFlagsInheritType()

FbxPropertyFlags::EInheritType GetFlagsInheritType	(	FbxPropertyFlags::EFlags	pFlags,
		bool	pCheckReferences
	)		const

Gets the inheritance type for the given flag.

Parameters

pFlags	The flag to query
pCheckReferences	Decide whether check instance. If it is true, check instance.

Returns: The inheritance type

◆ ModifyFlags()

bool ModifyFlags	(	FbxPropertyFlags::EFlags	pFlags,
		bool	pValue
	)

According the given parameter Change the attributes of the property.

Parameters

pFlags	The given flags used as mask.
pValue	If pValue is true, set mask with given flags, otherwise unset mask with given flags.

Returns: If succeed, return true.

◆ SetFlagsInheritType()

bool SetFlagsInheritType	(	FbxPropertyFlags::EFlags	pFlags,
		FbxPropertyFlags::EInheritType	pType
	)

Sets the inheritance type for the given flag.

Parameters

pFlags	The flag to set
pType	The inheritance type to set

Returns: If succeed, return true.

◆ GetUserData()

void* GetUserData ( ) const

Get the property user data.

◆ SetUserData()

bool SetUserData ( const void * pUserData )

Set user data to the property.

Parameters

pUserData The given user data

Returns: If succeed, return true.

◆ GetUserTag()

int GetUserTag ( ) const

Get the property user tag.

◆ SetUserTag()

bool SetUserTag ( int pUserData )

Set user tag to the property.

Parameters

pUserData The given user tag

Returns: If succeed, return true.

◆ AddEnumValue()

int AddEnumValue ( const char * pStringValue )

Add new value at the end of the enum list in the property.

Parameters

pStringValue The given new value

Returns: The index of the value.

◆ InsertEnumValue()

void InsertEnumValue	(	int	pIndex,
		const char *	pStringValue
	)

Insert new value at the given index of the enum list in property.

Parameters

pIndex	The given index
pStringValue	The given new value

◆ GetEnumCount()

int GetEnumCount ( )

Get the enum count of enum list in property.

Returns: The enum count of enum list in property

◆ SetEnumValue()

void SetEnumValue	(	int	pIndex,
		const char *	pStringValue
	)

Set value at the given index of the enum list in the property.

Parameters

pIndex	The given index
pStringValue	The given new value used to instead the old value.

◆ RemoveEnumValue()

void RemoveEnumValue ( int pIndex )

Remove the value at the index of the enum list in the property.

Parameters

pIndex The given index

◆ GetEnumValue()

char* GetEnumValue ( int pIndex )

Get the value at the index of enum list in the property.

Parameters

pIndex The given index

Returns: The value at the given index

◆ BeginCreateOrFindProperty()

void BeginCreateOrFindProperty ( )

Create the map for find property in the property page.

◆ EndCreateOrFindProperty()

void EndCreateOrFindProperty ( )

Clear the map which created for find property.

◆ IsRoot()

bool IsRoot ( ) const

inline

Judge if the property is the root property.

Returns: Return true if this property is root property.

Definition at line 209 of file fbxpropertyhandle.h.

209 { return ( mPage && mId == 0 ) ? true : false; }

◆ IsChildOf()

bool IsChildOf ( const FbxPropertyHandle & pParent ) const

Judge if the property is the child property of the given parent property.

Parameters

pParent The given parent property handle

Returns: Return true if this property is child of given property.

◆ IsDescendentOf()

bool IsDescendentOf ( const FbxPropertyHandle & pParent ) const

Judge if the property is descendent property of the given property.

Parameters

pParent The given parent property handle

Returns: Return true if this property is descendant of given property.

◆ SetParent()

bool SetParent ( const FbxPropertyHandle & pOther )

Set parent property handle.No matter what enters,the result is always false.

Parameters

pOther

Returns: False

◆ Add()

FbxPropertyHandle Add	(	const char *	pName,
		const FbxPropertyHandle &	pTypeInfo
	)

Add a property to the property page.

Parameters

pName	The name of property.
pTypeInfo	The added property's type info.

Returns: The handle of the new added property

◆ GetParent()

FbxPropertyHandle GetParent ( ) const

Get parent property.

Returns: If the parent property exists, return the property handle,otherwise return -1.

◆ GetChild()

FbxPropertyHandle GetChild ( ) const

Get child property.

Returns: If the child property is exist, return the property handle,otherwise return -1.

◆ GetSibling()

FbxPropertyHandle GetSibling ( ) const

Get sibling property.

Returns: If the sibling property is exist, return the property handle,otherwise return -1.

◆ GetFirstDescendent()

FbxPropertyHandle GetFirstDescendent ( ) const

Get first descendent property.

Returns: If the descendent property is exist, return the first descendent property handle,otherwise return -1.

◆ GetNextDescendent()

FbxPropertyHandle GetNextDescendent ( const FbxPropertyHandle & pHandle ) const

Get first descendent property which after the given property.

Parameters

pHandle The given property handle

Returns: If the descendent property can be found after the given property, return the first found property handle,otherwise return -1.

◆ Find() [1/4]

FbxPropertyHandle Find	(	const char *	pName,
		bool	pCaseSensitive
	)		const

Find the property with given name.

Parameters

pName	The given property name
pCaseSensitive	Decide if the given property name is case sensitive

Returns: Return a property handle which be created with the found property.

◆ Find() [2/4]

FbxPropertyHandle Find	(	const char *	pName,
		const FbxPropertyHandle &	pTypeInfo,
		bool	pCaseSensitive
	)		const

Find the property with given name and type info.

Parameters

pName	The given property name
pTypeInfo	The given property type info
pCaseSensitive	Decide if the given property name is case sensitive

Returns: Return a property handle which be created with the found property.

◆ Find() [3/4]

FbxPropertyHandle Find	(	const char *	pName,
		const char *	pChildrenSeparator,
		bool	pCaseSensitive
	)		const

Separate the given name by children separator string and then find the property.The step is strip the first part of the name and search, if the property can be found, strip the second part of the name and continue search, until no property be found,then return the last found property.

Parameters

pName	The given property name
pChildrenSeparator	The given children separator string
pCaseSensitive	Decide if the given property name is case sensitive

Returns: Return a property handle which be created with the found property.

◆ Find() [4/4]

FbxPropertyHandle Find	(	const char *	pName,
		const char *	pChildrenSeparator,
		const FbxPropertyHandle &	pTypeInfo,
		bool	pCaseSensitive
	)		const

Separate the given name by children separator string and then find the property.The step is strip the first part of the name and search, if the property can be found, strip the second part of the name and continue search, until no property be found,then return the last found property.

Parameters

pName	The given property name
pChildrenSeparator	The given children separator string
pTypeInfo	The given property type info
pCaseSensitive	Decide if the given property name is case sensitive

Returns: Return a property handle which be created with the found property.

◆ ConnectSrc()

bool ConnectSrc	(	const FbxPropertyHandle &	pSrc,
		const FbxConnection::EType	pType = `FbxConnection::eDefault`
	)

Connect source property.

Parameters

pSrc	The given source property
pType	The given property type

Returns: If connect successfully, return true,otherwise, return false.

◆ GetSrcCount()

int GetSrcCount ( FbxConnectionPointFilter * pFilter = 0 ) const

Get source properties' count.

Parameters

pFilter The filter used to get sub connection point. If it is not zero, return the source count of the sub connection point. Otherwise, return the src count of this property.

Returns: The count of source properties

◆ GetSrc()

FbxPropertyHandle GetSrc	(	FbxConnectionPointFilter *	pFilter = `0`,
		int	pIndex = `0`
	)		const

Get source property with the given index.

Parameters

pFilter	The filter used to get sub connection point. If it is not zero, return the source property of the sub connection point. Otherwise, return the source property of this property.
pIndex	The given index

Returns: The source property handle.

◆ DisconnectSrc()

bool DisconnectSrc ( const FbxPropertyHandle & pSrc )

Disconnect source property.

Parameters

pSrc	The given source property

Returns: If disconnect successfully, return true, otherwise return false.

◆ IsConnectedSrc()

bool IsConnectedSrc ( const FbxPropertyHandle & pSrc )

Judge if it is connected with the given source property.

Parameters

pSrc	The given source property

Returns: If it is connected, return true, otherwise return false.

◆ ConnectDst()

bool ConnectDst	(	const FbxPropertyHandle &	pDst,
		const FbxConnection::EType	pType = `FbxConnection::eDefault`
	)

Connect destination property.

Parameters

pDst	The given destination property
pType	The given property type

Returns: If connect successfully, return true,otherwise, return false.

◆ GetDstCount()

int GetDstCount ( FbxConnectionPointFilter * pFilter = 0 ) const

Get destination properties' count.

Parameters

pFilter The filter used to get sub connection point.If it is not zero,return the destination count of the sub connection point. Otherwise, return the destination count of this property.

Returns: The count of destination properties

◆ GetDst()

FbxPropertyHandle GetDst	(	FbxConnectionPointFilter *	pFilter = `0`,
		int	pIndex = `0`
	)		const

Get destination property with the given index.

Parameters

pFilter	The filter used to get sub connection point.If it is not zero,return the destination property of the sub connection point. Otherwise, return the destination property of this property.
pIndex	The given index

Returns: The destination property handle.

◆ DisconnectDst()

bool DisconnectDst ( const FbxPropertyHandle & pDst )

Disconnect destination property.

Parameters

pDst	The given destination property

Returns: If disconnect successfully, return true,otherwise, return false.

◆ IsConnectedDst()

bool IsConnectedDst ( const FbxPropertyHandle & pDst )

Judge if it is connected with the given destination property.

Parameters

pDst	The given destination property

Returns: If it is connected, return true,otherwise, return false.

◆ ClearConnectCache()

void ClearConnectCache ( )

Clear connect cache.

◆ WipeAllConnections()

void WipeAllConnections ( )

Clear all connect without sending any notification (Internal use ONLY)

◆ HasMin()

bool HasMin ( ) const

Judge if this property has a minimum value.

Returns: If the minimum value exist, return true,otherwise, return false.

◆ GetMin() [1/2]

bool GetMin	(	void *	pValue,
		EFbxType	pValueType
	)		const

Get the minimum value and value type of this property.

Parameters

pValue	The minimum value of this property.
pValueType	The value type of this property.

Returns: If the minimum value exist, return true,otherwise, return false.

◆ SetMin() [1/2]

bool SetMin	(	const void *	pValue,
		EFbxType	pValueType
	)

Set the minimum value and value type for this property.

Parameters

pValue	The given minimum value .
pValueType	The given value type .

Returns: If it be set successfully, return true,otherwise, return false.

◆ SetMin() [2/2]

bool SetMin ( const T & pValue )

inline

According the given value and its value type, set the minimum value and value type for this property.

Parameters

pValue The given value .

Returns: If it be set successfully, return true,otherwise, return false.

Definition at line 386 of file fbxpropertyhandle.h.

386 { return SetMin(&pValue, FbxTypeOf(pValue)); }

FbxPropertyHandle::SetMin

bool SetMin(const void *pValue, EFbxType pValueType)

Set the minimum value and value type for this property.

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

◆ GetMin() [2/2]

T GetMin ( const T * pFBX_TYPE ) const

inline

Get the minimum value of this property.

Parameters

pFBX_TYPE Not used in this function. This is a dummy argument for the correct instantiation of the templated function.

Returns: The minimum value of this property

Definition at line 392 of file fbxpropertyhandle.h.

392 { T lValue; GetMin(&lValue, FbxTypeOf(lValue)); return lValue; }

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

FbxPropertyHandle::GetMin

bool GetMin(void *pValue, EFbxType pValueType) const

Get the minimum value and value type of this property.

◆ HasSoftMin()

bool HasSoftMin ( ) const

Judge if this property has soft minimum value.

Returns: If the soft minimum value exist, return true,otherwise, return false.

◆ GetSoftMin() [1/2]

bool GetSoftMin	(	void *	pValue,
		EFbxType	pValueType
	)		const

Get the soft minimum value and value type of this property.

Parameters

pValue	The soft minimum value of this property.
pValueType	The value type of this property.

Returns: If the soft minimum value exist, return true,otherwise, return false.

◆ SetSoftMin() [1/2]

bool SetSoftMin	(	const void *	pValue,
		EFbxType	pValueType
	)

Set the soft minimum value and value type for this property.

Parameters

pValue	The given soft minimum value .
pValueType	The given value type .

Returns: If it be set successfully, return true,otherwise, return false.

◆ SetSoftMin() [2/2]

bool SetSoftMin ( const T & pValue )

inline

According the given value and its value type, set the soft minimum value and value type for this property.

Parameters

pValue The given value .

Returns: If it be set successfully, return true,otherwise, return false.

Definition at line 413 of file fbxpropertyhandle.h.

413 { return SetSoftMin(&pValue, FbxTypeOf(pValue)); }

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

FbxPropertyHandle::SetSoftMin

bool SetSoftMin(const void *pValue, EFbxType pValueType)

Set the soft minimum value and value type for this property.

◆ GetSoftMin() [2/2]

T GetSoftMin ( const T * pFBX_TYPE ) const

inline

Get the soft minimum value of this property.

Parameters

pFBX_TYPE Not used in this function. This is a dummy argument for the correct instantiation of the templated function.

Returns: The soft minimum value of this property

Definition at line 419 of file fbxpropertyhandle.h.

419 { T lValue; GetSoftMin(&lValue, FbxTypeOf(lValue)); return lValue; }

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

FbxPropertyHandle::GetSoftMin

bool GetSoftMin(void *pValue, EFbxType pValueType) const

Get the soft minimum value and value type of this property.

◆ HasMax()

bool HasMax ( ) const

Judge if this property has maximum value.

Returns: If the maximum value exist, return true,otherwise, return false.

◆ GetMax() [1/2]

bool GetMax	(	void *	pValue,
		EFbxType	pValueType
	)		const

Get the maximum value and value type of this property.

Parameters

pValue	The maximum value of this property.
pValueType	The value type of this property.

Returns: If the maximum value exist, return true,otherwise, return false.

◆ SetMax() [1/2]

bool SetMax	(	const void *	pValue,
		EFbxType	pValueType
	)

Set the maximum value and value type for this property.

Parameters

pValue	The given maximum value .
pValueType	The given value type .

Returns: If it be set successfully, return true,otherwise, return false.

◆ SetMax() [2/2]

bool SetMax ( const T & pValue )

inline

According the given value and its value type, set the maximum value and value type for this property.

Parameters

pValue The given value .

Returns: If it be set successfully, return true,otherwise, return false.

Definition at line 440 of file fbxpropertyhandle.h.

440 { return SetMax(&pValue, FbxTypeOf(pValue)); }

FbxPropertyHandle::SetMax

bool SetMax(const void *pValue, EFbxType pValueType)

Set the maximum value and value type for this property.

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

◆ GetMax() [2/2]

T GetMax ( const T * pFBX_TYPE ) const

inline

Get the maximum value of this property.

Parameters

pFBX_TYPE Not used in this function. This is a dummy argument for the correct instantiation of the templated function.

Returns: The maximum value of this property

Definition at line 446 of file fbxpropertyhandle.h.

446 { T lValue; GetMax(&lValue, FbxTypeOf(lValue)); return lValue; }

FbxPropertyHandle::GetMax

bool GetMax(void *pValue, EFbxType pValueType) const

Get the maximum value and value type of this property.

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

◆ HasSoftMax()

bool HasSoftMax ( ) const

Judge if this property has soft maximum value.

Returns: If the soft maximum value exist, return true,otherwise, return false.

◆ GetSoftMax() [1/2]

bool GetSoftMax	(	void *	pValue,
		EFbxType	pValueType
	)		const

Get the soft maximum value and value type of this property.

Parameters

pValue	The soft maximum value of this property.
pValueType	The value type of this property.

Returns: If the soft maximum value exist, return true,otherwise, return false.

◆ SetSoftMax() [1/2]

bool SetSoftMax	(	const void *	pValue,
		EFbxType	pValueType
	)

Set the soft maximum value and value type for this property.

Parameters

pValue	The given soft maximum value .
pValueType	The given value type .

Returns: If it be set successfully, return true,otherwise, return false.

◆ SetSoftMax() [2/2]

bool SetSoftMax ( const T & pValue )

inline

According the given value and its value type, set the soft maximum value and value type for this property.

Parameters

pValue The given value .

Returns: If it be set successfully, return true,otherwise, return false.

Definition at line 467 of file fbxpropertyhandle.h.

467 { return SetSoftMax(&pValue, FbxTypeOf(pValue)); }

FbxPropertyHandle::SetSoftMax

bool SetSoftMax(const void *pValue, EFbxType pValueType)

Set the soft maximum value and value type for this property.

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

◆ GetSoftMax() [2/2]

T GetSoftMax ( const T * pFBX_TYPE ) const

inline

Get the soft maximum value of this property.

Parameters

pFBX_TYPE Not used in this function. This is a dummy argument for the correct instantiation of the templated function.

Returns: The soft maximum value of this property

Definition at line 473 of file fbxpropertyhandle.h.

473 { T lValue; GetSoftMax(&lValue, FbxTypeOf(lValue)); return lValue; }

FbxPropertyHandle::GetSoftMax

bool GetSoftMax(void *pValue, EFbxType pValueType) const

Get the soft maximum value and value type of this property.

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

◆ GetValueInheritType()

FbxPropertyFlags::EInheritType GetValueInheritType ( bool pCheckReferences ) const

Get value inherit type of this property.

Parameters

pCheckReferences If it is true,check instance of this property page,otherwise,only check this page.

Returns: The value inherit type of this property

◆ SetValueInheritType()

bool SetValueInheritType ( FbxPropertyFlags::EInheritType pType )

Set value inherit type for this property .

Parameters

pType The given value inherit type.

Returns: If set successfully, return true,otherwise, return false.

◆ GetDefaultValue()

bool GetDefaultValue	(	void *	pValue,
		EFbxType	pValueType
	)		const

Get default value and value type of this property .

Parameters

pValue	The gotten default value of this property.
pValueType	The gotten default value type of this property.

Returns: If default value be gotten successfully, return true,otherwise, return false.

◆ Get() [1/2]

bool Get	(	void *	pValue,
		EFbxType	pValueType
	)		const

Get value and value type of this property .

Parameters

pValue	The gotten value of this property.
pValueType	The gotten value type of this property.

Returns: If value be gotten successfully, return true,otherwise, return false.

◆ Set() [1/2]

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

Set property value and value type for this property.

Parameters

pValue	The given property value .
pValueType	The given property value type
pCheckValueEquality	If it is true, when the given value is equal with the property value, the property value will not be set.

Returns: If the property value be set successfully, return true,otherwise, return false.

◆ Set() [2/2]

bool Set ( const T & pValue )

inline

Set property value with the given value .

Parameters

pValue The given value .

Returns: If set successfully, return true,otherwise, return false.

Definition at line 513 of file fbxpropertyhandle.h.

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

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

FbxPropertyHandle::Set

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

Set property value and value type for this property.

◆ Get() [2/2]

T Get ( const T * pFBX_TYPE ) const

inline

get property value.

Parameters

pFBX_TYPE Not be used.

Returns: The gotten property value.

Definition at line 518 of file fbxpropertyhandle.h.

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

FbxTypeOf

EFbxType FbxTypeOf(const FbxChar &)

Definition: fbxpropertytypes.h:533

FbxPropertyHandle::Get

bool Get(void *pValue, EFbxType pValueType) const

Get value and value type of this property .

◆ SetPageDataPtr()

void SetPageDataPtr ( void * pData )

Set the property page data pointer.

Parameters

pData The given page data pointer.

◆ GetPageDataPtr()

void* GetPageDataPtr ( ) const

Get property page data pointer.

Returns: The gotten property page data pointer.

◆ PushPropertiesToParentInstance()

bool PushPropertiesToParentInstance ( )

Push properties to parent instance.

Returns: If push successful return true,otherwise,return false.

◆ IsAReferenceTo()

bool IsAReferenceTo ( void ) const

Judge if this property page is a instance of other page.

Returns: If this property page is a instance of other page, return true,otherwise,return false.

◆ GetReferenceTo()

void* GetReferenceTo ( void ) const

Get the property page which this property page make reference to.

Returns: The property page which this property page make reference to

◆ IsReferencedBy()

bool IsReferencedBy ( void ) const

Judge if this property page is referenced by other pages.

Returns: If this property page is referenced by other pages, return true,otherwise,return false.

◆ GetReferencedByCount()

int GetReferencedByCount ( void ) const

Get the count of property pages which make reference to this property page.

Returns: The count of property pages which make reference to this property page.

◆ GetReferencedBy()

void* GetReferencedBy ( int pIndex ) const

According the given index,get the property page which make reference to this property page.

Parameters

pIndex The given index

Returns: The pointer to the property page which reference to this property page and be found by index.

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

fbxsdk/core/fbxpropertyhandle.h

Class Description

Public Member Functions

Constructor and Destructor

Constructor & Destructor Documentation

◆ FbxPropertyHandle() [1/3]

◆ FbxPropertyHandle() [2/3]

◆ ~FbxPropertyHandle()

◆ FbxPropertyHandle() [3/3]

Member Function Documentation

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

◆ Create() [4/4]

◆ Destroy()

◆ operator=()

◆ operator==()

◆ operator!=()

◆ operator<()< h2=""> bool operator< ( const FbxPropertyHandle & pHandle) const Lesser operator, used to sort property handle in map. Parameters pHandleThe property handle compared to this property handle. Returnstrue if less, false otherwise.

◆ operator>()

◆ Is()

◆ Valid()

◆ GetName()

◆ GetLabel()

◆ SetLabel()

◆ GetType()

◆ GetTypeInfo()

◆ GetFlags()

◆ GetFlagsInheritType()

◆ ModifyFlags()

◆ SetFlagsInheritType()

◆ GetUserData()

◆ SetUserData()

◆ GetUserTag()

◆ SetUserTag()

◆ AddEnumValue()

◆ InsertEnumValue()

◆ GetEnumCount()

◆ SetEnumValue()

◆ RemoveEnumValue()

◆ GetEnumValue()

◆ BeginCreateOrFindProperty()

◆ EndCreateOrFindProperty()

◆ IsRoot()

◆ IsChildOf()

◆ IsDescendentOf()

◆ SetParent()

◆ Add()

◆ GetParent()

◆ GetChild()

◆ GetSibling()

◆ GetFirstDescendent()

◆ GetNextDescendent()

◆ Find() [1/4]

◆ Find() [2/4]

◆ Find() [3/4]

◆ Find() [4/4]

◆ ConnectSrc()

◆ GetSrcCount()

◆ GetSrc()

◆ DisconnectSrc()

◆ IsConnectedSrc()

◆ ConnectDst()

◆ GetDstCount()

◆ GetDst()

◆ DisconnectDst()

◆ IsConnectedDst()

◆ ClearConnectCache()

◆ WipeAllConnections()

◆ HasMin()

◆ GetMin() [1/2]

◆ SetMin() [1/2]

◆ SetMin() [2/2]

◆ GetMin() [2/2]

◆ HasSoftMin()

◆ GetSoftMin() [1/2]

◆ SetSoftMin() [1/2]

◆ SetSoftMin() [2/2]

◆ GetSoftMin() [2/2]

◆ HasMax()

◆ GetMax() [1/2]

◆ operator<()< h2="">

bool operator< ( const FbxPropertyHandle & pHandle ) const

Lesser operator, used to sort property handle in map.

Parameters

pHandle The property handle compared to this property handle.

Returns
`true` if less, `false` otherwise.