KFbxTypedProperty< fbxReference * > Class Template Reference

#include <kfbxproperty.h>

Inheritance diagram for KFbxTypedProperty< fbxReference * >:

[legend]

List of all members.

---

Detailed Description

template<>
class KFbxTypedProperty< fbxReference * >

This template class is specialized using the pointer of class fbxReference to hold user properties whose data type are fbxReference.

Definition at line 1442 of file kfbxproperty.h.

Constructor and Destructor.
	KFbxTypedProperty ()
	Constructor.
	KFbxTypedProperty (KFbxProperty const &pProperty)
	Copy constructor.
	~KFbxTypedProperty ()
	Destructor.
Static initialization.
KFbxProperty const &	StaticInit (KFbxObject *pObject, char const *pName, eFbxPropertyFlags pFlags=eNO_FLAG)
	Creates a property and initializes it using a specific flag.
KFbxProperty const &	StaticInit (KFbxObject *pObject, char const *pName, fbxReference *const &pValue, bool pForceSet=true, eFbxPropertyFlags pFlags=eNO_FLAG)
	Creates a property and initializes it using a specific value and flag.
KFbxProperty const &	StaticInit (KFbxObject *pObject, char const *pName, KFbxDataType const &pDataType, eFbxPropertyFlags pFlags=eNO_FLAG)
	Creates a property and initializes it using a specific flag.
KFbxProperty const &	StaticInit (KFbxObject *pObject, char const *pName, KFbxDataType const &pDataType, fbxReference *const &pValue, bool pForceSet=true, eFbxPropertyFlags pFlags=eNO_FLAG)
	Creates a property and initializes it using a specific value and flag.
Public Member Functions
KFbxTypedProperty &	operator= (fbxReference *const &pValue)
	Assignment operator.
bool	Set (fbxReference *const &pValue)
	This function connects this property to the source object.
bool	Set (fbxReference *const &pValue, bool pCheckValueEquality)
	This function connects this property to the source object.
fbxReference *	Get () const
	Returns the source object.

---

Constructor & Destructor Documentation

KFbxTypedProperty

(

)

[inline]

Constructor.

Definition at line 1451 of file kfbxproperty.h.

KFbxTypedProperty

(

KFbxProperty const &

pProperty

)

[inline]

Copy constructor.

Parameters:

pProperty

The property copied to this one.

Definition at line 1457 of file kfbxproperty.h.

~KFbxTypedProperty

(

)

[inline]

Destructor.

Definition at line 1462 of file kfbxproperty.h.

---

Member Function Documentation

KFbxProperty const& StaticInit	(	KFbxObject *	pObject,
		char const *	pName,
		eFbxPropertyFlags	pFlags = eNO_FLAG
	)			[inline]

Creates a property and initializes it using a specific flag.

Parameters:

	pObject	The object that contains this property.
	pName	The name of the property.
	pFlags	The property flag.

Definition at line 1475 of file kfbxproperty.h.

References KFbxProperty::Create(), and KFbxProperty::ModifyFlag().

KFbxProperty const& StaticInit	(	KFbxObject *	pObject,
		char const *	pName,
		fbxReference *const &	pValue,
		bool	pForceSet = true,
		eFbxPropertyFlags	pFlags = eNO_FLAG
	)			[inline]

Creates a property and initializes it using a specific value and flag.

Parameters:

	pObject	The object that contains this property.
	pName	The name of the property.
	pValue	The value of the property.
	pForceSet	If true, the value is set forcibly, if false the value is not set when it equals the default value.
	pFlags	The property flag.

Definition at line 1489 of file kfbxproperty.h.

References KFbxProperty::Create(), KFbxProperty::ModifyFlag(), and KFbxTypedProperty::Set().

KFbxProperty const& StaticInit	(	KFbxObject *	pObject,
		char const *	pName,
		KFbxDataType const &	pDataType,
		eFbxPropertyFlags	pFlags = eNO_FLAG
	)			[inline]

Creates a property and initializes it using a specific flag.

Parameters:

	pObject	The object that contains this property.
	pName	The name of the property.
	pDataType	The data type of the property.
	pFlags	The property flag.

Definition at line 1514 of file kfbxproperty.h.

References KFbxProperty::Create(), and KFbxProperty::ModifyFlag().

KFbxProperty const& StaticInit	(	KFbxObject *	pObject,
		char const *	pName,
		KFbxDataType const &	pDataType,
		fbxReference *const &	pValue,
		bool	pForceSet = true,
		eFbxPropertyFlags	pFlags = eNO_FLAG
	)			[inline]

Creates a property and initializes it using a specific value and flag.

Parameters:

	pObject	The object that contains this property.
	pName	The name of the property.
	pDataType	The data type of the property.
	pValue	The value of the property.
	pForceSet	If true, the value is forcibly set, if false the value is not set when it equals the default value.
	pFlags	The property flag.

Definition at line 1533 of file kfbxproperty.h.

References KFbxProperty::Create(), KFbxProperty::ModifyFlag(), and KFbxTypedProperty::Set().

KFbxTypedProperty& operator=

(

fbxReference *const &

pValue

)

[inline]

Assignment operator.

Parameters:

pValue

The value assigned to this property.

Returns:

This property.

Definition at line 1560 of file kfbxproperty.h.

bool Set

(

fbxReference *const &

pValue

)

[inline]

This function connects this property to the source object.

Parameters:

pValue

The pointer of the source object.

Returns:

True on success, false otherwise.

Remarks:

This function is different from the set value function of KFbxProperty. It connects this property to the source object whose pointer is pValue. Before connecting, it disconnects all source objects.

Definition at line 1573 of file kfbxproperty.h.

References KFbxTypedProperty::Set().

bool Set	(	fbxReference *const &	pValue,
		bool	pCheckValueEquality
	)			[inline]

This function connects this property to the source object.

Parameters:

	pValue	The pointer of the source object.
	pCheckValueEquality

Returns:

True on success, false otherwise.

Remarks:

This function is different from the set value function of KFbxProperty. It connects this property to the source object whose pointer is pValue. Before connecting, it disconnects all source objects.

Definition at line 1583 of file kfbxproperty.h.

References KFbxProperty::ConnectSrcObject(), and KFbxProperty::DisconnectAllSrcObject().

fbxReference* Get

(

)

const [inline]

Returns the source object.

Returns:

The pointer of the source object.

Definition at line 1597 of file kfbxproperty.h.

References KFbxProperty::GetSrcObject(), and KFbxProperty::GetSrcObjectCount().