# `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.
GetActiveSelectionSets	Get the names of all currently active selection sets used by this pipeline, based on the current settings
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.
GetMaterialCasterByIndex	Get the material caster in the pipeline for the given index, which must be less than the material caster count.
GetMaterialCasterCount	Get the number of material casters for the pipeline.
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.

Type	Name	Min	Max	Description
`Pipeline`	pipeline			The pipeline to add as a cascaded child pipeline.

Type	Name	Min	Max	Description
`Pipeline`	pipeline			The pipeline to add as a cascaded child pipeline.

Name	Type	Min	Max	Description
pipeline	`Pipeline`			The pipeline to add as a cascaded child 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.

Type	Name	Min	Max	Description
MaterialCaster	MaterialCaster			The material caster to add.
`unsigned int`	MaterialIndex			The material index the caster will be associated with, 0 for first material.

Type	Name	Min	Max	Description
MaterialCaster	MaterialCaster			The material caster to add.
`uint`	MaterialIndex			The material index the caster will be associated with, 0 for first material.

Name	Type	Min	Max	Description
MaterialCaster	MaterialCaster			The material caster to add.
MaterialIndex	`int`			The material index the caster will be associated with, 0 for first material.

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

Type	Name	Min	Max	Description
`const char *`	CasterType			Caster type name, like "Color", "AmbientOcclusion", "Normal" or similar.
`unsigned int`	MaterialIndex			The material index the caster will be associated with, 0 for first material.

Type	Name	Min	Max	Description
`string`	CasterType			Caster type name, like "Color", "AmbientOcclusion", "Normal" or similar.
`uint`	MaterialIndex			The material index the caster will be associated with, 0 for first material.

Name	Type	Min	Max	Description
CasterType	`str`			Caster type name, like "Color", "AmbientOcclusion", "Normal" or similar.
MaterialIndex	`int`			The material index the caster will be associated with, 0 for first material.

# GetActiveSelectionSets

Get the names of all currently active selection sets used by this pipeline, based on the current settings

Type	Name	Min	Max	Description
StringArray	sets			The array recieving unique names of all selection sets being used by this pipeline.

Type	Name	Min	Max	Description
StringArray	sets			The array recieving unique names of all selection sets being used by this pipeline.

Name	Type	Min	Max	Description
sets	StringArray			The array recieving unique names of all selection sets being used by this pipeline.

# GetAggregationSettings

The aggregation settings object for this pipeline.

# GetBoolParameter

Get a named parameter boolean value including parameter path.

Type	Name	Min	Max	Description
`const char *`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Type	Name	Min	Max	Description
`string`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

# GetCascadedPipelineByIndex

The cascaded child pipeline object for the given index.

Type	Name	Min	Max	Description
`unsigned int`	index			The index of the cascaded child pipeline.

Type	Name	Min	Max	Description
`uint`	index			The index of the cascaded child pipeline.

Name	Type	Min	Max	Description
index	`int`			The index of the cascaded child pipeline.

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

Type	Name	Min	Max	Description
`const char *`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Type	Name	Min	Max	Description
`string`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

# GetEnumParameter

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

Type	Name	Min	Max	Description
`const char *`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Type	Name	Min	Max	Description
`string`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

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

Type	Name	Min	Max	Description
`const char *`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Type	Name	Min	Max	Description
`string`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

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

Type	Name	Min	Max	Description
`unsigned int`	materialIndex			The index of the output material to get the mapping image for.

Type	Name	Min	Max	Description
`uint`	materialIndex			The index of the output material to get the mapping image for.

Name	Type	Min	Max	Description
materialIndex	`int`			The index of the output material to get the mapping image for.

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

# GetMaterialCasterByIndex

Get the material caster in the pipeline for the given index, which must be less than the material caster count.

Type	Name	Min	Max	Description
`unsigned int`	index	0	MaterialCasterCount	Material caster index, must be less than the material caster count.

Type	Name	Min	Max	Description
`uint`	index	0	MaterialCasterCount	Material caster index, must be less than the material caster count.

Name	Type	Min	Max	Description
index	`int`	0	MaterialCasterCount	Material caster index, must be less than the material caster count.

# GetMaterialCasterCount

Get the number of material casters for the pipeline.

# GetMaterialCasters

The material casters for the pipeline.

# GetParameterType

Get a named parameter data type including parameter path.

Type	Name	Min	Max	Description
`const char *`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Key	Value	Comment
Invalid	0	Invalid settings value type.
Bool	1	Bool settings type.
Int	2	Int settings type.
Uint	3	Unsigned int settings type.
Double	4	Double floating point settings type.
String	5	String settings type.
EPipelineRunMode	6	EPipelineRunMode settings type.
EChartAggregatorMode	8	EChartAggregatorMode settings type.
ETexcoordGeneratorType	9	ETexcoordGeneratorType settings type.
EOcclusionMode	10	EOcclusionMode settings type.
EStopCondition	11	EStopCondition settings type.
EDataCreationPreferences	12	EDataCreationPreferences settings type.
EReductionHeuristics	13	EReductionHeuristics settings type.
EWeightsFromColorMode	14	EWeightsFromColorMode settings type.
ESurfaceTransferMode	15	ESurfaceTransferMode settings type.
ERemeshingMode	16	ERemeshingMode settings type.
ETangentSpaceMethod	17	ETangentSpaceMethod settings type.
EGeometryDataFieldType	18	EGeometryDataFieldType settings type.
EAtlasFillMode	19	EAtlasFillMode settings type.
EDitherPatterns	20	EDitherPatterns settings type.
EComputeVisibilityMode	21	EComputeVisibilityMode settings type.
ESurfaceAreaScale	22	ESurfaceAreaScale settings type.
EImpostorType	23	EImpostorType settings type.
ESymmetryAxis	24	ESymmetryAxis settings type.
EPixelFormat	25	EPixelFormat settings type.
EColorComponent	26	EColorComponent settings type.
EHoleFilling	27	EHoleFilling settings type.
EImageInputFormat	28	EImageInputFormat settings type.
EImageOutputFormat	29	EImageOutputFormat settings type.
EDDSCompressionType	30	EDDSCompressionType settings type.
EBillboardMode	31	EBillboardMode settings type.
EOpacityType	32	EOpacityType settings type.

Type	Name	Min	Max	Description
`string`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Key	Value	Comment
Invalid	0	Invalid settings value type.
Bool	1	Bool settings type.
Int	2	Int settings type.
Uint	3	Unsigned int settings type.
Double	4	Double floating point settings type.
String	5	String settings type.
EPipelineRunMode	6	EPipelineRunMode settings type.
EChartAggregatorMode	8	EChartAggregatorMode settings type.
ETexcoordGeneratorType	9	ETexcoordGeneratorType settings type.
EOcclusionMode	10	EOcclusionMode settings type.
EStopCondition	11	EStopCondition settings type.
EDataCreationPreferences	12	EDataCreationPreferences settings type.
EReductionHeuristics	13	EReductionHeuristics settings type.
EWeightsFromColorMode	14	EWeightsFromColorMode settings type.
ESurfaceTransferMode	15	ESurfaceTransferMode settings type.
ERemeshingMode	16	ERemeshingMode settings type.
ETangentSpaceMethod	17	ETangentSpaceMethod settings type.
EGeometryDataFieldType	18	EGeometryDataFieldType settings type.
EAtlasFillMode	19	EAtlasFillMode settings type.
EDitherPatterns	20	EDitherPatterns settings type.
EComputeVisibilityMode	21	EComputeVisibilityMode settings type.
ESurfaceAreaScale	22	ESurfaceAreaScale settings type.
EImpostorType	23	EImpostorType settings type.
ESymmetryAxis	24	ESymmetryAxis settings type.
EPixelFormat	25	EPixelFormat settings type.
EColorComponent	26	EColorComponent settings type.
EHoleFilling	27	EHoleFilling settings type.
EImageInputFormat	28	EImageInputFormat settings type.
EImageOutputFormat	29	EImageOutputFormat settings type.
EDDSCompressionType	30	EDDSCompressionType settings type.
EBillboardMode	31	EBillboardMode settings type.
EOpacityType	32	EOpacityType settings type.

# Syntax

ESettingValueType_* GetParameterType(name: str)

# Parameters

Name	Type	Min	Max	Description
name	`str`			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

# Return value

Type: ESettingValueType

Key	Value	Comment
ESettingValueType_Invalid	0	Invalid settings value type.
ESettingValueType_Bool	1	Bool settings type.
ESettingValueType_Int	2	Int settings type.
ESettingValueType_Uint	3	Unsigned int settings type.
ESettingValueType_Double	4	Double floating point settings type.
ESettingValueType_String	5	String settings type.
ESettingValueType_EPipelineRunMode	6	EPipelineRunMode settings type.
ESettingValueType_EChartAggregatorMode	8	EChartAggregatorMode settings type.
ESettingValueType_ETexcoordGeneratorType	9	ETexcoordGeneratorType settings type.
ESettingValueType_EOcclusionMode	10	EOcclusionMode settings type.
ESettingValueType_EStopCondition	11	EStopCondition settings type.
ESettingValueType_EDataCreationPreferences	12	EDataCreationPreferences settings type.
ESettingValueType_EReductionHeuristics	13	EReductionHeuristics settings type.
ESettingValueType_EWeightsFromColorMode	14	EWeightsFromColorMode settings type.
ESettingValueType_ESurfaceTransferMode	15	ESurfaceTransferMode settings type.
ESettingValueType_ERemeshingMode	16	ERemeshingMode settings type.
ESettingValueType_ETangentSpaceMethod	17	ETangentSpaceMethod settings type.
ESettingValueType_EGeometryDataFieldType	18	EGeometryDataFieldType settings type.
ESettingValueType_EAtlasFillMode	19	EAtlasFillMode settings type.
ESettingValueType_EDitherPatterns	20	EDitherPatterns settings type.
ESettingValueType_EComputeVisibilityMode	21	EComputeVisibilityMode settings type.
ESettingValueType_ESurfaceAreaScale	22	ESurfaceAreaScale settings type.
ESettingValueType_EImpostorType	23	EImpostorType settings type.
ESettingValueType_ESymmetryAxis	24	ESymmetryAxis settings type.
ESettingValueType_EPixelFormat	25	EPixelFormat settings type.
ESettingValueType_EColorComponent	26	EColorComponent settings type.
ESettingValueType_EHoleFilling	27	EHoleFilling settings type.
ESettingValueType_EImageInputFormat	28	EImageInputFormat settings type.
ESettingValueType_EImageOutputFormat	29	EImageOutputFormat settings type.
ESettingValueType_EDDSCompressionType	30	EDDSCompressionType settings type.
ESettingValueType_EBillboardMode	31	EBillboardMode settings type.
ESettingValueType_EOpacityType	32	EOpacityType settings type.

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

Type	Name	Min	Max	Description
`const char *`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Type	Name	Min	Max	Description
`string`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

# GetUIntParameter

Get a named parameter unsigned integer value including parameter path.

Type	Name	Min	Max	Description
`const char *`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

Type	Name	Min	Max	Description
`string`	name			Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries".

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

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if AggregationPipeline is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if AggregationPipeline is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if AggregationPipeline is, or is a descendant of.

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

← MappingImageMeshData BillboardCloudPipeline →

Type	Name	Min	Max	Description
Scene	scene			The scene to run the pipeline on.
EPipelineRunMode	run_mode			Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum).

Type	Name	Description
`const char *`	input_scene	The file path of the input scene file.
`const char *`	output_scene	The file path of the output scene file (can be null)
EPipelineRunMode	run_mode	Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum).

# class AggregationPipeline