SimplygonSDK::IPipelineSettings Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IPipelineSettings:

Public Member Functions
virtual const char *	GetClass ()
virtual rstring	GetTextureOutputPath ()=0
virtual bool	IsA (const char *type) const
virtual void	SetTextureOutputPath (const char *value)=0
Public Member Functions inherited from SimplygonSDK::ISettingsObject
virtual rstring	GetErrorString ()=0
virtual bool	ValidateSettings ()=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 IPipelineSettings *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::ISettingsObject
static bool	IsClassA (const char *type)
static ISettingsObject *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

IPipelineSettings is the interface used to manage settings for a pipeline

Definition at line 22065 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

virtual const char* SimplygonSDK::IPipelineSettings::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::ISettingsObject.

GetTextureOutputPath()

virtual rstring SimplygonSDK::IPipelineSettings::GetTextureOutputPath ( )

pure virtual

Get the path where the pipeline will save any created textures from material casters. See SetTextureOutputPath for documentation regarding relative paths.

Returns

Path where created textures will be saved

IsA()

virtual bool SimplygonSDK::IPipelineSettings::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::ISettingsObject.

IsClassA()

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

inlinestatic

The IsClassA function returns true if IPipelineSettings 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 22086 of file SimplygonSDK.h.

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IPipelineSettings pointer

Returns

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

Definition at line 22099 of file SimplygonSDK.h.

SetTextureOutputPath()

virtual void SimplygonSDK::IPipelineSettings::SetTextureOutputPath ( const char *  value )

pure virtual

Set the path where the pipeline will save any created textures from material casters. A relative path will be treated as relative to the scene file output path if the pipeline is executed with scene file paths (RunSceneFromFile), or from the current working directory if the pipeline is executed with a scene object (RunScene). The directory must exist, it will not be created.

Parameters

value

Path where created textures will be saved

---

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

• SimplygonSDK.h