This reference page is linked to from the following overview topics: FBX SDK 2011, FBX Properties, Connections, FBX Nodes, Transformation Data, List of Python FBX classes.

Detailed Description

template<class T>
class KFbxTypedProperty< T >

This template class is used to contain user properties of specific data types.

Definition at line 1266 of file kfbxproperty.h.

#include <kfbxproperty.h>

Inheritance diagram for KFbxTypedProperty< T >:

[legend]

List of all members.

Public Member Functions
KFbxTypedProperty &	operator= (T const &pValue)
	Assignment operator.
bool	Set (T const &pValue, bool pCheckValueEquality)
	Sets the value of this property.
bool	Set (T const &pValue)
	Sets the value of this property.
T	Get () const
	Returns the value of this property.
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, T 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, T const &pValue, bool pForceSet=true, eFbxPropertyFlags pFlags=eNO_FLAG)
	Creates a property and initializes it using a specific value and flag.
KFbxProperty const &	StaticInit (KFbxProperty pCompound, char const *pName, KFbxDataType const &pDataType, T 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]

Constructor.

Definition at line 1274 of file kfbxproperty.h.

: KFbxProperty()                                         {}

KFbxTypedProperty ( KFbxProperty const & pProperty ) [inline]

Copy constructor.

Parameters:

pProperty The property copied to this one.

Definition at line 1279 of file kfbxproperty.h.

: KFbxProperty(pProperty)   {}

~KFbxTypedProperty ( ) [inline]

Destructor.

Definition at line 1282 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 1296 of file kfbxproperty.h.

            {
                *this = Create(pObject, GetFbxDataType(FbxTypeOf(*((T *)0))), pName, "");
                ModifyFlag(pFlags, true);
                return *this;
            }

KFbxProperty const& StaticInit	(	KFbxObject *	pObject,
		char const *	pName,
		T 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 forcibly set, if `false` the value is not set when it equals the default value.
pFlags	The property flag.

Definition at line 1310 of file kfbxproperty.h.

            {
                bool lWasFound = false;
                *this = Create(pObject, GetFbxDataType(FbxTypeOf(*((T *)0))), pName, "", true, &lWasFound);

                if( pForceSet || !lWasFound )
                {
                    ModifyFlag(pFlags, true); // modify the flags before we set the value
                    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 property data type.
pFlags	The property flag.

Definition at line 1330 of file kfbxproperty.h.

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

KFbxProperty const& StaticInit	(	KFbxObject *	pObject,
		char const *	pName,
		KFbxDataType const &	pDataType,
		T 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 property data type.
pValue	The property value.
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 1345 of file kfbxproperty.h.

            {
                bool lWasFound = false;
                *this = Create(pObject, pDataType, pName, "", true, &lWasFound);

                if( pForceSet || !lWasFound )
                {
                    ModifyFlag(pFlags, true); // modify the flags before we set the value
                    // since we will trigger callbacks in there!
                    Set(pValue,false);
                }

                return *this;
            }

KFbxProperty const& StaticInit	(	KFbxProperty	pCompound,
		char const *	pName,
		KFbxDataType const &	pDataType,
		T 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:

pCompound	The parent property of this property.
pName	The name of the property.
pDataType	The property data type.
pValue	The property value.
pForceSet	If `true`, the value is forcibly set, if `false` the value is not set when it equals to the default value.
pFlags	The property flag.

Definition at line 1368 of file kfbxproperty.h.

            {
                bool lWasFound = false;
                *this = Create(pCompound, pDataType, pName, "", true, &lWasFound);

                if( pForceSet || !lWasFound )
                {
                    ModifyFlag(pFlags, true); // modify the flags before we set the value
                    // since we will trigger callbacks in there!
                    Set(pValue,false);
                }

                return *this;
            }

KFbxTypedProperty& operator= ( T const & pValue ) [inline]

Assignment operator.

Parameters:

pValue The value assigned to this property.

Returns:: This property.

Definition at line 1390 of file kfbxproperty.h.

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

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

Search for all occurrences

Sets the value of this property.

Parameters:

pValue	The new value
pCheckValueEquality	If `true`, the value is not set if it equals the default value.

Returns:: True if the value is set successfully, false otherwise.

Definition at line 1397 of file kfbxproperty.h.

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

bool Set ( T const & pValue ) [inline]

Search for all occurrences

Sets the value of this property.

Parameters:

pValue The new value

Returns:: True if the value is set successfully, false otherwise.

Reimplemented from KFbxProperty.

Definition at line 1403 of file kfbxproperty.h.

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

T Get ( ) const [inline]

Search for all occurrences

Returns the value of this property.

Returns:: The value of the property.

Definition at line 1408 of file kfbxproperty.h.

{ T lValue; KFbxGet(*this,lValue); return lValue; }

Friends And Related Function Documentation

friend class KFbxObject [friend]

Search for all occurrences

Reimplemented from KFbxProperty.

Definition at line 1410 of file kfbxproperty.h.

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

fbxfilesdk/kfbxplugins/kfbxproperty.h

KFbxTypedProperty< T > Class Template Reference

Detailed Description

template<class T> class KFbxTypedProperty< T >

Public Member Functions

Friends

Constructor and Destructor.

Static initialization.

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class T>
class KFbxTypedProperty< T >