Public Member Functions

FbxPropertyT< T > Class Template Reference

Search for all occurrences

Detailed Description

template<class T>
class FbxPropertyT< T >

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

Definition at line 1197 of file fbxproperty.h.

#include <fbxproperty.h>

Inheritance diagram for FbxPropertyT< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FbxPropertyT ()
 FbxPropertyT (const FbxProperty &pProperty)
 ~FbxPropertyT ()

Static initialization.

FbxPropertyStaticInit (FbxObject *pObject, const char *pName, const T &pValue, bool pForceSet, FbxPropertyAttr::EFlags pFlags=FbxPropertyAttr::eNone)
 Creates a property and initializes it using a specific value and flag.
FbxPropertyStaticInit (FbxObject *pObject, const char *pName, const FbxDataType &pDataType, const T &pValue, bool pForceSet, FbxPropertyAttr::EFlags pFlags=FbxPropertyAttr::eNone)
 Creates a property and initializes it using a specific value and flag.
FbxPropertyStaticInit (FbxProperty pCompound, const char *pName, const FbxDataType &pDataType, const T &pValue, bool pForceSet=true, FbxPropertyAttr::EFlags pFlags=FbxPropertyAttr::eNone)
 Creates a property and initializes it using a specific value and flag.

Value Management

FbxPropertyTSet (const T &pValue)
 Assignment function.
Get () const
 Retrieve function.
FbxPropertyToperator= (const T &pValue)
 Assignment operator.
 operator T () const
 Type cast operator.

Constructor & Destructor Documentation

FbxPropertyT ( ) [inline]

Definition at line 1290 of file fbxproperty.h.

FbxPropertyT ( const FbxProperty pProperty) [inline]

Definition at line 1291 of file fbxproperty.h.

: FbxProperty(pProperty){}
~FbxPropertyT ( ) [inline]

Definition at line 1292 of file fbxproperty.h.

{}

Member Function Documentation

FbxProperty& StaticInit ( FbxObject pObject,
const char *  pName,
const T &  pValue,
bool  pForceSet,
FbxPropertyAttr::EFlags  pFlags = FbxPropertyAttr::eNone 
) [inline]

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

Parameters:
pObjectThe object that contains this property.
pNameThe name of the property.
pValueThe value of the property.
pForceSetIf true, the value is forcibly set, if false the value is not set when it equals the default value.
pFlagsThe property flag.

Definition at line 1211 of file fbxproperty.h.

        {
            return StaticInit(pObject, pName, FbxGetDataTypeFromEnum(FbxTypeOf(*((T*)0))), pValue, pForceSet, pFlags);
        }
FbxProperty& StaticInit ( FbxObject pObject,
const char *  pName,
const FbxDataType pDataType,
const T &  pValue,
bool  pForceSet,
FbxPropertyAttr::EFlags  pFlags = FbxPropertyAttr::eNone 
) [inline]

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

Parameters:
pObjectThe object that contains this property.
pNameThe name of the property.
pDataTypeThe property data type.
pValueThe property value.
pForceSetIf true, the value is forcibly set, if false the value is not set when it equals the default value.
pFlagsThe property flag.

Definition at line 1224 of file fbxproperty.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
                FbxProperty::Set(&pValue, FbxTypeOf(pValue), false);
            }
            ModifyFlag(FbxPropertyAttr::eStatic, true);
            return *this;
        }
FbxProperty& StaticInit ( FbxProperty  pCompound,
const char *  pName,
const FbxDataType pDataType,
const T &  pValue,
bool  pForceSet = true,
FbxPropertyAttr::EFlags  pFlags = FbxPropertyAttr::eNone 
) [inline]

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

Parameters:
pCompoundThe parent property of this property.
pNameThe name of the property.
pDataTypeThe property data type.
pValueThe property value.
pForceSetIf true, the value is forcibly set, if false the value is not set when it equals to the default value.
pFlagsThe property flag.

Definition at line 1245 of file fbxproperty.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
                FbxProperty::Set(&pValue, FbxTypeOf(pValue), false);
            }
            ModifyFlag(FbxPropertyAttr::eStatic, true);
            return *this;
        }
FbxPropertyT& Set ( const T &  pValue) [inline]

Assignment function.

Parameters:
pValueThe value assigned to this property.
Returns:
This property.

Reimplemented from FbxProperty.

Definition at line 1267 of file fbxproperty.h.

{ FbxProperty::Set(&pValue, FbxTypeOf(pValue)); return *this; }
T Get ( ) const [inline]

Retrieve function.

Returns:
The value of the property.

Reimplemented from FbxProperty.

Definition at line 1272 of file fbxproperty.h.

{ T lValue; FbxProperty::Get(&lValue, FbxTypeOf(lValue)); return lValue; }
FbxPropertyT& operator= ( const T &  pValue) [inline]

Assignment operator.

Parameters:
pValueThe value of type T assigned to this property.
Returns:
This property.

Definition at line 1278 of file fbxproperty.h.

{ return Set(pValue); }
operator T ( ) const [inline]

Type cast operator.

Returns:
The value of the property of type T.

Definition at line 1283 of file fbxproperty.h.

{ return Get(); }

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