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