FbxPropertyFlags Class Reference

#include <fbxpropertydef.h>

Class Description

Definition at line 27 of file fbxpropertydef.h.

Public Types
enum	EInheritType { eOverride, eInherit, eDeleted }
	Property inherit types. More...
enum	EFlags {   eNone = 0, eStatic = 1 << 0, eAnimatable = 1 << 1, eAnimated = 1 << 2,   eImported = 1 << 3, eUserDefined = 1 << 4, eHidden = 1 << 5, eNotSavable = 1 << 6,   eLockedMember0 = 1 << 7, eLockedMember1 = 1 << 8, eLockedMember2 = 1 << 9, eLockedMember3 = 1 << 10,   eLockedAll = eLockedMember0 | eLockedMember1 | eLockedMember2 | eLockedMember3, eMutedMember0 = 1 << 11, eMutedMember1 = 1 << 12, eMutedMember2 = 1 << 13,   eMutedMember3 = 1 << 14, eMutedAll = eMutedMember0 | eMutedMember1 | eMutedMember2 | eMutedMember3, eUIDisabled = 1 << 15, eUIGroup = 1 << 16,   eUIBoolGroup = 1 << 17, eUIExpanded = 1 << 18, eUINoCaption = 1 << 19, eUIPanel = 1 << 20,   eUILeftLabel = 1 << 21, eUIHidden = 1 << 22, eCtrlFlags = eStatic | eAnimatable | eAnimated | eImported | eUserDefined | eHidden | eNotSavable | eLockedAll | eMutedAll, eUIFlags = eUIDisabled | eUIGroup | eUIBoolGroup | eUIExpanded | eUINoCaption | eUIPanel | eUILeftLabel | eUIHidden,   eAllFlags = eCtrlFlags | eUIFlags, eFlagCount = 23 }
	Property flags that affect their behaviors. More...

Public Member Functions
bool	SetFlags (FbxPropertyFlags::EFlags pMask, FbxPropertyFlags::EFlags pFlags)
FbxPropertyFlags::EFlags	GetFlags () const
FbxPropertyFlags::EFlags	GetMergedFlags (FbxPropertyFlags::EFlags pFlags) const
bool	ModifyFlags (FbxPropertyFlags::EFlags pFlags, bool pValue)
FbxPropertyFlags::EInheritType	GetFlagsInheritType (FbxPropertyFlags::EFlags pFlags) const
bool	SetMask (FbxPropertyFlags::EFlags pFlags)
bool	UnsetMask (FbxPropertyFlags::EFlags pFlags)
FbxPropertyFlags::EFlags	GetMask () const
bool	Equal (const FbxPropertyFlags &pOther, FbxPropertyFlags::EFlags pFlags) const

Member Enumeration Documentation

EInheritType

enum EInheritType

Property inherit types.

Enumerator
eOverride	Property override this flag from its reference property.
eInherit	Property inherit this flag from its reference property.
eDeleted	Property has been deleted, so inheritance is invalid.

Definition at line 31 of file fbxpropertydef.h.

    {
        eOverride,  
        eInherit,   
        eDeleted    
    };

EFlags

enum EFlags

Property flags that affect their behaviors.

Enumerator
eNone	No flag.
eStatic	Property is defined in the class declaration, so it wasn't created dynamically.
eAnimatable	Property can be animated, thus is can have am animation curve node connected.
eAnimated	Property is animated, so it also has an animation curve node connected.
eImported	Property has been created during import process when reading FBX file.
eUserDefined	Property has been defined by user, not by the FBX SDK.
eHidden	Property should not be displayed on user interface.
eNotSavable	Property value must not be exported when writing FBX files.
eLockedMember0	This property has its member #0 locked.
eLockedMember1	This property has its member #1 locked.
eLockedMember2	This property has its member #2 locked.
eLockedMember3	This property has its member #3 locked.
eLockedAll
eMutedMember0	This property has its member #0 muted.
eMutedMember1	This property has its member #1 muted.
eMutedMember2	This property has its member #2 muted.
eMutedMember3	This property has its member #3 muted.
eMutedAll
eUIDisabled	Private flag for dynamic UI in FBX plug-ins.
eUIGroup	Private flag for dynamic UI in FBX plug-ins.
eUIBoolGroup	Private flag for dynamic UI in FBX plug-ins.
eUIExpanded	Private flag for dynamic UI in FBX plug-ins.
eUINoCaption	Private flag for dynamic UI in FBX plug-ins.
eUIPanel	Private flag for dynamic UI in FBX plug-ins.
eUILeftLabel	Private flag for dynamic UI in FBX plug-ins.
eUIHidden	Private flag for dynamic UI in FBX plug-ins.
eCtrlFlags
eUIFlags
eAllFlags
eFlagCount

Definition at line 39 of file fbxpropertydef.h.

    {
        eNone = 0,                  
        eStatic = 1 << 0,           
        eAnimatable = 1 << 1,       
        eAnimated = 1 << 2,         
        eImported = 1 << 3,         
        eUserDefined = 1 << 4,      
        eHidden = 1 << 5,           
        eNotSavable = 1 << 6,       

        eLockedMember0 = 1 << 7,    
        eLockedMember1 = 1 << 8,    
        eLockedMember2 = 1 << 9,    
        eLockedMember3 = 1 << 10,   
        eLockedAll = eLockedMember0 | eLockedMember1 | eLockedMember2 | eLockedMember3,
        eMutedMember0 = 1 << 11,    
        eMutedMember1 = 1 << 12,    
        eMutedMember2 = 1 << 13,    
        eMutedMember3 = 1 << 14,    
        eMutedAll = eMutedMember0 | eMutedMember1 | eMutedMember2 | eMutedMember3,

        //Private flags
        eUIDisabled = 1 << 15,      
        eUIGroup = 1 << 16,         
        eUIBoolGroup = 1 << 17,     
        eUIExpanded = 1 << 18,      
        eUINoCaption = 1 << 19,     
        eUIPanel = 1 << 20,         
        eUILeftLabel = 1 << 21,     
        eUIHidden = 1 << 22,        

        eCtrlFlags = eStatic | eAnimatable | eAnimated | eImported | eUserDefined | eHidden | eNotSavable | eLockedAll | eMutedAll,
        eUIFlags = eUIDisabled | eUIGroup | eUIBoolGroup | eUIExpanded | eUINoCaption | eUIPanel | eUILeftLabel | eUIHidden,
        eAllFlags = eCtrlFlags | eUIFlags,

        eFlagCount = 23,
    };

Member Function Documentation

SetFlags()

bool SetFlags	(	FbxPropertyFlags::EFlags	pMask,
		FbxPropertyFlags::EFlags	pFlags
	)

GetFlags()

FbxPropertyFlags::EFlags GetFlags

(

)

const

GetMergedFlags()

FbxPropertyFlags::EFlags GetMergedFlags

(

FbxPropertyFlags::EFlags

pFlags

)

const

ModifyFlags()

bool ModifyFlags	(	FbxPropertyFlags::EFlags	pFlags,
		bool	pValue
	)

GetFlagsInheritType()

FbxPropertyFlags::EInheritType GetFlagsInheritType

(

FbxPropertyFlags::EFlags

pFlags

)

const

SetMask()

bool SetMask

(

FbxPropertyFlags::EFlags

pFlags

)

UnsetMask()

bool UnsetMask

(

FbxPropertyFlags::EFlags

pFlags

)

GetMask()

FbxPropertyFlags::EFlags GetMask

(

)

const

Equal()

bool Equal	(	const FbxPropertyFlags &	pOther,
		FbxPropertyFlags::EFlags	pFlags
	)		const

---

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

• fbxsdk/core/fbxpropertydef.h