Simplygon 9 Documentation

# 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
Scene The scene that will be aggregated. Please note that internal refrences 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
Clear Clear all internal states of the object. This will NOT clear the parameters set in the object.
GetAggregationSettings The settings for the combining process.
GetClass Get the name of the AggregationProcessor class.
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.
GetVertexWeightSettings The settings for handling visibility weights.
GetVisibilitySettings The settings for handling visibility weights.
IsA Returns true if AggregationProcessor is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the AggregationProcessor object is invalid.
RunProcessing Runs the processing the object is designed for.

# 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 spAggregationProcessor, and if this is the case, returns the object cast into spAggregationProcessor.

# Properties details

# Scene

The scene that will be aggregated. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

    # Methods details

    # Clear

    Clear all internal states of the object. This will NOT clear the parameters set in the object.

      # GetAggregationSettings

      The settings for the combining process.

        # GetClass

        Get the name of the AggregationProcessor class.

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

                    # GetVertexWeightSettings

                    The settings for handling visibility weights.

                      # GetVisibilitySettings

                      The settings for handling visibility weights.

                        # IsA

                        Returns true if AggregationProcessor is a or is a descendant of the class named as the type parameter.

                          # IsNull

                          Returns true if the AggregationProcessor object is invalid.

                            # RunProcessing

                            Runs the processing the object is designed for.

                              # 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 spAggregationProcessor, and if this is the case, returns the object cast into spAggregationProcessor.

                                  ← AmbientOcclusionCaster →