class NormalRepairer
Repairs normals on a processed geometry.
Properties
| Property | Description |
|---|
| FlipFacesAndNormals | Set/Get setting for whether and how to flip the faces and or normals in the scene. None - Don't flip Automatic - Automatically detect and fix backfaces per part MakeDoubleSided - Append inverted winded triangles with inverted normals to the geometry InvertFaces - Invert the winding of the triangles InvertNormals - Invert the vertex normals InvertFacesAndNormals - Invert winding of all triangles and vertex normals. |
| Geometry | The Geometry object. |
| HardEdgeAngle | The edge angle in degrees above which an edge is considered "hard". |
| Name | The name of the NormalRepairer object. (Inherited from Object) |
| ProcessSelectionSetID | The ID of the SelectionSet containing the meshes to process If the ID is -1, all meshes are selected. |
| ProcessSelectionSetName | Which selection set should be processed. If SetName is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used. |
| RecalculateNormals | Set/Get whether to recalculate new normals. |
| RepairOnlyInvalidNormals | The RepairOnlyInvalidNormals flag If set, then only those normals that are invalid (backfacing, zero length etc) will be fixed. |
| ScaleByAngle | The ScaleByAngle flag. If set, the influence of a triangle normal upon the vertex normals is scaled by the angle of the corner at the vertex. |
| ScaleByArea | The ScaleByArea flag. If set, the influence of a triangle normal upon the vertex normals is scaled by the area of the triangle. |
| Scene | The scene. |
| SnapNormalsToFlatSurfaces | The SnapNormalsToFlatSurfaces flag. If set, perfectly flat shaded surfaces will be created, where possible. Normals adjacent to perfectly geometrically flat surfaces will be recalculated to have the same direction as for those of the adjacent flat surface. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Clear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject) |
| GetClass | Get the name of the NormalRepairer class. (Inherited from Object) |
| GetPercentDone | Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject) |
| IsA | Returns true if NormalRepairer is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the NormalRepairer object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the NormalRepairer object is valid. (Inherited from Object) |
| NonNull | Returns true if the NormalRepairer object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the NormalRepairer object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunProcessing | Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned. (Inherited from ProcessingObject) |
| SetAutoCorrectionAllowsDoubleSided | Set true to allow for double sided triangles. |
| SetAutoCorrectionRatioThreshold | The threshold ratio for auto correction. |
| SetAutoCorrectionSingleSidedThreshold | The threshold ratio for auto correction to treat triangle as single sided. |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from ProcessingObject) |
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 spNormalRepairer, and if this is the case, returns the object cast into spNormalRepairer. (Inherited from Object) |
Properties details
FlipFacesAndNormals
Set/Get setting for whether and how to flip the faces and or normals in the scene. None - Don't flip Automatic - Automatically detect and fix backfaces per part MakeDoubleSided - Append inverted winded triangles with inverted normals to the geometry InvertFaces - Invert the winding of the triangles InvertNormals - Invert the vertex normals InvertFacesAndNormals - Invert winding of all triangles and vertex normals.
Syntax
SetFlipFacesAndNormals parameters
GetFlipFacesAndNormals return value
Type: EFlipFacesAndNormals
Default: NoFlip
| Key | Value | Comment |
|---|
| NoFlip | 0 | Don't flip. |
| Automatic | 1 | Automatically detect and fix backfaces per part. |
| MakeDoubleSided | 2 | Append inverted winded triangles with inverted normals to the geometry. |
| InvertFaces | 3 | Invert the winding of the triangles. |
| InvertNormals | 4 | Invert the vertex normals. |
| InvertFacesAndNormals | 5 | Invert winding of all triangles and vertex normals. |
Syntax
SetFlipFacesAndNormals parameters
GetFlipFacesAndNormals return value
Type: EFlipFacesAndNormals
Default: NoFlip
| Key | Value | Comment |
|---|
| NoFlip | 0 | Don't flip. |
| Automatic | 1 | Automatically detect and fix backfaces per part. |
| MakeDoubleSided | 2 | Append inverted winded triangles with inverted normals to the geometry. |
| InvertFaces | 3 | Invert the winding of the triangles. |
| InvertNormals | 4 | Invert the vertex normals. |
| InvertFacesAndNormals | 5 | Invert winding of all triangles and vertex normals. |
Syntax
SetFlipFacesAndNormals parameters
GetFlipFacesAndNormals return value
Type: EFlipFacesAndNormals
Default: NoFlip
| Key | Value | Comment |
|---|
| EFlipFacesAndNormals_NoFlip | 0 | Don't flip. |
| EFlipFacesAndNormals_Automatic | 1 | Automatically detect and fix backfaces per part. |
| EFlipFacesAndNormals_MakeDoubleSided | 2 | Append inverted winded triangles with inverted normals to the geometry. |
| EFlipFacesAndNormals_InvertFaces | 3 | Invert the winding of the triangles. |
| EFlipFacesAndNormals_InvertNormals | 4 | Invert the vertex normals. |
| EFlipFacesAndNormals_InvertFacesAndNormals | 5 | Invert winding of all triangles and vertex normals. |
Geometry
The Geometry object.
Syntax
SetGeometry parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | value | | | The geometry that is to be repaired. |
GetGeometry return value
Type: GeometryData
Syntax
SetGeometry parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | value | | | The geometry that is to be repaired. |
GetGeometry return value
Type: GeometryData
Syntax
SetGeometry parameters
| Name | Type | Min | Max | Description |
|---|
| value | GeometryData | | | The geometry that is to be repaired. |
GetGeometry return value
Type: GeometryData
HardEdgeAngle
The edge angle in degrees above which an edge is considered "hard".
Syntax
SetHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | 180 | The value to which HardEdgeAngle is to be set. |
GetHardEdgeAngle return value
Type: real
Default: 60.0
Syntax
SetHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | 180 | The value to which HardEdgeAngle is to be set. |
GetHardEdgeAngle return value
Type: float
Default: 60.0
Syntax
SetHardEdgeAngle parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | 180 | The value to which HardEdgeAngle is to be set. |
GetHardEdgeAngle return value
Type: float
Default: 60.0
Name
The name of the NormalRepairer 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
ProcessSelectionSetID
The ID of the SelectionSet containing the meshes to process If the ID is -1, all meshes are selected.
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | The selection set id to use. |
GetProcessSelectionSetID return value
Type: rid
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
int | value | | | The selection set id to use. |
GetProcessSelectionSetID return value
Type: int
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The selection set id to use. |
GetProcessSelectionSetID return value
Type: int
Default: -1
ProcessSelectionSetName
Which selection set should be processed. If SetName is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.
Syntax
SetProcessSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: spString
Syntax
SetProcessSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: string
Syntax
SetProcessSelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: str
RecalculateNormals
Set/Get whether to recalculate new normals.
Syntax
SetRecalculateNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new value of RecalculateNormals. |
GetRecalculateNormals return value
Type: bool
Default: true
Syntax
SetRecalculateNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new value of RecalculateNormals. |
GetRecalculateNormals return value
Type: bool
Default: true
Syntax
SetRecalculateNormals parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new value of RecalculateNormals. |
GetRecalculateNormals return value
Type: bool
Default: true
RepairOnlyInvalidNormals
The RepairOnlyInvalidNormals flag If set, then only those normals that are invalid (backfacing, zero length etc) will be fixed.
Syntax
SetRepairOnlyInvalidNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the RepairOnlyInvalidNormals bool is to be set. |
GetRepairOnlyInvalidNormals return value
Type: bool
Default: false
Syntax
SetRepairOnlyInvalidNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the RepairOnlyInvalidNormals bool is to be set. |
GetRepairOnlyInvalidNormals return value
Type: bool
Default: false
Syntax
SetRepairOnlyInvalidNormals parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which the RepairOnlyInvalidNormals bool is to be set. |
GetRepairOnlyInvalidNormals return value
Type: bool
Default: false
ScaleByAngle
The ScaleByAngle flag. If set, the influence of a triangle normal upon the vertex normals is scaled by the angle of the corner at the vertex.
Syntax
SetScaleByAngle parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByAngle bool is to be set. |
GetScaleByAngle return value
Type: bool
Default: true
Syntax
SetScaleByAngle parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByAngle bool is to be set. |
GetScaleByAngle return value
Type: bool
Default: true
Syntax
SetScaleByAngle parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which the ScaleByAngle bool is to be set. |
GetScaleByAngle return value
Type: bool
Default: true
ScaleByArea
The ScaleByArea flag. If set, the influence of a triangle normal upon the vertex normals is scaled by the area of the triangle.
Syntax
SetScaleByArea parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByArea bool is to be set. |
GetScaleByArea return value
Type: bool
Default: true
Syntax
SetScaleByArea parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByArea bool is to be set. |
GetScaleByArea return value
Type: bool
Default: true
Syntax
SetScaleByArea parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which the ScaleByArea bool is to be set. |
GetScaleByArea return value
Type: bool
Default: true
Scene
The scene.
Syntax
SetScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The scene object to use. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The scene object to use. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
| Name | Type | Min | Max | Description |
|---|
| value | Scene | | | The scene object to use. |
GetScene return value
Type: Scene
SnapNormalsToFlatSurfaces
The SnapNormalsToFlatSurfaces flag. If set, perfectly flat shaded surfaces will be created, where possible. Normals adjacent to perfectly geometrically flat surfaces will be recalculated to have the same direction as for those of the adjacent flat surface.
Syntax
SetSnapNormalsToFlatSurfaces parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | To use for SnapNormalsToFlatSurfaces. |
GetSnapNormalsToFlatSurfaces return value
Type: bool
Default: false
Syntax
SetSnapNormalsToFlatSurfaces parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | To use for SnapNormalsToFlatSurfaces. |
GetSnapNormalsToFlatSurfaces return value
Type: bool
Default: false
Syntax
SetSnapNormalsToFlatSurfaces parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | To use for SnapNormalsToFlatSurfaces. |
GetSnapNormalsToFlatSurfaces return value
Type: bool
Default: false
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
Clear
Clear all internal states of the object. This will NOT clear the parameters set in the object.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the NormalRepairer 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
GetPercentDone
Returns the current progress of the processing as a value between 0 and 100.
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: real
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
IsA
Returns true if NormalRepairer 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 NormalRepairer 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 NormalRepairer 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 NormalRepairer is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the NormalRepairer 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 NormalRepairer 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 NormalRepairer 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 NormalRepairer 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. |
RunProcessing
Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned.
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FileError | -15 | a file read/write failed. |
| InvalidPath | -16 | a path is invalid or a file/directory is missing. |
| DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
| UnexpectedError | -18 | an unexpected error happened. |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FileError | -15 | a file read/write failed. |
| InvalidPath | -16 | a path is invalid or a file/directory is missing. |
| DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
| UnexpectedError | -18 | an unexpected error happened. |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| EErrorCodes_NoError | 0 | No error, the initialization or process has finished, and with no errors |
| EErrorCodes_NoLicense | -1 | no license was found (or licence expired) |
| EErrorCodes_NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| EErrorCodes_AlreadyInitialized | -3 | the SDK is already initialized |
| EErrorCodes_DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| EErrorCodes_InvalidInputParam | -5 | an invalid parameter was passed to the method |
| EErrorCodes_FailedTesting | -6 | the reduction failed post-testing |
| EErrorCodes_DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| EErrorCodes_DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| EErrorCodes_LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| EErrorCodes_LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| EErrorCodes_LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| EErrorCodes_FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| EErrorCodes_FailedToRunPipeline | -13 | failed to run pipeline |
| EErrorCodes_UnhandledException | -14 | an unhandled exception was encountered |
| EErrorCodes_FileError | -15 | a file read/write failed. |
| EErrorCodes_InvalidPath | -16 | a path is invalid or a file/directory is missing. |
| EErrorCodes_DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
| EErrorCodes_UnexpectedError | -18 | an unexpected error happened. |
| EErrorCodes_FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| EErrorCodes_ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| EErrorCodes_FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| EErrorCodes_FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| EErrorCodes_FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| EErrorCodes_FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| EErrorCodes_DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| EErrorCodes_LicenseHasExpired | -10006 | the license has expired |
| EErrorCodes_LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| EErrorCodes_LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| EErrorCodes_NoNetworkCardFound | -10009 | no network card was found on the machine |
| EErrorCodes_LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| EErrorCodes_LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| EErrorCodes_ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| EErrorCodes_LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| EErrorCodes_LicenseExpired | -10014 | the license is invalid, please contact licensing |
| EErrorCodes_LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| EErrorCodes_YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| EErrorCodes_LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| EErrorCodes_LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| EErrorCodes_MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| EErrorCodes_YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| EErrorCodes_LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
SetAutoCorrectionAllowsDoubleSided
Set true to allow for double sided triangles.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of the flag. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of the flag. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired value of the flag. |
SetAutoCorrectionRatioThreshold
The threshold ratio for auto correction.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The desired threshold ratio. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The desired threshold ratio. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The desired threshold ratio. |
SetAutoCorrectionSingleSidedThreshold
The threshold ratio for auto correction to treat triangle as single sided.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The desired threshold. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The desired threshold. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The desired threshold. |
ToJSON
Get settings as JSON for debugging purposes.
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
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 spNormalRepairer, and if this is the case, returns the object cast into spNormalRepairer. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: NormalRepairer
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: NormalRepairer
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: NormalRepairer
