FBX C++ API Reference
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FbxSceneCheckUtility Class Reference

#include <fbxscenecheckutility.h>

Class 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.

Definition at line 28 of file fbxscenecheckutility.h.

Public Types

enum  ECheckMode {
  eCheckCycles = 1, eCheckAnimationEmptyLayers = 2, eCheckAnimatioCurveData = 4, eCheckAnimationData = 6,
  eCheckGeometryData = 8, eCheckOtherData = 16, eCkeckData = 30
}
 

Public Member Functions

 FbxSceneCheckUtility (const FbxScene *pScene, FbxStatus *pStatus=((void *) 0), FbxArray< FbxString *> *pDetails=((void *) 0))
 Construct the object pScene Input scene to check pStatus FbxStatus object to set error codes in (optional) pDetails Details messages of issues found (optional) More...
 
 ~FbxSceneCheckUtility ()
 
bool Validate (ECheckMode pCheckMode=eCheckCycles)
 Check for issues in the scene return if any issue is found in the scene remark Depending on the check mode settings, the processing time can increase dramatically. More...
 

Member Enumeration Documentation

◆ ECheckMode

enum ECheckMode
Enumerator
eCheckCycles 
eCheckAnimationEmptyLayers 
eCheckAnimatioCurveData 
eCheckAnimationData 
eCheckGeometryData 
eCheckOtherData 
eCkeckData 

Definition at line 31 of file fbxscenecheckutility.h.

Constructor & Destructor Documentation

◆ FbxSceneCheckUtility()

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

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

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

◆ ~FbxSceneCheckUtility()

Member Function Documentation

◆ Validate()

bool Validate ( ECheckMode  pCheckMode = eCheckCycles)

Check for issues in the scene return if any issue is found in the scene remark Depending on the check mode settings, the processing time can increase dramatically.

remark 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: