FbxPropertyInfo Class Reference

#include <fbxpropertypage.h>

Class Description

Definition at line 37 of file fbxpropertypage.h.

Public Types
enum	EValueIndex {   eValueMin, eValueSoftMin, eValueMax, eValueSoftMax,   eValueCount }

Public Member Functions
	FBXSDK_FRIEND_NEW ()
void	Destroy ()
FbxPropertyInfo *	Clone (FbxPropertyPage *)
void	IncRef ()
void	DecRef ()
int	GetRef ()
FbxStringSymbol	GetName () const
EFbxType	GetType () const
FbxPropertyPage *	GetTypeInfo () const
void	SetLabel (const char *pLabel)
const char *	GetLabel () const
void	SetUserTag (int pUserTag)
int	GetUserTag () const
void	SetUserData (const void *pUserData)
void *	GetUserData () const
int	AddEnumValue (const char *pStringValue)
void	InsertEnumValue (int pIndex, const char *pStringValue)
int	GetEnumCount ()
void	SetEnumValue (int pIndex, const char *pStringValue)
void	RemoveEnumValue (int pIndex)
char *	GetEnumValue (int pIndex)
bool	HasMinMax (EValueIndex pId) const
bool	GetMinMax (EValueIndex pId, void *pValue, EFbxType pValueType) const
bool	SetMinMax (EValueIndex pId, const void *pValue, EFbxType pValueType)

Static Public Member Functions
static FbxPropertyInfo *	Create (const char *pName, FbxPropertyPage *pTypeInfo)
static FbxPropertyInfo *	Create (const char *pName, EFbxType pType=eFbxUndefined)

Member Enumeration Documentation

enum EValueIndex

Enumerator
eValueMin
eValueSoftMin
eValueMax
eValueSoftMax
eValueCount

Definition at line 140 of file fbxpropertypage.h.

{eValueMin, eValueSoftMin, eValueMax, eValueSoftMax, eValueCount};

Member Function Documentation

FBXSDK_FRIEND_NEW

(

)

static FbxPropertyInfo* Create ( const char *  pName, FbxPropertyPage *  pTypeInfo  )

inlinestatic

Definition at line 41 of file fbxpropertypage.h.

{ return FbxNew< FbxPropertyInfo >(pName,pTypeInfo); }

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

inlinestatic

Definition at line 42 of file fbxpropertypage.h.

{ return FbxNew< FbxPropertyInfo >(pName,pType); }

void Destroy ( )

inline

Definition at line 43 of file fbxpropertypage.h.

{ FbxDelete(this); }

FbxPropertyInfo* Clone ( FbxPropertyPage *  )

inline

Definition at line 44 of file fbxpropertypage.h.

    {
        // @@@@@ Filter is missing
        // @@@@@ Clone is incomplete
        if (mTypeInfo) 
        {
            return FbxNew< FbxPropertyInfo >(mName,mTypeInfo);
        } 
        else 
        {
            return FbxNew< FbxPropertyInfo >(mName,mType);
        }
    }

void IncRef ( )

inline

Definition at line 58 of file fbxpropertypage.h.

{ mRef++; }

void DecRef ( )

inline

Definition at line 59 of file fbxpropertypage.h.

{ mRef--; if (mRef==0) FbxDelete(this); }

int GetRef ( )

inline

Definition at line 60 of file fbxpropertypage.h.

{ return mRef; }

FbxStringSymbol GetName ( ) const

inline

Definition at line 64 of file fbxpropertypage.h.

{ return mName; }

EFbxType GetType

(

)

const

FbxPropertyPage* GetTypeInfo ( ) const

inline

Definition at line 66 of file fbxpropertypage.h.

{ return mTypeInfo; }

void SetLabel ( const char *  pLabel )

inline

Definition at line 68 of file fbxpropertypage.h.

{ mLabel=pLabel;          }

const char* GetLabel ( ) const

inline

Definition at line 69 of file fbxpropertypage.h.

{ return mLabel.IsEmpty() ? "" : ((const char*)mLabel); }

void SetUserTag ( int  pUserTag )

inline

Definition at line 71 of file fbxpropertypage.h.

{ mUserTag=pUserTag;      }

int GetUserTag ( ) const

inline

Definition at line 72 of file fbxpropertypage.h.

{ return mUserTag;        }

void SetUserData ( const void *  pUserData )

inline

Definition at line 74 of file fbxpropertypage.h.

{ mUserData=(void*)pUserData;    }

void* GetUserData ( ) const

inline

Definition at line 75 of file fbxpropertypage.h.

{ return mUserData;       }

int AddEnumValue ( const char *  pStringValue )

inline

Definition at line 78 of file fbxpropertypage.h.

    {
        if (GetType() == eFbxEnum)
        {
            if (!mEnumList)
                mEnumList.Reset(FbxNew< FbxStringList >());

            if( mEnumList->FindIndex( pStringValue ) == -1 )
                return mEnumList->Add((char*)pStringValue);
        }
        return -1;
    }

void InsertEnumValue ( int  pIndex, const char *  pStringValue  )

inline

Definition at line 91 of file fbxpropertypage.h.

    {
        if (GetType() == eFbxEnum)
        {
            if (!mEnumList)
                mEnumList.Reset(FbxNew< FbxStringList >());

            mEnumList->InsertAt(pIndex,(char*)pStringValue);
        }
    }

int GetEnumCount ( )

inline

Definition at line 102 of file fbxpropertypage.h.

    {
        return mEnumList ? mEnumList->GetCount() : 0;
    }

void SetEnumValue ( int  pIndex, const char *  pStringValue  )

inline

Definition at line 107 of file fbxpropertypage.h.

    {
        if (GetType() == eFbxEnum)
        {
            if (!mEnumList)
                mEnumList.Reset(FbxNew< FbxStringList >());

            mEnumList->SetStringAt(pIndex,(char*)pStringValue);
        }
    }

void RemoveEnumValue ( int  pIndex )

inline

Definition at line 118 of file fbxpropertypage.h.

    {
        if (GetType() == eFbxEnum)
        {
            if (!mEnumList)
                mEnumList.Reset(FbxNew< FbxStringList >());

            mEnumList->RemoveAt(pIndex);
        }
    }

char* GetEnumValue ( int  pIndex )

inline

Definition at line 129 of file fbxpropertypage.h.

    {
      char* lValue = NULL;
        if (GetType() == eFbxEnum) {
            lValue = mEnumList ? mEnumList->GetStringAt(pIndex) : 0;
        }
        return lValue;
    }

bool HasMinMax ( EValueIndex  pId ) const

inline

Definition at line 142 of file fbxpropertypage.h.

    {
        return mMinMaxValue[pId] != NULL;
    }

bool GetMinMax ( EValueIndex  pId, void *  pValue, EFbxType  pValueType  ) const

inline

Definition at line 147 of file fbxpropertypage.h.

    {
        if (mMinMaxValue[pId]) {
            return FbxTypeCopy(pValue, pValueType, mMinMaxValue[pId], GetType());
        }
        return false;
    }

bool SetMinMax ( EValueIndex  pId, const void *  pValue, EFbxType  pValueType  )

inline

Definition at line 155 of file fbxpropertypage.h.

    {
        if (!mMinMaxValue[pId]) {
          size_t lSize = FbxTypeSizeOf(GetType());
            if (lSize) {
                mMinMaxValue[pId] = FbxMalloc(lSize);
            }
        }
        if (mMinMaxValue[pId]) {
            return FbxTypeCopy(mMinMaxValue[pId], GetType(), pValue, pValueType);
        }
        return false;
    }

---

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

• fbxsdk/core/fbxpropertypage.h