class PipelineSerializer ​

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

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

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

// Setter
void SetName(string name);

// Getter
string GetName();

# Setter
None SetName(name: str)

# Getter
str GetName()

Methods details ​

AddObserver ​

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

rid AddObserver( const spObserver & observer ) const;

int AddObserver(spObserver observer);

int AddObserver(observer: spObserver)

GetClass ​

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

spString GetClass() const;

string GetClass();

str GetClass()

IsA ​

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

bool IsA( const char * type ) const;

bool IsA(string type);

bool IsA(type: str)

IsNull ​

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

bool IsNull() const;

bool IsNull();

bool IsNull()

IsSameObjectAs ​

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

bool IsSameObjectAs( const spObject & object ) const;

bool IsSameObjectAs(spObject object);

bool IsSameObjectAs(object: spObject)

LoadPipelineBatchFromFile ​

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

spPipelineBatch LoadPipelineBatchFromFile( const char * path ) const;

spPipelineBatch LoadPipelineBatchFromFile(string path);

spPipelineBatch LoadPipelineBatchFromFile(path: str)

LoadPipelineFromFile ​

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

spPipeline LoadPipelineFromFile( const char * path ) const;

spPipeline LoadPipelineFromFile(string path);

spPipeline LoadPipelineFromFile(path: str)

NonNull ​

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

bool NonNull() const;

bool NonNull();

bool NonNull()

PrintInfo ​

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

void PrintInfo() const;

void PrintInfo();

None PrintInfo()

RemoveObserver ​

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

void RemoveObserver( rid observerId ) const;

void RemoveObserver(int observerId);

None RemoveObserver(observerId: int)

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.

void SavePipelineBatchToFile( const char * path , const spPipelineBatch & batch ) const;

void SavePipelineBatchToFile(string path, spPipelineBatch batch);

None SavePipelineBatchToFile(path: str, batch: spPipelineBatch)

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.

void SavePipelineToFile( const char * path , const spPipeline & pipeline ) const;

void SavePipelineToFile(string path, spPipeline pipeline);

None SavePipelineToFile(path: str, pipeline: spPipeline)

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)

static bool IsClassA( const char * type ) const;

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

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)

static spPipelineSerializer SafeCast( const spObject & object ) const;

static spPipelineSerializer SafeCast(spObject object);

@staticmethod
spPipelineSerializer SafeCast(object: spObject)