# class AggregationProcessor
AggregationProcessor combines all specified geometries in the scene into one geometry. All materials are combined and receive a new shared texture atlas.
# Properties
| Property | Description |
|---|---|
| Name | The name of the AggregationProcessor object. (Inherited from Object) |
| Scene | The scene that will be aggregated. 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) |
| GetAggregationSettings | The settings for the combining process. |
| GetAttributeTessellationSettings | The settings for handling attribute tessellation of the output geometry. |
| GetClass | Get the name of the AggregationProcessor class. (Inherited from Object) |
| GetGeometryCullingSettings | The settings for handling geometry culling. |
| GetMappingImage | The MappingImage object that is generated if MappingImageSettings::GenerateMappingImage is set. 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 MappingImageSettings::GenerateMappingImage is set. 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. |
| GetPercentDone | Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject) |
| 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 AggregationProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the AggregationProcessor object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the AggregationProcessor object is valid. (Inherited from Object) |
| NonNull | Returns true if the AggregationProcessor object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the AggregationProcessor 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 spAggregationProcessor, and if this is the case, returns the object cast into spAggregationProcessor. (Inherited from Object) |
# Properties details
# Name
The name of the AggregationProcessor object. (Inherited from Object)
# Scene
The scene that will be aggregated. 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.
# GetAggregationSettings
The settings for the combining process.
# GetAttributeTessellationSettings
The settings for handling attribute tessellation of the output geometry.
# GetClass
Get the name of the AggregationProcessor class. (Inherited from Object)
# GetGeometryCullingSettings
The settings for handling geometry culling.
# GetMappingImage
The MappingImage object that is generated if MappingImageSettings::GenerateMappingImage is set. 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 MappingImageSettings::GenerateMappingImage is set. 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.
# GetPercentDone
Returns the current progress of the processing as a value between 0 and 100.
# 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 AggregationProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object)
# IsNull
Returns true if the AggregationProcessor object is invalid. (Inherited from Object)
# IsSameObjectAs
Returns true if the AggregationProcessor object is valid. (Inherited from Object)
# NonNull
Returns true if the AggregationProcessor object is valid. (Inherited from Object)
# PrintInfo
Prints the content/info of the AggregationProcessor 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.
# 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 spAggregationProcessor, and if this is the case, returns the object cast into spAggregationProcessor. (Inherited from Object)