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. |
| 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. (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)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
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.
Syntax
SetScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The scene to process. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The scene to process. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
| Name | Type | Min | Max | Description |
|---|
| value | Scene | | | The scene to process. |
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
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
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.
GetAggregationSettings
The settings for the combining process.
Syntax
Parameters
GetAggregationSettings takes no parameters.
Return value
Type: AggregationSettings
Syntax
Parameters
GetAggregationSettings takes no parameters.
Return value
Type: AggregationSettings
Syntax
Parameters
GetAggregationSettings takes no parameters.
Return value
Type: AggregationSettings
GetClass
Get the name of the AggregationProcessor class. (Inherited from Object)
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
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().
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 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().
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 |
|---|
int | 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
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
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. Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it.
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 AggregationProcessor is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if AggregationProcessor 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 AggregationProcessor 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 AggregationProcessor is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the AggregationProcessor object is invalid. (Inherited from Object)
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
IsSameObjectAs
Returns true if the AggregationProcessor object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the AggregationProcessor object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the AggregationProcessor object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| 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.
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| Finished | 0 | The process finished with no error |
| Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| Finished | 0 | The process finished with no error |
| Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| EProcessStatus_Finished | 0 | The process finished with no error |
| EProcessStatus_Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
ToJSON
Get settings as JSON for debugging purposes.
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
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
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 spAggregationProcessor, and if this is the case, returns the object cast into spAggregationProcessor. (Inherited from Object)
