Simplygon 9 Documentation

# 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.
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
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the AggregationSettings class.
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.
IsNull Returns true if the AggregationSettings object is invalid.
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

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.

    # 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.

          # 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

                  # GetBoolParameter

                  Get a named parameter boolean value.

                    # GetClass

                    Get the name of the AggregationSettings class.

                      # 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.

                                  # IsNull

                                  Returns true if the AggregationSettings object is invalid.

                                    # 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.

                                                      # 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.

                                                        ← AmbientOcclusionCasterSettings →