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 |
Scene | The scene object to reduce. Please note that internal refrences 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 |
Clear | Clear all internal states of the object. This will NOT clear the parameters set in the object. |
GetBoneSettings | The settings for the bone removal process. |
GetClass | Get the name of the ReductionProcessor class. |
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. |
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. |
IsA | Returns true if ReductionProcessor is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the ReductionProcessor object is invalid. |
RunProcessing | Runs the processing the object is designed for. |
Static methods
Method | Description |
IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. |
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. |
Properties details
Scene
The scene object to reduce. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.
Syntax
SetScene parameters
Type | Name | Min | Max | Description |
Scene | value | | | The scene to reduce. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
Type | Name | Min | Max | Description |
Scene | value | | | The scene to reduce. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
Name | Type | Min | Max | Description |
value | Scene | | | The scene to reduce. |
GetScene return value
Type: Scene
Methods details
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.
GetBoneSettings
The settings for the bone removal process.
Syntax
Parameters
GetBoneSettings takes no parameters.
Return value
Type: BoneSettings
Syntax
Parameters
GetBoneSettings takes no parameters.
Return value
Type: BoneSettings
Syntax
Parameters
GetBoneSettings takes no parameters.
Return value
Type: BoneSettings
GetClass
Get the name of the ReductionProcessor class.
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
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
Parameters
GetMappingImage takes no parameters.
Return value
Type: MappingImage
Syntax
Parameters
GetMappingImage takes no parameters.
Return value
Type: MappingImage
Syntax
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
Parameters
Type | Name | Min | Max | Description |
rid | OutputMaterialId | | | The value for the OutputMaterialId. |
Return value
Type: MappingImage
Syntax
Parameters
Type | Name | Min | Max | Description |
rid | OutputMaterialId | | | The value for the OutputMaterialId. |
Return value
Type: MappingImage
Syntax
Parameters
Name | Type | Min | Max | Description |
OutputMaterialId | int | | | The value for the OutputMaterialId. |
Return value
Type: MappingImage
GetMappingImageSettings
The settings for the image mapping process.
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
GetNormalCalculationSettings
The settings for the normal repair process.
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
GetReductionSettings
The settings for the reduction process.
Syntax
Parameters
GetReductionSettings takes no parameters.
Return value
Type: ReductionSettings
Syntax
Parameters
GetReductionSettings takes no parameters.
Return value
Type: ReductionSettings
Syntax
Parameters
GetReductionSettings takes no parameters.
Return value
Type: ReductionSettings
GetRepairSettings
The settings for the repair process.
Syntax
Parameters
GetRepairSettings takes no parameters.
Return value
Type: RepairSettings
Syntax
Parameters
GetRepairSettings takes no parameters.
Return value
Type: RepairSettings
Syntax
Parameters
GetRepairSettings takes no parameters.
Return value
Type: RepairSettings
GetResultDeviation
Returns the max deviation reached for the last processing.
Syntax
Parameters
GetResultDeviation takes no parameters.
Return value
Type: real
Syntax
Parameters
GetResultDeviation takes no parameters.
Return value
Type: float
Syntax
Parameters
GetResultDeviation takes no parameters.
Return value
Type: float
GetVertexWeightSettings
The settings for handling visibility weights.
Syntax
Parameters
GetVertexWeightSettings takes no parameters.
Return value
Type: VertexWeightSettings
Syntax
Parameters
GetVertexWeightSettings takes no parameters.
Return value
Type: VertexWeightSettings
Syntax
Parameters
GetVertexWeightSettings takes no parameters.
Return value
Type: VertexWeightSettings
GetVisibilitySettings
The settings for handling visibility weights.
Syntax
Parameters
GetVisibilitySettings takes no parameters.
Return value
Type: VisibilitySettings
Syntax
Parameters
GetVisibilitySettings takes no parameters.
Return value
Type: VisibilitySettings
Syntax
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.
Syntax
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
Syntax
Parameters
Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if ReductionProcessor 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 ReductionProcessor is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ReductionProcessor object is invalid.
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
RunProcessing
Runs the processing the object is designed for.
Syntax
Parameters
RunProcessing takes no parameters.
Syntax
Parameters
RunProcessing takes no parameters.
Syntax
Parameters
RunProcessing takes no parameters.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
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 spReductionProcessor, and if this is the case, returns the object cast into spReductionProcessor.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: ReductionProcessor
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: ReductionProcessor
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: ReductionProcessor