This reference page is linked to from the following overview topics: List of Python Fbx classes.

#include <fbxpropertypage.h>

Class Description

Definition at line 45 of file fbxpropertypage.h.

Public Types
typedef FbxUInt32	kFlagType
Public Member Functions
	FBX_ASSERT_STATIC (sizeof(kFlagType)*8 >=FbxPropertyAttr::eFlagCount)
	FbxPropertyFlagsExt (FbxPropertyAttr::EFlags pFlags)
	FbxPropertyFlagsExt ()
FbxPropertyFlagsExt	Clone (FbxPropertyPage *)
bool	SetMask (FbxPropertyAttr::EFlags pFlags)
bool	UnsetMask (FbxPropertyAttr::EFlags pFlags)
FbxPropertyAttr::EFlags	GetMask () const
FbxPropertyAttr::EFlags	GetFlags () const
bool	ModifyFlags (FbxPropertyAttr::EFlags pFlags, bool pValue)
FbxPropertyAttr::EFlags	GetMergedFlags (FbxPropertyAttr::EFlags pFlags) const
FbxPropertyAttr::EInheritType	GetFlagsInheritType (FbxPropertyAttr::EFlags pFlags) const
	Retrieves the inheritance type of the flags of the property.
bool	SetFlags (FbxPropertyAttr::EFlags pMask, FbxPropertyAttr::EFlags pFlags)
	Sets specified flags with a specified mask and updates the mask.
bool	Equal (const FbxPropertyFlagsExt &pOther, FbxPropertyAttr::EFlags pFlags) const

Member Typedef Documentation

typedef FbxUInt32 kFlagType

Search for all occurrences

Definition at line 47 of file fbxpropertypage.h.

Constructor & Destructor Documentation

FbxPropertyFlagsExt ( FbxPropertyAttr::EFlags pFlags ) [inline, explicit]

Definition at line 51 of file fbxpropertypage.h.

        :
    mFlagData(0), mMaskData(0)
    {
        ModifyFlags( pFlags, true );
    }

FbxPropertyFlagsExt ( ) [inline]

Definition at line 58 of file fbxpropertypage.h.

                         : 
                mFlagData(0), mMaskData(0)
    {
    }

Member Function Documentation

FBX_ASSERT_STATIC ( sizeof(kFlagType)*8 >=FbxPropertyAttr::eFlagCount )

Search for all occurrences

FbxPropertyFlagsExt Clone ( FbxPropertyPage * ) [inline]

Search for all occurrences

Definition at line 64 of file fbxpropertypage.h.

    {
        return FbxPropertyFlagsExt();
    }

bool SetMask ( FbxPropertyAttr::EFlags pFlags ) [inline]

Search for all occurrences

Definition at line 69 of file fbxpropertypage.h.

    {
        mMaskData |= pFlags;
        return true;
    }

bool UnsetMask ( FbxPropertyAttr::EFlags pFlags ) [inline]

Search for all occurrences

Definition at line 75 of file fbxpropertypage.h.

    {
        mMaskData &= ~pFlags;
        return true;
    }

FbxPropertyAttr::EFlags GetMask ( ) const [inline]

Search for all occurrences

Definition at line 81 of file fbxpropertypage.h.

{ return (FbxPropertyAttr::EFlags) (mMaskData); }

FbxPropertyAttr::EFlags GetFlags ( ) const [inline]

Search for all occurrences

Definition at line 83 of file fbxpropertypage.h.

{ return (FbxPropertyAttr::EFlags) (mFlagData); }

bool ModifyFlags	(	FbxPropertyAttr::EFlags	pFlags,
		bool	pValue
	)		`[inline]`

Search for all occurrences

Definition at line 85 of file fbxpropertypage.h.

    {
        SetMask( pFlags );
        mFlagData = pValue ? mFlagData | pFlags : mFlagData & ~pFlags;
        return true;
    }

FbxPropertyAttr::EFlags GetMergedFlags ( FbxPropertyAttr::EFlags pFlags ) const [inline]

Search for all occurrences

Definition at line 92 of file fbxpropertypage.h.

    {
        kFlagType lTemp = (kFlagType)pFlags & ~(GetMask());     // zero out flags that we override
        return (FbxPropertyAttr::EFlags) (lTemp | GetFlags());                   // fill those flags with our values.
    }

FbxPropertyAttr::EInheritType GetFlagsInheritType ( FbxPropertyAttr::EFlags pFlags ) const [inline]

Search for all occurrences

Retrieves the inheritance type of the flags of the property.

Use this method to determine if this property's flags is overridden from the default flags, or from the referenced object, if this object is a clone.

Parameters:

pFlags The specified flags

Returns:: The inheritance type of the flags of the property.

Definition at line 104 of file fbxpropertypage.h.

    {
        // If some, but not all, of the flags are overridden this returns FbxPropertyAttr::eOverride
        return (GetMask() & pFlags) != 0 ? FbxPropertyAttr::eOverride : FbxPropertyAttr::eInherit;
    }

bool SetFlags	(	FbxPropertyAttr::EFlags	pMask,
		FbxPropertyAttr::EFlags	pFlags
	)		`[inline]`

Search for all occurrences

Sets specified flags with a specified mask and updates the mask.

Parameters:

pMask	The specified mask
pFlags	The specified flags

Returns:: true

Definition at line 115 of file fbxpropertypage.h.

    {
        kFlagType lFlags = GetFlags() & ~pMask;     // zero out flags we are going to overwrite
        lFlags |= pFlags;                           // overwrite them
        mFlagData = lFlags;                         // set them
        return SetMask( pMask );                    // update the mask
    }

bool Equal	(	const FbxPropertyFlagsExt &	pOther,
		FbxPropertyAttr::EFlags	pFlags
	)		const `[inline]`

Search for all occurrences

Definition at line 123 of file fbxpropertypage.h.

    {
        kFlagType lMyFlags = GetFlags() & pFlags;
        kFlagType lOthersFlags = pOther.GetFlags() & pFlags;
        return lMyFlags == lOthersFlags;
    }

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

fbxsdk/core/fbxpropertypage.h

Class Description

Public Types

Public Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation