SimplygonSDK::IPipelineSerializer Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IPipelineSerializer:

Public Member Functions
virtual const char *	GetClass ()
virtual bool	IsA (const char *type) const
virtual CountedPointer< IPipeline >	LoadPipelineFromFile (const char *path)=0
virtual void	SavePipelineToFile (const char *path, IPipeline *pipeline)=0
Public Member Functions inherited from SimplygonSDK::IObject
virtual rid	AddObserver (robserver *Observer, rid EventId)=0
virtual void	AddRef ()=0
virtual rstring	GetName ()=0
virtual void *	GetUserComponentArea (rid userid)=0
virtual void	PrintInfo ()=0
virtual void	Release ()=0
virtual void	RemoveObserver (rid ObserverId)=0
virtual void	SetName (const char *Name)=0

Static Public Member Functions
static bool	IsClassA (const char *type)
static IPipelineSerializer *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

Definition at line 21701 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

virtual const char* SimplygonSDK::IPipelineSerializer::GetClass ( )

virtual

GetClass returns the name of the class of the object.

Returns

the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::IObject.

IsA()

virtual bool SimplygonSDK::IPipelineSerializer::IsA ( const char *  type ) const

virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the object is, or is a descendant of

Returns

true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::IObject.

IsClassA()

static bool SimplygonSDK::IPipelineSerializer::IsClassA ( const char *  type )

inlinestatic

The IsClassA function returns true if IPipelineSerializer is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the class is, or is a descendant of

Returns

true if the class is of the specified class, false if not

Definition at line 21722 of file SimplygonSDK.h.

LoadPipelineFromFile()

virtual CountedPointer<IPipeline> SimplygonSDK::IPipelineSerializer::LoadPipelineFromFile ( const char *  path )

pure virtual

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

Parameters

path	The file path of the input pipeline definition

Returns

A pipeline object with settings restored

SafeCast()

static IPipelineSerializer* SimplygonSDK::IPipelineSerializer::SafeCast ( IObject *  ptr )

inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a IPipelineSerializer pointer, and if this is possible, returns the cast pointer.

Parameters

ptr	is the pointer to be cast into a IPipelineSerializer pointer

Returns

a pointer to the IPipelineSerializer object, if the cast can be made, and a NULL pointer otherwise

Definition at line 21735 of file SimplygonSDK.h.

SavePipelineToFile()

virtual void SimplygonSDK::IPipelineSerializer::SavePipelineToFile ( const char *  path, IPipeline *  pipeline  )

pure virtual

Save the pipeline definition and settings to the given file, which can be used to restore the pipeline through the NewPipelineFromFile method

Parameters

path	The file path of the output pipeline definition
pipeline	The pipeline object to save

---

The documentation for this class was generated from the following file:

• SimplygonSDK.h