Simplygon 9 Documentation

# class PipelineSettings

PipelineSettings is the interface used to manage settings for a pipeline

# Properties

Property Description
CascadedRunMode Set run mode to use for cascaded child pipelines.
EmbedReferences Set flag to control if output file formats that support embedding referenced resources (like textures) should do so.
IntermediateStep Set flag to control if this pipeline step is an intermediate step where the processed scene is only used as input to the next cascaded pipeline and not for export or further access. This will discard any processed data once all cascaded pipelines are done, and the scene will be ignored during export. Useful if you want to group two pipelines together for one output, for example an aggregation and a reduction pipeline where you only want the output from the combined aggregation + reduction.
OutputMaterialName The name of the output material. If the output material count is greater than one, an index separated with an underscore will be appended to the material names, such that MyMaterial becomes MyMaterial_0, MyMaterial_1 and so on.
OutputUniqueMaterialNames Generate unique material names if set to true, by replacing the default scheme of appending a sequential material index to the name with appending a GUID. This will make the material names unique each time the pipeline is run, even on the same input scene.
SimplygonBatchPath The path for the batch tool used when executing pipelines in a new/distributed process. This should be the path to the directory where the SimplygonBatch executable is located. If the tool is in the system path this setting should be an empty string.
TextureOutputPath The path where the pipeline will save any created textures from material casters. A relative path will be treated as relative to the scene file output path if the pipeline is executed with scene file paths (RunSceneFromFile), or from the current working directory if the pipeline is executed with a scene object (RunScene). The directory must exist, it will not be created.

# Methods

Method Description
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the PipelineSettings 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 PipelineSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the PipelineSettings 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 spPipelineSettings, and if this is the case, returns the object cast into spPipelineSettings.

# Properties details

# CascadedRunMode

Set run mode to use for cascaded child pipelines.

    # EmbedReferences

    Set flag to control if output file formats that support embedding referenced resources (like textures) should do so.

      # IntermediateStep

      Set flag to control if this pipeline step is an intermediate step where the processed scene is only used as input to the next cascaded pipeline and not for export or further access. This will discard any processed data once all cascaded pipelines are done, and the scene will be ignored during export. Useful if you want to group two pipelines together for one output, for example an aggregation and a reduction pipeline where you only want the output from the combined aggregation + reduction.

        # OutputMaterialName

        The name of the output material. If the output material count is greater than one, an index separated with an underscore will be appended to the material names, such that MyMaterial becomes MyMaterial_0, MyMaterial_1 and so on.

          # OutputUniqueMaterialNames

          Generate unique material names if set to true, by replacing the default scheme of appending a sequential material index to the name with appending a GUID. This will make the material names unique each time the pipeline is run, even on the same input scene.

            # SimplygonBatchPath

            The path for the batch tool used when executing pipelines in a new/distributed process. This should be the path to the directory where the SimplygonBatch executable is located. If the tool is in the system path this setting should be an empty string.

              # TextureOutputPath

              The path where the pipeline will save any created textures from material casters. A relative path will be treated as relative to the scene file output path if the pipeline is executed with scene file paths (RunSceneFromFile), or from the current working directory if the pipeline is executed with a scene object (RunScene). The directory must exist, it will not be created.

                # Methods details

                # GetBoolParameter

                Get a named parameter boolean value.

                  # GetClass

                  Get the name of the PipelineSettings 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 PipelineSettings is a or is a descendant of the class named as the type parameter.

                                # IsNull

                                Returns true if the PipelineSettings 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 spPipelineSettings, and if this is the case, returns the object cast into spPipelineSettings.

                                                      ← ReductionSettings →