FbxSceneCheckUtility Class Reference

This class defines functions to check the received scene graph for issues. More...

#include <fbxscenecheckutility.h>

Public Types
enum	ECheckMode {   eCheckCycles = 0x01, eCheckAnimationData = 0x06, eCheckAnimationEmptyLayers = 0x02, eCheckAnimatioCurveData = 0x04,   eCheckGeometryData = 0x7FFF8, eCheckPolyVertex = 0x00008, eCheckLayerElems = 0x0FFF0, eCheckOtherData = 0xF0000,   eCheckSkin = 0x00010000, eCheckCluster = 0x00020000, eCheckShape = 0x00040000, eSelectionNode = 0x00080000,   eCkeckData = 0x7FFFE }

Public Member Functions
	FbxSceneCheckUtility (const FbxScene *pScene, FbxStatus *pStatus=((void *) 0), FbxArray< FbxString * > *pDetails=((void *) 0))
	Construct the object. More...
	~FbxSceneCheckUtility ()
bool	Validate (ECheckMode pCheckMode=eCheckCycles, bool pTryToRemoveBadData=false)
	Check for issues in the scene. More...

Detailed Description

This class defines functions to check the received scene graph for issues.

remark This is still an experimental class and it is not expected to validate every single data object.

Examples:

ViewScene/SceneContext.cxx.

Definition at line 28 of file fbxscenecheckutility.h.

Member Enumeration Documentation

enum ECheckMode

Enumerator
eCheckCycles
eCheckAnimationData
eCheckAnimationEmptyLayers
eCheckAnimatioCurveData
eCheckGeometryData
eCheckPolyVertex
eCheckLayerElems
eCheckOtherData
eCheckSkin
eCheckCluster
eCheckShape
eSelectionNode
eCkeckData

Definition at line 31 of file fbxscenecheckutility.h.

                    {
        eCheckCycles = 0x01,
        eCheckAnimationData = 0x06,
            eCheckAnimationEmptyLayers = 0x02,
            eCheckAnimatioCurveData = 0x04,
        eCheckGeometryData = 0x7FFF8,
            eCheckPolyVertex = 0x00008,
            eCheckLayerElems = 0x0FFF0,
            // leave room for more granularity
            eCheckOtherData = 0xF0000,
                eCheckSkin    = 0x00010000,
                eCheckCluster = 0x00020000,
                eCheckShape   = 0x00040000,
                eSelectionNode= 0x00080000,
        eCkeckData = 0x7FFFE // includes GeometryData,AnimationData & OtherData
    };

Constructor & Destructor Documentation

FbxSceneCheckUtility	(	const FbxScene *	pScene,
		FbxStatus *	pStatus = ((void *) 0),
		FbxArray< FbxString * > *	pDetails = ((void *) 0)
	)

Construct the object.

Parameters

pScene	Input scene to check
pStatus	FbxStatus object to set error codes in (optional)
pDetails	Details messages of issues found (optional)

Remarks

The Details array and its content must be cleared by the caller

~FbxSceneCheckUtility

(

)

Member Function Documentation

bool Validate	(	ECheckMode	pCheckMode = eCheckCycles,
		bool	pTryToRemoveBadData = false
	)

Check for issues in the scene.

Parameters

pCheckMode	Identify what kind of checks to perform
pTryToRemoveBadData	If set, this class will try to destroy the objects that contains bad data as specified by the check mode flags.

Returns

if any issue is found in the scene

Remarks

Depending on the check mode settings, the processing time can increase dramatically.

If a status and/or details object is provided, the error code is set and, details info is logged.

---

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

• fbxsdk/utils/fbxscenecheckutility.h