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. |
MergeGeometries | The processor will merge all the geometries in the scene into a single geometry if this is enabled. |
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 |
GetClass | Get the name of the AggregationSettings class. |
GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. |
IsA | Returns true if AggregationSettings is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the AggregationSettings object is invalid. |
ValidateSettings | Validates the current settings values. |
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 spAggregationSettings, and if this is the case, returns the object cast into spAggregationSettings. |
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
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
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 |
rid | value | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: rid
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
GetClass
Get the name of the AggregationSettings 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
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
IsA
Returns true if AggregationSettings 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 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.
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
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.
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.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: AggregationSettings
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: AggregationSettings
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: AggregationSettings