`class` ReductionProcessor

ReductionProcessor welds, removes t-junctions, removes double-triangles and reduces the triangle count of the Geometry. It also calculates new normals for the reduced and optimized Geometry.

Properties

Property	Description
Name	The name of the ReductionProcessor object. (Inherited from Object)
Scene	The scene object to reduce. Please note that internal references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

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)
GetAttributeTessellationSettings	The settings for handling attribute tessellation of the output geometry.
GetBoneSettings	The settings for the bone removal process.
GetClass	Get the name of the ReductionProcessor class. (Inherited from Object)
GetMappingImage	The MappingImage object that is generated if GenerateMappingImage is set in MappingImageSettings. This returns mapping image index 0, use GetMappingImageForImageIndex to retrieve for a specific index. A new object is generated for each call to RunProcessing().
GetMappingImageForImageIndex	The MappingImage object that is generated if GenerateMappingImage is set in MappingImageSettings. Called with an id, it will fetch that specific mapping image if using multi-material output. A new object is generated for each call to RunProcessing().
GetMappingImageSettings	The settings for the image mapping process.
GetModularSeamSettings	The settings for the modular seams.
GetNormalCalculationSettings	The settings for the normal repair process.
GetPercentDone	Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject)
GetReductionSettings	The settings for the reduction process.
GetRepairSettings	The settings for the repair process.
GetResultDeviation	Returns the max deviation reached for the last processing.
GetVertexWeightSettings	The settings for handling visibility weights.
GetVisibilitySettings	The settings for handling visibility weights. Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it.
IsA	Returns true if ReductionProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ReductionProcessor object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ReductionProcessor object is valid. (Inherited from Object)
NonNull	Returns true if the ReductionProcessor object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ReductionProcessor 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)
SetupProcessingSettingsForPerformanceMode	Sets up the processing setting objects' recommended values in the reducer to run at the provided performance mode. Please see the Concepts subsection of the documentation for which features are available in each mode.
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 spReductionProcessor, and if this is the case, returns the object cast into spReductionProcessor. (Inherited from Object)

Properties details

Name

The name of the ReductionProcessor object. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

Scene

The scene object to reduce. Please note that internal references might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Type	Name	Min	Max	Description
Scene	value			The scene to reduce.

Type	Name	Min	Max	Description
Scene	value			The scene to reduce.

Name	Type	Min	Max	Description
value	Scene			The scene to reduce.

Methods details

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

Clear

Clear all internal states of the object. This will NOT clear the parameters set in the object.

GetAttributeTessellationSettings

The settings for handling attribute tessellation of the output geometry.

GetBoneSettings

The settings for the bone removal process.

GetClass

Get the name of the ReductionProcessor class. (Inherited from Object)

GetMappingImage

The MappingImage object that is generated if GenerateMappingImage is set in MappingImageSettings. This returns mapping image index 0, use GetMappingImageForImageIndex to retrieve for a specific index. A new object is generated for each call to RunProcessing().

GetMappingImageForImageIndex

The MappingImage object that is generated if GenerateMappingImage is set in MappingImageSettings. Called with an id, it will fetch that specific mapping image if using multi-material output. A new object is generated for each call to RunProcessing().

Type	Name	Min	Max	Description
`rid`	outputMaterialId			The value for the outputMaterialId.

Type	Name	Min	Max	Description
`int`	outputMaterialId			The value for the outputMaterialId.

Name	Type	Min	Max	Description
outputMaterialId	`int`			The value for the outputMaterialId.

GetMappingImageSettings

The settings for the image mapping process.

GetModularSeamSettings

The settings for the modular seams.

GetNormalCalculationSettings

The settings for the normal repair process.

GetPercentDone

Returns the current progress of the processing as a value between 0 and 100.

GetReductionSettings

The settings for the reduction process.

GetRepairSettings

The settings for the repair process.

GetResultDeviation

Returns the max deviation reached for the last processing.

GetVertexWeightSettings

The settings for handling visibility weights.

GetVisibilitySettings

The settings for handling visibility weights. Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it.

IsA

Returns true if ReductionProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if ReductionProcessor is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if ReductionProcessor is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if ReductionProcessor is, or is a descendant of.

IsNull

Returns true if the ReductionProcessor object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the ReductionProcessor object is valid. (Inherited from Object)

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Name	Type	Min	Max	Description
object	Object			Object to compare with.

NonNull

Returns true if the ReductionProcessor object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the ReductionProcessor object to the log. (Inherited from Object)

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

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

cpp

Simplygon::EErrorCodes RunProcessing() const;

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
ProcessingCap	-10403	You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@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

csharp

EErrorCodes RunProcessing();

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
ProcessingCap	-10403	You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@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

python

EErrorCodes_* RunProcessing()

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_ProcessingCap	-10403	You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@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.

SetupProcessingSettingsForPerformanceMode

Sets up the processing setting objects' recommended values in the reducer to run at the provided performance mode. Please see the Concepts subsection of the documentation for which features are available in each mode.

Type	Name	Min	Max	Description
EReductionPerformanceMode	value			The selected mode.

Type	Name	Min	Max	Description
EReductionPerformanceMode	value			The selected mode.

Name	Type	Min	Max	Description
value	EReductionPerformanceMode			The selected mode.

ToJSON

Get settings as JSON for debugging purposes.

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)

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if the class is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if the class is, or is a descendant of.

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spReductionProcessor, and if this is the case, returns the object cast into spReductionProcessor. (Inherited from Object)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class ReductionProcessor ​

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

Scene ​

Methods details ​

AddObserver ​

Clear ​

GetAttributeTessellationSettings ​

GetBoneSettings ​

GetClass ​

GetMappingImage ​

GetMappingImageForImageIndex ​

GetMappingImageSettings ​

GetModularSeamSettings ​

`class` ReductionProcessor

Properties

Methods

Static methods

Properties details

Name

Scene

Methods details

AddObserver

Clear

GetAttributeTessellationSettings

GetBoneSettings

GetClass

GetMappingImage

GetMappingImageForImageIndex

GetMappingImageSettings

GetModularSeamSettings