Skip to content
On this page

class PassthroughPipeline

PassthroughPipeline provides an empty pipeline for creating a cascading pipeline using a single dummy root node. It does not process the input scene in any way.

Properties

PropertyDescription
NameThe name of the PassthroughPipeline object. (Inherited from Object)

Methods

MethodDescription
AddCascadedPipelineAdd a cascaded child pipeline. The child pipeline will execute on the scene output from this pipeline. (Inherited from Pipeline)
AddMaterialCasterAdd 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)
AddMaterialCasterByTypeAdd 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)
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetActiveSelectionSetsGet the names of all currently active selection sets used by this pipeline, based on the current settings (Inherited from Pipeline)
GetBoolParameterGet a named parameter boolean value including parameter path. (Inherited from Pipeline)
GetCascadedPipelineByIndexThe cascaded child pipeline object for the given index. (Inherited from Pipeline)
GetCascadedPipelineCountGet number of cascaded child pipelines. (Inherited from Pipeline)
GetClassGet the name of the PassthroughPipeline class. (Inherited from Object)
GetDoubleParameterGet a named parameter floating point value including parameter path. (Inherited from Pipeline)
GetEnumParameterGet a named parameter enum value as int including parameter path. (Inherited from Pipeline)
GetIntParameterGet a named parameter integer value including parameter path. (Inherited from Pipeline)
GetMappingImageThe 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)
GetMappingImageSettingsThe 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)
GetMaterialCasterByIndexGet the material caster in the pipeline for the given index, which must be less than the material caster count. (Inherited from Pipeline)
GetMaterialCasterCountGet the number of material casters for the pipeline. (Inherited from Pipeline)
GetMaterialCastersThe material casters for the pipeline. (Inherited from Pipeline)
GetParameterTypeGet a named parameter data type including parameter path. (Inherited from Pipeline)
GetPercentDoneReturns the current progress of the pipeline as a value between 0 and 100. (Inherited from Pipeline)
GetPipelineSettingsThe settings for the pipeline. (Inherited from Pipeline)
GetProcessedSceneThe resulting scene from the last execution of this pipeline. (Inherited from Pipeline)
GetStringParameterGet a named parameter string value including parameter path. (Inherited from Pipeline)
GetUIntParameterGet a named parameter unsigned integer value including parameter path. (Inherited from Pipeline)
IsAReturns true if PassthroughPipeline is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the PassthroughPipeline object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the PassthroughPipeline object is valid. (Inherited from Object)
NewCopyCreate 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)
NonNullReturns true if the PassthroughPipeline object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the PassthroughPipeline object to the log. (Inherited from Object)
RemoveCascadedPipelineRemove a cascaded child pipeline. (Inherited from Pipeline)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RunSceneRun 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)
RunSceneFromFileRun 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)
SetBoolParameterSet a named parameter boolean value including parameter path. (Inherited from Pipeline)
SetDoubleParameterSet a named parameter floating point value including parameter path. (Inherited from Pipeline)
SetEnumParameterSet a named parameter enum value including parameter path. (Inherited from Pipeline)
SetIntParameterSet a named parameter integer value including parameter path. (Inherited from Pipeline)
SetParameterFromStringSet a named parameter value including parameter path. The string will be parsed with best effort according to the parameter data type. (Inherited from Pipeline)
SetStringParameterSet a named parameter string value including parameter path. (Inherited from Pipeline)
SetUIntParameterSet a named parameter unsigned integer value including parameter path. (Inherited from Pipeline)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into spPassthroughPipeline, and if this is the case, returns the object cast into spPassthroughPipeline. (Inherited from Object)

Properties details

Name

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

Methods details

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.

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

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

GetDoubleParameter

Get a named parameter floating point value including parameter path.

GetEnumParameter

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

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.

IsA

Returns true if PassthroughPipeline is a or is a descendant of the class named as the type parameter. (Inherited from Object)

IsNull

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

IsSameObjectAs

Returns true if the PassthroughPipeline 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.

NonNull

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

PrintInfo

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

RemoveCascadedPipeline

Remove a cascaded child 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.

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

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spPassthroughPipeline, and if this is the case, returns the object cast into spPassthroughPipeline. (Inherited from Object)