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.
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.
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
GetClass Get the name of the PipelineSettings class.
GetErrorString Returns a string describing the error that was found the last time ValidateSettings was performed.
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.
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.

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

        # 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

            # GetClass

            Get the name of the PipelineSettings class.

              # GetErrorString

              Returns a string describing the error that was found the last time ValidateSettings was performed.

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

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