Simplygon 10.3.2100.0
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.
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 details
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.
GetClass
Get the name of the AggregationSettings class. (Inherited from Object)
GetDoubleParameter
Get a named parameter floating point value.
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
GetIntParameter
Get a named parameter integer value.
GetStringParameter
Get a named parameter string value.
GetUIntParameter
Get a named parameter unsigned integer value.
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.
SetDoubleParameter
Set a named parameter floating point value.
SetIntParameter
Set a named parameter integer value.
SetStringParameter
Set a named parameter string value.
SetUIntParameter
Set a named parameter unsigned integer value.
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.
ToJSON
Get settings as JSON for debugging purposes.
ValidateSettings
Validates the current settings values.
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 spAggregationSettings, and if this is the case, returns the object cast into spAggregationSettings. (Inherited from Object)