Skip to content
On this page

class PipelineSerializer

Properties

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

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClassGet the name of the PipelineSerializer class. (Inherited from Object)
IsAReturns true if PipelineSerializer is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the PipelineSerializer object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the PipelineSerializer object is valid. (Inherited from Object)
LoadPipelineBatchFromFileLoad the pipeline batch definition to the given file and create a pipeline batch object as defined in this file.
LoadPipelineFromFileLoad the pipeline definition to the given file and create a pipeline object as defined in this file, including settings.
NonNullReturns true if the PipelineSerializer object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the PipelineSerializer object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SavePipelineBatchToFileSave the pipeline batch definition and associated pipelines and scenes to the given file, which can be used to restore the pipeline batch through the LoadPipelineBatchFromFile method. Associated pipelines and scenes will be stored in the same directory as the pipeline batch file. Note that pipeline files are NOT meant for storage, only as a transient transfer format between processes and hosts. Do NOT store pipeline files for later use, as there is no guarantee that pipeline files will be compatible between different versions of Simplygon.
SavePipelineToFileSave the pipeline definition and settings to the given file, which can be used to restore the pipeline through the LoadPipelineFromFile method. Note that pipeline files are NOT meant for storage, only as a transient transfer format between processes and hosts. Do NOT store pipeline files for later use, as there is no guarantee that pipeline files will be compatible between different versions of Simplygon.

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 spPipelineSerializer, and if this is the case, returns the object cast into spPipelineSerializer. (Inherited from Object)

Properties details

Name

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

Methods details

AddObserver

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

GetClass

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

IsA

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

IsNull

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

IsSameObjectAs

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

LoadPipelineBatchFromFile

Load the pipeline batch definition to the given file and create a pipeline batch object as defined in this file.

LoadPipelineFromFile

Load the pipeline definition to the given file and create a pipeline object as defined in this file, including settings.

NonNull

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

PrintInfo

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

RemoveObserver

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

SavePipelineBatchToFile

Save the pipeline batch definition and associated pipelines and scenes to the given file, which can be used to restore the pipeline batch through the LoadPipelineBatchFromFile method. Associated pipelines and scenes will be stored in the same directory as the pipeline batch file. Note that pipeline files are NOT meant for storage, only as a transient transfer format between processes and hosts. Do NOT store pipeline files for later use, as there is no guarantee that pipeline files will be compatible between different versions of Simplygon.

SavePipelineToFile

Save the pipeline definition and settings to the given file, which can be used to restore the pipeline through the LoadPipelineFromFile method. Note that pipeline files are NOT meant for storage, only as a transient transfer format between processes and hosts. Do NOT store pipeline files for later use, as there is no guarantee that pipeline files will be compatible between different versions of Simplygon.

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 spPipelineSerializer, and if this is the case, returns the object cast into spPipelineSerializer. (Inherited from Object)