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

#include <kfbxproperty.h>

Inheritance diagram for KFbxTypedProperty< fbxReference * >:

[legend]

List of all members.

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.
Friends
class	KFbxObject
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.

Constructor & Destructor Documentation

KFbxTypedProperty ( ) [inline]

Search for all occurrences

Constructor.

Definition at line 1429 of file kfbxproperty.h.

                                   : KFbxProperty()
        {}

KFbxTypedProperty ( KFbxProperty const & pProperty ) [inline]

Search for all occurrences

Copy constructor.

Parameters:

pProperty The property copied to this one.

Definition at line 1435 of file kfbxproperty.h.

            : KFbxProperty(pProperty)
        {}

~KFbxTypedProperty ( ) [inline]

Search for all occurrences

Destructor.

Definition at line 1440 of file kfbxproperty.h.

{}

Member Function Documentation

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

Search for all occurrences

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

        {
            *this = KFbxProperty::Create(pObject, GetFbxDataType(FbxTypeOf(*((fbxReference* *)0))), pName);
            ModifyFlag(pFlags, true);
            return *this;
        }

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

Search for all occurrences

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

        {
            bool lWasFound = false;
            *this = KFbxProperty::Create(pObject, GetFbxDataType(FbxTypeOf(*((fbxReference* *)0))), pName, "", true, &lWasFound);
            if( pForceSet || !lWasFound )
            {
                ModifyFlag(pFlags, true);
                Set(pValue,false);
            }
            return *this;
        }

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

Search for all occurrences

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

        {
            *this = KFbxProperty::Create(pObject, pDataType, pName, "");
//          KFbxProperty::StaticInit(pObject, pName, pDataType, "");
            ModifyFlag(pFlags, true);
            return *this;
        }

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

Search for all occurrences

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

        {
            bool lWasFound = false;
            *this = KFbxProperty::Create(pObject, pDataType, pName, "", true, &lWasFound);
            if( pForceSet || !lWasFound )
            {
                ModifyFlag(pFlags, true);
                Set(pValue,false);
            }
            return *this;
        }

KFbxTypedProperty& operator= ( fbxReference *const & pValue ) [inline]

Assignment operator.

Parameters:

pValue The value assigned to this property.

Returns:: This property.

Definition at line 1520 of file kfbxproperty.h.

        {
            KFbxSet(*this,pValue);
            return *this;
        }

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

Search for all occurrences

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

{ return Set(pValue, true); }

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

Search for all occurrences

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

        {
            KFbxObject* lValue = reinterpret_cast<KFbxObject*>(pValue);
            DisconnectAllSrcObject();
            if (lValue) {
                return ConnectSrcObject(lValue);
            }

            return false;
        }

fbxReference* Get ( ) const [inline]

Search for all occurrences

Returns the source object.

Returns:: The pointer of the source object.

Definition at line 1557 of file kfbxproperty.h.

        {
            KFbxObject* lValue = GetSrcObjectCount() > 0 ? GetSrcObject(0) : NULL;
            return reinterpret_cast<fbxReference*>(lValue);
        }

Friends And Related Function Documentation

friend class KFbxObject [friend]

Search for all occurrences

Reimplemented from KFbxProperty.

Definition at line 1563 of file kfbxproperty.h.

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

fbxfilesdk/kfbxplugins/kfbxproperty.h

KFbxTypedProperty< fbxReference * > Class Template Reference

Detailed Description

template<> class KFbxTypedProperty< fbxReference * >

Public Member Functions

Friends

Constructor and Destructor.

Static initialization.

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<>
class KFbxTypedProperty< fbxReference * >