`class` PipelineSettings

PipelineSettings is the interface used to manage settings for a pipeline

Properties

Property	Description
ApplyAttributeTessellation	Set flag to control if the pipeline should apply the tessellation in the AttributeTessellation fields in the geometries in the scene after processing.
CascadedRunMode	Set run mode to use for cascaded child pipelines.
DeduplicateVerticesOnImport	Removes redundant duplication of vertex data, so any vertices containing the exact same information are merged, and the triangle VertexIds field will be remapped to the new values. (Only used during GLTF import)
FlattenCascadedScene	If enabled the cascaded scenes are flattened in depth first order. Name clashes are removed by prefixing with _LOD[Index]. Where index is index of the scene after flattening. (Only valid for FBX files)
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.
MergeResultWithImportedFileOnExport	If enabled import file information is passed to the scene exporter for merging the contents of the import file into the resulting exported file.(Only used by FBXExporter).
Name	The name of the PipelineSettings object. (Inherited from Object)
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.
ReferenceExportMode	Export mode for referenced external files in the scene, such as references to textures. File formats which do not support external references will ignore the setting and always embed the data.
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
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBoolParameter	Get a named parameter boolean value. (Inherited from SettingsObject)
GetClass	Get the name of the PipelineSettings class. (Inherited from Object)
GetDoubleParameter	Get a named parameter floating point value. (Inherited from SettingsObject)
GetErrorString	Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetIntParameter	Get a named parameter integer value. (Inherited from SettingsObject)
GetStringParameter	Get a named parameter string value. (Inherited from SettingsObject)
GetUIntParameter	Get a named parameter unsigned integer value. (Inherited from SettingsObject)
IsA	Returns true if PipelineSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the PipelineSettings object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the PipelineSettings object is valid. (Inherited from Object)
NonNull	Returns true if the PipelineSettings object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the PipelineSettings object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetBoolParameter	Set a named parameter boolean value. (Inherited from SettingsObject)
SetDoubleParameter	Set a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameter	Set a named parameter integer value. (Inherited from SettingsObject)
SetStringParameter	Set a named parameter string value. (Inherited from SettingsObject)
SetUIntParameter	Set a named parameter unsigned integer value. (Inherited from SettingsObject)
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. (Inherited from SettingsObject)
ToJSON	Get settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettings	Validates the current settings values. (Inherited from SettingsObject)

Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
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. (Inherited from Object)

Properties details

ApplyAttributeTessellation

Set flag to control if the pipeline should apply the tessellation in the AttributeTessellation fields in the geometries in the scene after processing.

Type	Name	Min	Max	Description
`bool`	value			ApplyAttributeTessellation flag.

Type	Name	Min	Max	Description
`bool`	value			ApplyAttributeTessellation flag.

Name	Type	Min	Max	Description
value	`bool`			ApplyAttributeTessellation flag.

CascadedRunMode

Set run mode to use for cascaded child pipelines.

Type	Name	Min	Max	Description
EPipelineRunMode	value			Run mode for cascaded child pipelines.

Key	Value	Comment
RunInThisProcess	0	Run the pipeline in this process
RunInNewProcess	1	Run the pipeline in a new process using the batch executor tool
RunDistributedUsingSimplygonGrid	2	Run the pipeline distributed using SimplygonGrid
RunDistributedUsingIncredibuild	3	Run the pipeline distributed using IncrediBuild
RunDistributedUsingFastbuild	4	Run the pipeline distributed using Fastbuild

Type	Name	Min	Max	Description
EPipelineRunMode	value			Run mode for cascaded child pipelines.

Key	Value	Comment
RunInThisProcess	0	Run the pipeline in this process
RunInNewProcess	1	Run the pipeline in a new process using the batch executor tool
RunDistributedUsingSimplygonGrid	2	Run the pipeline distributed using SimplygonGrid
RunDistributedUsingIncredibuild	3	Run the pipeline distributed using IncrediBuild
RunDistributedUsingFastbuild	4	Run the pipeline distributed using Fastbuild

Name	Type	Min	Max	Description
value	EPipelineRunMode			Run mode for cascaded child pipelines.

Key	Value	Comment
EPipelineRunMode_RunInThisProcess	0	Run the pipeline in this process
EPipelineRunMode_RunInNewProcess	1	Run the pipeline in a new process using the batch executor tool
EPipelineRunMode_RunDistributedUsingSimplygonGrid	2	Run the pipeline distributed using SimplygonGrid
EPipelineRunMode_RunDistributedUsingIncredibuild	3	Run the pipeline distributed using IncrediBuild
EPipelineRunMode_RunDistributedUsingFastbuild	4	Run the pipeline distributed using Fastbuild

DeduplicateVerticesOnImport

Removes redundant duplication of vertex data, so any vertices containing the exact same information are merged, and the triangle VertexIds field will be remapped to the new values. (Only used during GLTF import)

Type	Name	Min	Max	Description
`bool`	value			True to run deduplication pass for vertices (Only used during GLTF import)

Type	Name	Min	Max	Description
`bool`	value			True to run deduplication pass for vertices (Only used during GLTF import)

Name	Type	Min	Max	Description
value	`bool`			True to run deduplication pass for vertices (Only used during GLTF import)

FlattenCascadedScene

If enabled the cascaded scenes are flattened in depth first order. Name clashes are removed by prefixing with _LOD[Index]. Where index is index of the scene after flattening. (Only valid for FBX files)

Type	Name	Min	Max	Description
`bool`	toggle			Enable/disable flattening of cascaded scenes.

Type	Name	Min	Max	Description
`bool`	toggle			Enable/disable flattening of cascaded scenes.

Name	Type	Min	Max	Description
toggle	`bool`			Enable/disable flattening of cascaded scenes.

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.

Type	Name	Min	Max	Description
`bool`	value			Intermediate step flag.

Type	Name	Min	Max	Description
`bool`	value			Intermediate step flag.

Name	Type	Min	Max	Description
value	`bool`			Intermediate step flag.

MergeResultWithImportedFileOnExport

If enabled import file information is passed to the scene exporter for merging the contents of the import file into the resulting exported file.(Only used by FBXExporter).

Type	Name	Min	Max	Description
`bool`	toggle			The toggle to enable/disable merging in source data into exported file.

Type	Name	Min	Max	Description
`bool`	toggle			The toggle to enable/disable merging in source data into exported file.

Name	Type	Min	Max	Description
toggle	`bool`			The toggle to enable/disable merging in source data into exported file.

Name

The name of the PipelineSettings object. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

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.

Type	Name	Min	Max	Description
`const char *`	value			Output material name.

Type	Name	Min	Max	Description
`string`	value			Output material name.

Name	Type	Min	Max	Description
value	`str`			Output material name.

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.

Type	Name	Min	Max	Description
`bool`	value			Flag controlling if material names are unique or sequential.

Type	Name	Min	Max	Description
`bool`	value			Flag controlling if material names are unique or sequential.

Name	Type	Min	Max	Description
value	`bool`			Flag controlling if material names are unique or sequential.

ReferenceExportMode

Export mode for referenced external files in the scene, such as references to textures. File formats which do not support external references will ignore the setting and always embed the data.

Type	Name	Min	Max	Description
EReferenceExportMode	value			Export mode value.

Key	Value	Comment
Copy	0	Copy the referenced file to the export folder, and have a relative path point at the reference.
Embed	1	Embed the referenced file in the exported scene. This is only applicable to file formats which support embedding referenced files. File formats which do not support embedded references will instead default to copy the file to the output.
AbsolutePath	2	Output the absolute path to the referenced file. This avoids copying the reference to the output. Node that this path is not portable across file systems, and will reference an absolute path on the current machine. If a reference is embedded, this setting will be ignored and a copy of the file is placed in the output path.
OriginalPath	3	Keep the original path value. This mode just copies the FilePath value verbatim to the output, and does not make sure the referenced file actually exists. If a reference is embedded, this setting will be ignored and a copy of the file is placed in the output path.

Type	Name	Min	Max	Description
EReferenceExportMode	value			Export mode value.

Key	Value	Comment
Copy	0	Copy the referenced file to the export folder, and have a relative path point at the reference.
Embed	1	Embed the referenced file in the exported scene. This is only applicable to file formats which support embedding referenced files. File formats which do not support embedded references will instead default to copy the file to the output.
AbsolutePath	2	Output the absolute path to the referenced file. This avoids copying the reference to the output. Node that this path is not portable across file systems, and will reference an absolute path on the current machine. If a reference is embedded, this setting will be ignored and a copy of the file is placed in the output path.
OriginalPath	3	Keep the original path value. This mode just copies the FilePath value verbatim to the output, and does not make sure the referenced file actually exists. If a reference is embedded, this setting will be ignored and a copy of the file is placed in the output path.

Name	Type	Min	Max	Description
value	EReferenceExportMode			Export mode value.

Key	Value	Comment
EReferenceExportMode_Copy	0	Copy the referenced file to the export folder, and have a relative path point at the reference.
EReferenceExportMode_Embed	1	Embed the referenced file in the exported scene. This is only applicable to file formats which support embedding referenced files. File formats which do not support embedded references will instead default to copy the file to the output.
EReferenceExportMode_AbsolutePath	2	Output the absolute path to the referenced file. This avoids copying the reference to the output. Node that this path is not portable across file systems, and will reference an absolute path on the current machine. If a reference is embedded, this setting will be ignored and a copy of the file is placed in the output path.
EReferenceExportMode_OriginalPath	3	Keep the original path value. This mode just copies the FilePath value verbatim to the output, and does not make sure the referenced file actually exists. If a reference is embedded, this setting will be ignored and a copy of the file is placed in the output path.

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.

Type	Name	Min	Max	Description
`const char *`	value			Path where SimplygonBatch executable is located.

Type	Name	Min	Max	Description
`string`	value			Path where SimplygonBatch executable is located.

Name	Type	Min	Max	Description
value	`str`			Path where SimplygonBatch executable is located.

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.

Type	Name	Min	Max	Description
`const char *`	value			Path where created textures will be saved.

Type	Name	Min	Max	Description
`string`	value			Path where created textures will be saved.

Name	Type	Min	Max	Description
value	`str`			Path where created textures will be saved.

Methods details

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

GetBoolParameter

Get a named parameter boolean value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

GetClass

Get the name of the PipelineSettings class. (Inherited from Object)

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. (Inherited from Object)

IsNull

Returns true if the PipelineSettings object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the PipelineSettings object is valid. (Inherited from Object)

NonNull

Returns true if the PipelineSettings object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the PipelineSettings object to the log. (Inherited from Object)

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

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. (Inherited from Object)

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. (Inherited from Object)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class PipelineSettings ​

Properties ​

Methods ​

Static methods ​

Properties details ​

ApplyAttributeTessellation ​

CascadedRunMode ​

DeduplicateVerticesOnImport ​

FlattenCascadedScene ​

IntermediateStep ​

MergeResultWithImportedFileOnExport ​

Name ​

OutputMaterialName ​

OutputUniqueMaterialNames ​

ReferenceExportMode ​