Simplygon 10 Documentation

# 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)
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)

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

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

# GetName return value

Type: spString

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

# Syntax

// Setter
void SetScene( const spScene & value ) const;

// Getter
spScene GetScene() const;

# SetScene parameters

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

# GetScene return value

Type: Scene

# Methods details

# AddObserver

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

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

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

# Return value

Type: rid

# Clear

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

# Syntax

void Clear() const;

# Parameters

Clear takes no parameters.

# GetAttributeTessellationSettings

The settings for handling attribute tessellation of the output geometry.

# Syntax

spAttributeTessellationSettings GetAttributeTessellationSettings() const;

# Parameters

GetAttributeTessellationSettings takes no parameters.

# Return value

Type: AttributeTessellationSettings

# GetBoneSettings

The settings for the bone removal process.

# Syntax

spBoneSettings GetBoneSettings() const;

# Parameters

GetBoneSettings takes no parameters.

# Return value

Type: BoneSettings

# GetClass

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

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# 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().

# Syntax

spMappingImage GetMappingImage() const;

# Parameters

GetMappingImage takes no parameters.

# Return value

Type: MappingImage

# 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().

# Syntax

spMappingImage GetMappingImageForImageIndex( rid outputMaterialId ) const;

# Parameters

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

# Return value

Type: MappingImage

# GetMappingImageSettings

The settings for the image mapping process.

# Syntax

spMappingImageSettings GetMappingImageSettings() const;

# Parameters

GetMappingImageSettings takes no parameters.

# Return value

Type: MappingImageSettings

# GetModularSeamSettings

The settings for the modular seams.

# Syntax

spModularSeamSettings GetModularSeamSettings() const;

# Parameters

GetModularSeamSettings takes no parameters.

# Return value

Type: ModularSeamSettings

# GetNormalCalculationSettings

The settings for the normal repair process.

# Syntax

spNormalCalculationSettings GetNormalCalculationSettings() const;

# Parameters

GetNormalCalculationSettings takes no parameters.

# Return value

Type: NormalCalculationSettings

# GetPercentDone

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

# Syntax

real GetPercentDone() const;

# Parameters

GetPercentDone takes no parameters.

# Return value

Type: real

# GetReductionSettings

The settings for the reduction process.

# Syntax

spReductionSettings GetReductionSettings() const;

# Parameters

GetReductionSettings takes no parameters.

# Return value

Type: ReductionSettings

# GetRepairSettings

The settings for the repair process.

# Syntax

spRepairSettings GetRepairSettings() const;

# Parameters

GetRepairSettings takes no parameters.

# Return value

Type: RepairSettings

# GetResultDeviation

Returns the max deviation reached for the last processing.

# Syntax

real GetResultDeviation() const;

# Parameters

GetResultDeviation takes no parameters.

# Return value

Type: real

# GetVertexWeightSettings

The settings for handling visibility weights.

# Syntax

spVertexWeightSettings GetVertexWeightSettings() const;

# Parameters

GetVertexWeightSettings takes no parameters.

# Return value

Type: VertexWeightSettings

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

# Syntax

spVisibilitySettings GetVisibilitySettings() const;

# Parameters

GetVisibilitySettings takes no parameters.

# Return value

Type: VisibilitySettings

# IsA

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

# Syntax

bool IsA( const char * type ) const;

# Parameters

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

# Return value

Type: bool

# IsNull

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

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

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

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

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

# Return value

Type: bool

# NonNull

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

# Syntax

bool NonNull() const;

# Parameters

NonNull takes no parameters.

# Return value

Type: bool

# PrintInfo

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

# Syntax

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

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

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type Name Min Max Description
rid observerId 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

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

# ToJSON

Get settings as JSON for debugging purposes.

# Syntax

spString ToJSON() const;

# Parameters

ToJSON takes no parameters.

# Return value

Type: spString

# 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

static bool IsClassA( const char * type ) const;

# 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

# 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)

# Syntax

static spReductionProcessor SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ReductionProcessor

← RemeshingProcessor →