class SceneValidator
Checks the Scene based on currently set validation flags.
Properties
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetClass | Get the name of the SceneValidator class. (Inherited from Object) |
| GetErrorCount | Returns a uint with the number of errors that was found for the last check that was performed. |
| GetErrorString | Returns a string describing the error that was found in the last check that was performed. |
| IsA | Returns true if SceneValidator is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the SceneValidator object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the SceneValidator object is valid. (Inherited from Object) |
| NonNull | Returns true if the SceneValidator object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the SceneValidator object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| ValidateScene | Checks if the data stored in the Scene is stored correctly for use by Simplygon |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spSceneValidator, and if this is the case, returns the object cast into spSceneValidator. (Inherited from Object) |
Properties details
CheckBones
If set, bones will be checked for validity.
Syntax
SetCheckBones parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckBones return value
Type: bool
Syntax
SetCheckBones parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckBones return value
Type: bool
Syntax
SetCheckBones parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCheckBones return value
Type: bool
CheckDegenerateFaceIndices
If set, faces that have the same index more than once will not be allowed.
Syntax
SetCheckDegenerateFaceIndices parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckDegenerateFaceIndices return value
Type: bool
Syntax
SetCheckDegenerateFaceIndices parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckDegenerateFaceIndices return value
Type: bool
Syntax
SetCheckDegenerateFaceIndices parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCheckDegenerateFaceIndices return value
Type: bool
CheckGUIDs
If set, GUIDs have to be non-empty and unique.
Syntax
SetCheckGUIDs parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckGUIDs return value
Type: bool
Syntax
SetCheckGUIDs parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckGUIDs return value
Type: bool
Syntax
SetCheckGUIDs parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCheckGUIDs return value
Type: bool
CheckMaterials
If Set, check material table for invalid material data and shading nodes
Syntax
SetCheckMaterials parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckMaterials return value
Type: bool
Syntax
SetCheckMaterials parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckMaterials return value
Type: bool
Syntax
SetCheckMaterials parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCheckMaterials return value
Type: bool
CheckMeshes
If set, meshes will be checked for validity.
Syntax
SetCheckMeshes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckMeshes return value
Type: bool
Syntax
SetCheckMeshes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckMeshes return value
Type: bool
Syntax
SetCheckMeshes parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCheckMeshes return value
Type: bool
CheckTextures
If set, check the texture table for invalid or missing textures
Syntax
SetCheckTextures parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckTextures return value
Type: bool
Syntax
SetCheckTextures parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckTextures return value
Type: bool
Syntax
SetCheckTextures parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCheckTextures return value
Type: bool
CheckZeroAreaFaces
If set, faces that have zero area will not be allowed.
Syntax
SetCheckZeroAreaFaces parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckZeroAreaFaces return value
Type: bool
Syntax
SetCheckZeroAreaFaces parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCheckZeroAreaFaces return value
Type: bool
Syntax
SetCheckZeroAreaFaces parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCheckZeroAreaFaces return value
Type: bool
IgnoreNonFatalErrors
If set, check to ignore non fatal errors
Syntax
SetIgnoreNonFatalErrors parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetIgnoreNonFatalErrors return value
Type: unsigned int
Syntax
SetIgnoreNonFatalErrors parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetIgnoreNonFatalErrors return value
Type: uint
Syntax
SetIgnoreNonFatalErrors parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetIgnoreNonFatalErrors return value
Type: int
MaximumErrorStringsToReport
An upper limit to numbers of strings returned in an error report.
Syntax
SetMaximumErrorStringsToReport parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | | | The desired flag value. |
GetMaximumErrorStringsToReport return value
Type: unsigned int
Syntax
SetMaximumErrorStringsToReport parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | | | The desired flag value. |
GetMaximumErrorStringsToReport return value
Type: uint
Syntax
SetMaximumErrorStringsToReport parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The desired flag value. |
GetMaximumErrorStringsToReport return value
Type: int
Name
The name of the SceneValidator object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
TextureNodesMustHaveCoordinateName
If set, check texture nodes cannot have only unnamed coordinate levels
Syntax
SetTextureNodesMustHaveCoordinateName parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | | | The desired flag value. |
GetTextureNodesMustHaveCoordinateName return value
Type: bool
Syntax
SetTextureNodesMustHaveCoordinateName parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | | | The desired flag value. |
GetTextureNodesMustHaveCoordinateName return value
Type: bool
Syntax
SetTextureNodesMustHaveCoordinateName parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The desired flag value. |
GetTextureNodesMustHaveCoordinateName return value
Type: bool
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
GetClass
Get the name of the SceneValidator class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetErrorCount
Returns a uint with the number of errors that was found for the last check that was performed.
Syntax
Parameters
GetErrorCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetErrorCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetErrorCount takes no parameters.
Return value
Type: int
GetErrorString
Returns a string describing the error that was found in the last check that was performed.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | index | | | The desired index. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
uint | index | | | The desired index. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| index | int | | | The desired index. |
Return value
Type: str
IsA
Returns true if SceneValidator is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if SceneValidator is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if SceneValidator is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if SceneValidator is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the SceneValidator object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the SceneValidator object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the SceneValidator object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the SceneValidator object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
ValidateScene
Checks if the data stored in the Scene is stored correctly for use by Simplygon
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | scene | | | The Scene data to validate. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | scene | | | The Scene data to validate. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| scene | Scene | | | The Scene data to validate. |
Return value
Type: bool
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spSceneValidator, and if this is the case, returns the object cast into spSceneValidator. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: SceneValidator
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: SceneValidator
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: SceneValidator
