class AggregationPipeline
AggregationPipeline provides a pipeline for a single aggregation processor to be applied on the input scene.
Properties
| Property | Description |
|---|
| Name | The name of the AggregationPipeline object. (Inherited from Object) |
Methods
| Method | Description |
|---|
| AddCascadedPipeline | Add a cascaded child pipeline. The child pipeline will execute on the scene output from this pipeline. (Inherited from 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. (Inherited from Pipeline) |
| 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. (Inherited from Pipeline) |
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetActiveSelectionSets | Get the names of all currently active selection sets used by this pipeline, based on the current settings (Inherited from Pipeline) |
| GetAggregationSettings | The aggregation settings object for this pipeline. |
| GetAttributeTessellationSettings | The settings for handling attribute tessellation of the output scene. |
| GetBoolParameter | Get a named parameter boolean value including parameter path. (Inherited from Pipeline) |
| GetCascadedPipelineByIndex | The cascaded child pipeline object for the given index. (Inherited from Pipeline) |
| GetCascadedPipelineCount | Get number of cascaded child pipelines. (Inherited from Pipeline) |
| GetClass | Get the name of the AggregationPipeline class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value including parameter path. (Inherited from Pipeline) |
| GetEnumParameter | Get a named parameter enum value as int including parameter path. (Inherited from Pipeline) |
| 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. (Inherited from Pipeline) |
| 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. (Inherited from Pipeline) |
| 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. (Inherited from Pipeline) |
| GetMaterialCasterByIndex | Get the material caster in the pipeline for the given index, which must be less than the material caster count. (Inherited from Pipeline) |
| GetMaterialCasterCount | Get the number of material casters for the pipeline. (Inherited from Pipeline) |
| GetMaterialCasters | The material casters for the pipeline. (Inherited from Pipeline) |
| GetParameterType | Get a named parameter data type including parameter path. (Inherited from Pipeline) |
| GetPercentDone | Returns the current progress of the pipeline as a value between 0 and 100. (Inherited from Pipeline) |
| GetPipelineSettings | The settings for the pipeline. (Inherited from Pipeline) |
| GetProcessedScene | The resulting scene from the last execution of this pipeline. (Inherited from Pipeline) |
| GetStringParameter | Get a named parameter string value including parameter path. (Inherited from Pipeline) |
| GetUIntParameter | Get a named parameter unsigned integer value including parameter path. (Inherited from Pipeline) |
| GetVertexWeightSettings | The vertex weight settings object for this pipeline. |
| GetVisibilitySettings | The settings for handling visibility weights. Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it. |
| IsA | Returns true if AggregationPipeline is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the AggregationPipeline object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the AggregationPipeline object is valid. (Inherited from Object) |
| NewCopy | Create a new clone of the pipeline, copying all settings and material casters as well as creating new copies of all cascaded pipelines. (Inherited from Pipeline) |
| NonNull | Returns true if the AggregationPipeline object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the AggregationPipeline object to the log. (Inherited from Object) |
| RemoveCascadedPipeline | Remove a cascaded child pipeline. (Inherited from Pipeline) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunScene | Run the pipeline on the given scene, which will be modified and contain the result of the pipeline when the function returns. Please note that internal references might be modified by the pipeline. The caller should refresh any reference that is cached outside the scene after running the pipeline. (Inherited from 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. (Inherited from Pipeline) |
| SetBoolParameter | Set a named parameter boolean value including parameter path. (Inherited from Pipeline) |
| SetDoubleParameter | Set a named parameter floating point value including parameter path. (Inherited from Pipeline) |
| SetEnumParameter | Set a named parameter enum value including parameter path. (Inherited from Pipeline) |
| SetIntParameter | Set a named parameter integer value including parameter path. (Inherited from Pipeline) |
| SetParameterFromString | Set a named parameter value including parameter path. The string will be parsed with best effort according to the parameter data type. (Inherited from Pipeline) |
| SetStringParameter | Set a named parameter string value including parameter path. (Inherited from Pipeline) |
| SetUIntParameter | Set a named parameter unsigned integer value including parameter path. (Inherited from Pipeline) |
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 spAggregationPipeline, and if this is the case, returns the object cast into spAggregationPipeline. (Inherited from Object) |
Properties details
Name
The name of the AggregationPipeline object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
Methods details
AddCascadedPipeline
Add a cascaded child pipeline. The child pipeline will execute on the scene output from this pipeline.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Pipeline | pipeline | | | The pipeline to add as a cascaded child pipeline. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Pipeline | pipeline | | | The pipeline to add as a cascaded child pipeline. |
Syntax
Parameters
| 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.
Syntax
Parameters
| 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. |
Syntax
Parameters
| 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. |
Syntax
Parameters
| 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.
Syntax
Parameters
| 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. |
Return value
Type: MaterialCaster
Syntax
Parameters
| 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. |
Return value
Type: MaterialCaster
Syntax
Parameters
| 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. |
Return value
Type: MaterialCaster
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
GetActiveSelectionSets
Get the names of all currently active selection sets used by this pipeline, based on the current settings
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| StringArray | sets | | | The array recieving unique names of all selection sets being used by this pipeline. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| StringArray | sets | | | The array recieving unique names of all selection sets being used by this pipeline. |
Syntax
Parameters
| 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.
Syntax
Parameters
GetAggregationSettings takes no parameters.
Return value
Type: AggregationSettings
Syntax
Parameters
GetAggregationSettings takes no parameters.
Return value
Type: AggregationSettings
Syntax
Parameters
GetAggregationSettings takes no parameters.
Return value
Type: AggregationSettings
GetAttributeTessellationSettings
The settings for handling attribute tessellation of the output scene.
GetBoolParameter
Get a named parameter boolean value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: bool
GetCascadedPipelineByIndex
The cascaded child pipeline object for the given index.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | index | | | The index of the cascaded child pipeline. |
Return value
Type: Pipeline
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
uint | index | | | The index of the cascaded child pipeline. |
Return value
Type: Pipeline
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| index | int | | | The index of the cascaded child pipeline. |
Return value
Type: Pipeline
GetCascadedPipelineCount
Get number of cascaded child pipelines.
Syntax
Parameters
GetCascadedPipelineCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetCascadedPipelineCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetCascadedPipelineCount takes no parameters.
Return value
Type: int
GetClass
Get the name of the AggregationPipeline class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetDoubleParameter
Get a named parameter floating point value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: double
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: float
GetEnumParameter
Get a named parameter enum value as int including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: int
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: int
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | materialIndex | | | The index of the output material to get the mapping image for. |
Return value
Type: MappingImage
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
uint | materialIndex | | | The index of the output material to get the mapping image for. |
Return value
Type: MappingImage
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| materialIndex | int | | | The index of the output material to get the mapping image for. |
Return value
Type: MappingImage
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.
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
Syntax
Parameters
GetMappingImageSettings takes no parameters.
Return value
Type: MappingImageSettings
GetMaterialCasterByIndex
Get the material caster in the pipeline for the given index, which must be less than the material caster count.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | index | 0 | MaterialCasterCount | Material caster index, must be less than the material caster count. |
Return value
Type: MaterialCaster
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
uint | index | 0 | MaterialCasterCount | Material caster index, must be less than the material caster count. |
Return value
Type: MaterialCaster
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| index | int | 0 | MaterialCasterCount | Material caster index, must be less than the material caster count. |
Return value
Type: MaterialCaster
GetMaterialCasterCount
Get the number of material casters for the pipeline.
Syntax
Parameters
GetMaterialCasterCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetMaterialCasterCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetMaterialCasterCount takes no parameters.
Return value
Type: int
GetMaterialCasters
The material casters for the pipeline.
Syntax
Parameters
GetMaterialCasters takes no parameters.
Return value
Type: ObjectCollection
Syntax
Parameters
GetMaterialCasters takes no parameters.
Return value
Type: ObjectCollection
Syntax
Parameters
GetMaterialCasters takes no parameters.
Return value
Type: ObjectCollection
GetParameterType
Get a named parameter data type including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: ESettingValueType
| 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. |
| EInputSceneValidationActionType | 33 | EInputSceneValidationActionType settings type. |
| EAttributeTessellationDensityMode | 34 | EAttributeTessellationDensityMode settings type. |
| EBlendOperation | 35 | EBlendOperation settings type. |
| EAttributeFormat | 36 | EAttributeFormat settings type. |
| ETransformationSpace | 37 | ETransformationSpace settings type. |
| EReferenceExportMode | 38 | EReferenceExportMode settings type. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: ESettingValueType
| 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. |
| EInputSceneValidationActionType | 33 | EInputSceneValidationActionType settings type. |
| EAttributeTessellationDensityMode | 34 | EAttributeTessellationDensityMode settings type. |
| EBlendOperation | 35 | EBlendOperation settings type. |
| EAttributeFormat | 36 | EAttributeFormat settings type. |
| ETransformationSpace | 37 | ETransformationSpace settings type. |
| EReferenceExportMode | 38 | EReferenceExportMode settings type. |
Syntax
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. |
| ESettingValueType_EInputSceneValidationActionType | 33 | EInputSceneValidationActionType settings type. |
| ESettingValueType_EAttributeTessellationDensityMode | 34 | EAttributeTessellationDensityMode settings type. |
| ESettingValueType_EBlendOperation | 35 | EBlendOperation settings type. |
| ESettingValueType_EAttributeFormat | 36 | EAttributeFormat settings type. |
| ESettingValueType_ETransformationSpace | 37 | ETransformationSpace settings type. |
| ESettingValueType_EReferenceExportMode | 38 | EReferenceExportMode settings type. |
GetPercentDone
Returns the current progress of the pipeline as a value between 0 and 100.
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: real
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
GetPipelineSettings
The settings for the pipeline.
Syntax
Parameters
GetPipelineSettings takes no parameters.
Return value
Type: PipelineSettings
Syntax
Parameters
GetPipelineSettings takes no parameters.
Return value
Type: PipelineSettings
Syntax
Parameters
GetPipelineSettings takes no parameters.
Return value
Type: PipelineSettings
GetProcessedScene
The resulting scene from the last execution of this pipeline.
Syntax
Parameters
GetProcessedScene takes no parameters.
Return value
Type: Scene
Syntax
Parameters
GetProcessedScene takes no parameters.
Return value
Type: Scene
Syntax
Parameters
GetProcessedScene takes no parameters.
Return value
Type: Scene
GetStringParameter
Get a named parameter string value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
Return value
Type: int
GetVertexWeightSettings
The vertex weight settings object for this pipeline.
Syntax
Parameters
GetVertexWeightSettings takes no parameters.
Return value
Type: VertexWeightSettings
Syntax
Parameters
GetVertexWeightSettings takes no parameters.
Return value
Type: VertexWeightSettings
Syntax
Parameters
GetVertexWeightSettings takes no parameters.
Return value
Type: VertexWeightSettings
GetVisibilitySettings
The settings for handling visibility weights. Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it.
Syntax
Parameters
GetVisibilitySettings takes no parameters.
Return value
Type: VisibilitySettings
Syntax
Parameters
GetVisibilitySettings takes no parameters.
Return value
Type: VisibilitySettings
Syntax
Parameters
GetVisibilitySettings takes no parameters.
Return value
Type: VisibilitySettings
IsA
Returns true if AggregationPipeline is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if AggregationPipeline is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if AggregationPipeline is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if AggregationPipeline is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the AggregationPipeline object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the AggregationPipeline object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NewCopy
Create a new clone of the pipeline, copying all settings and material casters as well as creating new copies of all cascaded pipelines.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: Pipeline
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: Pipeline
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
Return value
Type: Pipeline
NonNull
Returns true if the AggregationPipeline object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the AggregationPipeline object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveCascadedPipeline
Remove a cascaded child pipeline.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Pipeline | pipeline | | | The pipeline to remove from list of cascaded child pipelines. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Pipeline | pipeline | | | The pipeline to remove from list of cascaded child pipelines. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| pipeline | Pipeline | | | The pipeline to remove from list of cascaded child pipelines. |
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
RunScene
Run the pipeline on the given scene, which will be modified and contain the result of the pipeline when the function returns. Please note that internal references might be modified by the pipeline. The caller should refresh any reference that is cached outside the scene after running the pipeline.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | scene | | | The scene to run the pipeline on. |
| EPipelineRunMode | runMode | | | Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum). |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | scene | | | The scene to run the pipeline on. |
| EPipelineRunMode | runMode | | | Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum). |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| scene | Scene | | | The scene to run the pipeline on. |
| runMode | EPipelineRunMode | | | Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum). |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| EErrorCodes_NoError | 0 | No error, the initialization or process has finished, and with no errors |
| EErrorCodes_NoLicense | -1 | no license was found (or licence expired) |
| EErrorCodes_NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| EErrorCodes_AlreadyInitialized | -3 | the SDK is already initialized |
| EErrorCodes_DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| EErrorCodes_InvalidInputParam | -5 | an invalid parameter was passed to the method |
| EErrorCodes_FailedTesting | -6 | the reduction failed post-testing |
| EErrorCodes_DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| EErrorCodes_DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| EErrorCodes_LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| EErrorCodes_LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| EErrorCodes_LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| EErrorCodes_FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| EErrorCodes_FailedToRunPipeline | -13 | failed to run pipeline |
| EErrorCodes_UnhandledException | -14 | an unhandled exception was encountered |
| EErrorCodes_FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| EErrorCodes_ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| EErrorCodes_FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| EErrorCodes_FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| EErrorCodes_FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| EErrorCodes_FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| EErrorCodes_DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| EErrorCodes_LicenseHasExpired | -10006 | the license has expired |
| EErrorCodes_LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| EErrorCodes_LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| EErrorCodes_NoNetworkCardFound | -10009 | no network card was found on the machine |
| EErrorCodes_LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| EErrorCodes_LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| EErrorCodes_ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| EErrorCodes_LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| EErrorCodes_LicenseExpired | -10014 | the license is invalid, please contact licensing |
| EErrorCodes_LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| EErrorCodes_YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| EErrorCodes_LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| EErrorCodes_LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| EErrorCodes_MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| EErrorCodes_YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| EErrorCodes_LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | inputScene | | | The file path of the input scene file. |
const char * | outputScene | | | The file path of the output scene file (can be null) |
| EPipelineRunMode | runMode | | | Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum). |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | inputScene | | | The file path of the input scene file. |
string | outputScene | | | The file path of the output scene file (can be null) |
| EPipelineRunMode | runMode | | | Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum). |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| NoError | 0 | No error, the initialization or process has finished, and with no errors |
| NoLicense | -1 | no license was found (or licence expired) |
| NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| AlreadyInitialized | -3 | the SDK is already initialized |
| DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| InvalidInputParam | -5 | an invalid parameter was passed to the method |
| FailedTesting | -6 | the reduction failed post-testing |
| DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| FailedToRunPipeline | -13 | failed to run pipeline |
| UnhandledException | -14 | an unhandled exception was encountered |
| FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| LicenseHasExpired | -10006 | the license has expired |
| LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| NoNetworkCardFound | -10009 | no network card was found on the machine |
| LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| LicenseExpired | -10014 | the license is invalid, please contact licensing |
| LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| inputScene | str | | | The file path of the input scene file. |
| outputScene | str | | | The file path of the output scene file (can be null) |
| runMode | EPipelineRunMode | | | Pipeline run mode controlling if pipeline run in this or separate/distributed process. Valid values are the SG_PIPELINE_RUN* constants (from PipelineRunMode enum). |
Return value
Type: EErrorCodes
| Key | Value | Comment |
|---|
| EErrorCodes_NoError | 0 | No error, the initialization or process has finished, and with no errors |
| EErrorCodes_NoLicense | -1 | no license was found (or licence expired) |
| EErrorCodes_NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
| EErrorCodes_AlreadyInitialized | -3 | the SDK is already initialized |
| EErrorCodes_DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
| EErrorCodes_InvalidInputParam | -5 | an invalid parameter was passed to the method |
| EErrorCodes_FailedTesting | -6 | the reduction failed post-testing |
| EErrorCodes_DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
| EErrorCodes_DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
| EErrorCodes_LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
| EErrorCodes_LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
| EErrorCodes_LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
| EErrorCodes_FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
| EErrorCodes_FailedToRunPipeline | -13 | failed to run pipeline |
| EErrorCodes_UnhandledException | -14 | an unhandled exception was encountered |
| EErrorCodes_FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
| EErrorCodes_ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
| EErrorCodes_FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
| EErrorCodes_FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
| EErrorCodes_FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
| EErrorCodes_FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
| EErrorCodes_DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
| EErrorCodes_LicenseHasExpired | -10006 | the license has expired |
| EErrorCodes_LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
| EErrorCodes_LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
| EErrorCodes_NoNetworkCardFound | -10009 | no network card was found on the machine |
| EErrorCodes_LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
| EErrorCodes_LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
| EErrorCodes_ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
| EErrorCodes_LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
| EErrorCodes_LicenseExpired | -10014 | the license is invalid, please contact licensing |
| EErrorCodes_LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
| EErrorCodes_YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
| EErrorCodes_LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
| EErrorCodes_LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
| EErrorCodes_MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
| EErrorCodes_YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
| EErrorCodes_LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
| EErrorCodes_ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
SetBoolParameter
Set a named parameter boolean value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
| value | bool | | | New value for parameter. |
Return value
Type: bool
SetDoubleParameter
Set a named parameter floating point value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
| value | float | | | New value for parameter. |
Return value
Type: bool
SetEnumParameter
Set a named parameter enum value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
int | value | | | New value for parameter. |
| ESettingValueType | valueEnumType | | | Value type of enum for parameter value. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
int | value | | | New value for parameter. |
| ESettingValueType | valueEnumType | | | Value type of enum for parameter value. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
| value | int | | | New value for parameter. |
| valueEnumType | ESettingValueType | | | Value type of enum for parameter value. |
Return value
Type: bool
SetIntParameter
Set a named parameter integer value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetParameterFromString
Set a named parameter value including parameter path. The string will be parsed with best effort according to the parameter data type.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetStringParameter
Set a named parameter string value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetUIntParameter
Set a named parameter unsigned integer value including parameter path.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter path separated with forward slash, like "/RemeshingProcessor/Reduction/MergeGeometries". |
| value | int | | | New value for parameter. |
Return value
Type: bool
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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. (Inherited from Object)
