class AggregationSettings
Settings for the AggregationSettings class. The AggregationProcessor converts entire scenes containing multiple draw calls into a single new object with a single texture per material channel. The user can set whether or not the AggregationProcessor should create new UVs based on the old UVs or create a completely new UV parameterization.
Properties
| Property | Description |
|---|
| EnableGeometryCulling | Enables culling object insides and permits use of GeometryCullingSettings. If both this and visibility related culling is enabled, this is run first, then visibility. |
| GeometryCullingPrecision | The accuracy of the triangle intersection math to find and cull insides used by the EnableTriangleCulling setting. Defined from 0 to 1 where 0 is max speed and 1 is max precision. |
| KeepUnprocessedSceneMeshes | If false, the processor will remove all geometry and scene meshes which were not selected for processing from the scene. If true, only the geometry in the ProcessSelectionSet will be replaced or updated, while the rest of the scene tree is kept intact. New geometry is always added as the last child of the scene root. If generating a mappingimage to cast materials, new materialIds will also be appended to the end of the old material table instead of replacing the old ones. |
| MergeGeometries | The processor will merge all the geometries in the scene into a single geometry if this is enabled. |
| Name | The name of the AggregationSettings object. (Inherited from Object) |
| ProcessSelectionSetID | Which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed. |
| ProcessSelectionSetName | Which selection set should be processed. If the selection set is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used. |
| SubdivideGeometryBasedOnUVTiles | Subdivides the geometry based on the tiling texture coords. The cutting frequency "SubdivisionTileSize" is a positive integer multiplier (i.e. the mesh will be cut each time its U or V texcoords crosses the SubdivisionTileSize). The output UVs will be in the range [(0,0),(SubdivisionTileSize,SubdivisionTileSize)]. |
| SubdivisionTileSize | The cutting frequency used when SubdivideGeometryBasedOnUVTiles is enabled. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetBoolParameter | Get a named parameter boolean value. (Inherited from SettingsObject) |
| GetClass | Get the name of the AggregationSettings class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value. (Inherited from SettingsObject) |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject) |
| GetIntParameter | Get a named parameter integer value. (Inherited from SettingsObject) |
| GetStringParameter | Get a named parameter string value. (Inherited from SettingsObject) |
| GetUIntParameter | Get a named parameter unsigned integer value. (Inherited from SettingsObject) |
| IsA | Returns true if AggregationSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the AggregationSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the AggregationSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the AggregationSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the AggregationSettings object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetBoolParameter | Set a named parameter boolean value. (Inherited from SettingsObject) |
| SetDoubleParameter | Set a named parameter floating point value. (Inherited from SettingsObject) |
| SetIntParameter | Set a named parameter integer value. (Inherited from SettingsObject) |
| SetStringParameter | Set a named parameter string value. (Inherited from SettingsObject) |
| SetUIntParameter | Set a named parameter unsigned integer value. (Inherited from SettingsObject) |
| SetValidateParameterNames | Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from SettingsObject) |
| ValidateSettings | Validates the current settings values. (Inherited from SettingsObject) |
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 spAggregationSettings, and if this is the case, returns the object cast into spAggregationSettings. (Inherited from Object) |
Properties details
EnableGeometryCulling
Enables culling object insides and permits use of GeometryCullingSettings. If both this and visibility related culling is enabled, this is run first, then visibility.
Syntax
SetEnableGeometryCulling parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired EnableTriangleCulling flag. |
GetEnableGeometryCulling return value
Type: bool
Default: false
Syntax
SetEnableGeometryCulling parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired EnableTriangleCulling flag. |
GetEnableGeometryCulling return value
Type: bool
Default: false
Syntax
SetEnableGeometryCulling parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired EnableTriangleCulling flag. |
GetEnableGeometryCulling return value
Type: bool
Default: false
GeometryCullingPrecision
The accuracy of the triangle intersection math to find and cull insides used by the EnableTriangleCulling setting. Defined from 0 to 1 where 0 is max speed and 1 is max precision.
Syntax
SetGeometryCullingPrecision parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0.0 | 1.0 | The desired TriangleCullingPrecision value. |
GetGeometryCullingPrecision return value
Type: real
Default: 0.5
Syntax
SetGeometryCullingPrecision parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0.0 | 1.0 | The desired TriangleCullingPrecision value. |
GetGeometryCullingPrecision return value
Type: float
Default: 0.5
Syntax
SetGeometryCullingPrecision parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0.0 | 1.0 | The desired TriangleCullingPrecision value. |
GetGeometryCullingPrecision return value
Type: float
Default: 0.5
KeepUnprocessedSceneMeshes
If false, the processor will remove all geometry and scene meshes which were not selected for processing from the scene. If true, only the geometry in the ProcessSelectionSet will be replaced or updated, while the rest of the scene tree is kept intact. New geometry is always added as the last child of the scene root. If generating a mappingimage to cast materials, new materialIds will also be appended to the end of the old material table instead of replacing the old ones.
Syntax
SetKeepUnprocessedSceneMeshes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired KeepUnprocessedSceneMeshes flag. |
GetKeepUnprocessedSceneMeshes return value
Type: bool
Default: false
Syntax
SetKeepUnprocessedSceneMeshes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired KeepUnprocessedSceneMeshes flag. |
GetKeepUnprocessedSceneMeshes return value
Type: bool
Default: false
Syntax
SetKeepUnprocessedSceneMeshes parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired KeepUnprocessedSceneMeshes flag. |
GetKeepUnprocessedSceneMeshes return value
Type: bool
Default: false
MergeGeometries
The processor will merge all the geometries in the scene into a single geometry if this is enabled.
Syntax
SetMergeGeometries parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired MergeGeometries flag. |
GetMergeGeometries return value
Type: bool
Default: true
Syntax
SetMergeGeometries parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired MergeGeometries flag. |
GetMergeGeometries return value
Type: bool
Default: true
Syntax
SetMergeGeometries parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired MergeGeometries flag. |
GetMergeGeometries return value
Type: bool
Default: true
Name
The name of the AggregationSettings 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
ProcessSelectionSetID
Which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: rid
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
int | value | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: int
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: int
Default: -1
ProcessSelectionSetName
Which selection set should be processed. If the selection set is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.
Syntax
SetProcessSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetProcessSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: string
Default: null
Syntax
SetProcessSelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: str
Default: None
SubdivideGeometryBasedOnUVTiles
Subdivides the geometry based on the tiling texture coords. The cutting frequency "SubdivisionTileSize" is a positive integer multiplier (i.e. the mesh will be cut each time its U or V texcoords crosses the SubdivisionTileSize). The output UVs will be in the range [(0,0),(SubdivisionTileSize,SubdivisionTileSize)].
Syntax
SetSubdivideGeometryBasedOnUVTiles parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired SubdivideGeometryBasedOnUVTiles flag. |
GetSubdivideGeometryBasedOnUVTiles return value
Type: bool
Default: false
Syntax
SetSubdivideGeometryBasedOnUVTiles parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired SubdivideGeometryBasedOnUVTiles flag. |
GetSubdivideGeometryBasedOnUVTiles return value
Type: bool
Default: false
Syntax
SetSubdivideGeometryBasedOnUVTiles parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired SubdivideGeometryBasedOnUVTiles flag. |
GetSubdivideGeometryBasedOnUVTiles return value
Type: bool
Default: false
SubdivisionTileSize
The cutting frequency used when SubdivideGeometryBasedOnUVTiles is enabled.
Syntax
SetSubdivisionTileSize parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | UINT_MAX | The desired SubdivisionTileSize value. |
GetSubdivisionTileSize return value
Type: unsigned int
Default: 1
Syntax
SetSubdivisionTileSize parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | UINT_MAX | The desired SubdivisionTileSize value. |
GetSubdivisionTileSize return value
Type: uint
Default: 1
Syntax
SetSubdivisionTileSize parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | UINT_MAX | The desired SubdivisionTileSize value. |
GetSubdivisionTileSize return value
Type: int
Default: 1
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
GetBoolParameter
Get a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: bool
GetClass
Get the name of the AggregationSettings 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
GetDoubleParameter
Get a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: float
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: string
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: str
GetIntParameter
Get a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
GetStringParameter
Get a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
IsA
Returns true if AggregationSettings 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 AggregationSettings 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 AggregationSettings 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 AggregationSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the AggregationSettings 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 AggregationSettings 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 AggregationSettings 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 AggregationSettings 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. |
SetBoolParameter
Set a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | bool | | | New value for parameter. |
Return value
Type: bool
SetDoubleParameter
Set a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | float | | | New value for parameter. |
Return value
Type: bool
SetIntParameter
Set a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetStringParameter
Set a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetUIntParameter
Set a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetValidateParameterNames
Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| validate | bool | | | Flag indicating if validation is performed or not. |
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
ValidateSettings
Validates the current settings values.
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
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 spAggregationSettings, and if this is the case, returns the object cast into spAggregationSettings. (Inherited from Object)
