# class AggregationPipeline

AggregationPipeline provides a pipeline for a single aggregation processor to be applied on the input scene.

# Methods

Method Description
AddCascadedPipeline Add a cascaded child pipeline. The child pipeline will execute on the scene output from this pipeline.
AddMaterialCaster Add a material caster. Material casting requires the mapping image generation to be enabled (SetGenerateMappingImage in MappingImageSettings returned by GetMappingImageSettings). If called with a material index set to non-zero, the mapping image for the corresponding output material will be used. See GetOutputMaterialCount/SetOutputMaterialCount in MappingImageSettings.
AddMaterialCasterByType Add a material caster by type name. Type name should undecorated base name of caster, for example "Color", "AmbientOcclusion", "Normal" etc. Material casting requires the mapping image generation to be enabled (SetGenerateMappingImage in MappingImageSettings returned by GetMappingImageSettings). If called with a material index set to non-zero, the mapping image for the corresponding output material will be used. See GetOutputMaterialCount/SetOutputMaterialCount in MappingImageSettings.
GetAggregationSettings The aggregation settings object for this pipeline.
GetBoolParameter Get a named parameter boolean value including parameter path.
GetCascadedPipelineByIndex The cascaded child pipeline object for the given index.
GetCascadedPipelineCount Get number of cascaded child pipelines.
GetClass Get the name of the AggregationPipeline class.
GetDoubleParameter Get a named parameter floating point value including parameter path.
GetEnumParameter Get a named parameter enum value as int including parameter path.
GetGenerateLightmapTexCoordSettings The settings object to create an extra set of TexCoord used for light mapping.
GetGeometryCullingSettings The geometry culling settings object for this pipeline.
GetIntParameter Get a named parameter integer value including parameter path.
GetMappingImage The mapping image from the performed remeshing. Should only be called after the pipeline has been run. The return value will be null if the pipeline does not use material casting and mapping images.
GetMappingImageSettings The mapping image settings object containing the mapping image settings for this pipeline. The return value will be null if the pipeline does not use material casting and mapping images.
GetMaterialCasters The material casters for the pipeline.
GetParameterType Get a named parameter data type including parameter path.
GetPercentDone Returns the current progress of the pipeline as a value between 0 and 100.
GetPipelineSettings The settings for the pipeline.
GetProcessedScene The resulting scene from the last execution of this pipeline.
GetStringParameter Get a named parameter string value including parameter path.
GetUIntParameter Get a named parameter unsigned integer value including parameter path.
GetVertexWeightSettings The vertex weight settings object for this pipeline.
GetVisibilitySettings The visibility settings object for this pipeline.
IsA Returns true if AggregationPipeline is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the AggregationPipeline object is invalid.
RemoveCascadedPipeline Remove a cascaded child pipeline.
RunScene Run the pipeline on the given scene, which will be modifed and contain the result of the pipeline when the function returns. Please note that internal refrences might be modified by the pipeline. The caller should refresh any reference that is cached outside the scene after running the pipeline.
RunSceneFromFile Run the pipeline on the scene loaded from the given input scene file, and optionally write the resulting scene to the given output scene file. If the scene is not written to file it can be accessed with the GetProcessedScene method. When using cascaded pipelines with RunSceneFromFile and the output file format does not support cascaded scenes (OBJ, FBX, glTF), only the scene from the first top level pipeline is exported to the output file.
SetBoolParameter Set a named parameter boolean value including parameter path.
SetDoubleParameter Set a named parameter floating point value including parameter path.
SetEnumParameter Set a named parameter enum value including parameter path.
SetIntParameter Set a named parameter integer value including parameter path.
SetParameterFromString Set a named parameter value including parameter path. The string will be parsed with best effort according to the parameter data type.
SetStringParameter Set a named parameter string value including parameter path.
SetUIntParameter Set a named parameter unsigned integer value including parameter path.

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

# Methods details

# AddCascadedPipeline

Add a cascaded child pipeline. The child pipeline will execute on the scene output from this pipeline.

    # AddMaterialCaster

    Add a material caster. Material casting requires the mapping image generation to be enabled (SetGenerateMappingImage in MappingImageSettings returned by GetMappingImageSettings). If called with a material index set to non-zero, the mapping image for the corresponding output material will be used. See GetOutputMaterialCount/SetOutputMaterialCount in MappingImageSettings.

      # AddMaterialCasterByType

      Add a material caster by type name. Type name should undecorated base name of caster, for example "Color", "AmbientOcclusion", "Normal" etc. Material casting requires the mapping image generation to be enabled (SetGenerateMappingImage in MappingImageSettings returned by GetMappingImageSettings). If called with a material index set to non-zero, the mapping image for the corresponding output material will be used. See GetOutputMaterialCount/SetOutputMaterialCount in MappingImageSettings.

        # GetAggregationSettings

        The aggregation settings object for this pipeline.

          # GetBoolParameter

          Get a named parameter boolean value including parameter path.

            # GetCascadedPipelineByIndex

            The cascaded child pipeline object for the given index.

              # GetCascadedPipelineCount

              Get number of cascaded child pipelines.

                # GetClass

                Get the name of the AggregationPipeline class.

                  # GetDoubleParameter

                  Get a named parameter floating point value including parameter path.

                    # GetEnumParameter

                    Get a named parameter enum value as int including parameter path.

                      # GetGenerateLightmapTexCoordSettings

                      The settings object to create an extra set of TexCoord used for light mapping.

                        # GetGeometryCullingSettings

                        The geometry culling settings object for this pipeline.

                          # GetIntParameter

                          Get a named parameter integer value including parameter path.

                            # GetMappingImage

                            The mapping image from the performed remeshing. Should only be called after the pipeline has been run. The return value will be null if the pipeline does not use material casting and mapping images.

                              # GetMappingImageSettings

                              The mapping image settings object containing the mapping image settings for this pipeline. The return value will be null if the pipeline does not use material casting and mapping images.

                                # GetMaterialCasters

                                The material casters for the pipeline.

                                  # GetParameterType

                                  Get a named parameter data type including parameter path.

                                    # GetPercentDone

                                    Returns the current progress of the pipeline as a value between 0 and 100.

                                      # GetPipelineSettings

                                      The settings for the pipeline.

                                        # GetProcessedScene

                                        The resulting scene from the last execution of this pipeline.

                                          # GetStringParameter

                                          Get a named parameter string value including parameter path.

                                            # GetUIntParameter

                                            Get a named parameter unsigned integer value including parameter path.

                                              # GetVertexWeightSettings

                                              The vertex weight settings object for this pipeline.

                                                # GetVisibilitySettings

                                                The visibility settings object for this pipeline.

                                                  # IsA

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

                                                    # IsNull

                                                    Returns true if the AggregationPipeline object is invalid.

                                                      # RemoveCascadedPipeline

                                                      Remove a cascaded child pipeline.

                                                        # RunScene

                                                        Run the pipeline on the given scene, which will be modifed and contain the result of the pipeline when the function returns. Please note that internal refrences might be modified by the pipeline. The caller should refresh any reference that is cached outside the scene after running the pipeline.

                                                          # RunSceneFromFile

                                                          Run the pipeline on the scene loaded from the given input scene file, and optionally write the resulting scene to the given output scene file. If the scene is not written to file it can be accessed with the GetProcessedScene method. When using cascaded pipelines with RunSceneFromFile and the output file format does not support cascaded scenes (OBJ, FBX, glTF), only the scene from the first top level pipeline is exported to the output file.

                                                            # SetBoolParameter

                                                            Set a named parameter boolean value including parameter path.

                                                              # SetDoubleParameter

                                                              Set a named parameter floating point value including parameter path.

                                                                # SetEnumParameter

                                                                Set a named parameter enum value including parameter path.

                                                                  # SetIntParameter

                                                                  Set a named parameter integer value including parameter path.

                                                                    # SetParameterFromString

                                                                    Set a named parameter value including parameter path. The string will be parsed with best effort according to the parameter data type.

                                                                      # SetStringParameter

                                                                      Set a named parameter string value including parameter path.

                                                                        # SetUIntParameter

                                                                        Set a named parameter unsigned integer value including parameter path.

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