SimplygonSDK::IGraphicsExporter Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IGraphicsExporter:

Public Member Functions
virtual const char *	GetClass ()
virtual rstring	GetExportFilePath ()=0
virtual rstring	GetPrimaryTexCoordLevelName ()=0
virtual bool	IsA (const char *type) const
virtual bool	RunExport ()=0
virtual void	SetExportFilePath (const char *value)=0
virtual void	SetPrimaryTexCoordLevelName (const char *name)=0
virtual void	SetScene (IScene *scene)=0
virtual void	SetSelectionSet (int exportSelectionSetID)=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 IGraphicsExporter *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

base class for graphics export classes

Definition at line 8578 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

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

Reimplemented in SimplygonSDK::IBinaryExporter, and SimplygonSDK::IWavefrontExporter.

GetExportFilePath()

virtual rstring SimplygonSDK::IGraphicsExporter::GetExportFilePath ( )

pure virtual

Get the main export file path. This is the main file being written to, and must always be set.

Returns

the current file path

GetPrimaryTexCoordLevelName()

virtual rstring SimplygonSDK::IGraphicsExporter::GetPrimaryTexCoordLevelName ( )

pure virtual

Gets the name of the texcoord level used as primary level in case the file format only supports a single texture coordinate layer

Returns

the current name of the texcoord level used as primary level

IsA()

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

Reimplemented in SimplygonSDK::IBinaryExporter, and SimplygonSDK::IWavefrontExporter.

IsClassA()

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

inlinestatic

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

RunExport()

virtual bool SimplygonSDK::IGraphicsExporter::RunExport ( )

pure virtual

Runs the export. Note that all required parameters must be setup before exporting.

Returns

true if the export was successful, false otherwise

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IGraphicsExporter pointer

Returns

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

Definition at line 8612 of file SimplygonSDK.h.

SetExportFilePath()

virtual void SimplygonSDK::IGraphicsExporter::SetExportFilePath ( const char *  value )

pure virtual

Set the main export file path. This is the main file being written to, and must always be set.

Parameters

value

the desired file path

SetPrimaryTexCoordLevelName()

virtual void SimplygonSDK::IGraphicsExporter::SetPrimaryTexCoordLevelName ( const char *  name )

pure virtual

Sets the name of the texcoord level to use as primary level in case the file format only supports a single texture coordinate layer. If the primary level name is not set, the first found level will be used as primary level.

Parameters

name	the name of the primary texcoord level

SetScene()

virtual void SimplygonSDK::IGraphicsExporter::SetScene ( IScene *  scene )

pure virtual

Sets the scene to export.

Parameters

scene

the desired scene object

SetSelectionSet()

virtual void SimplygonSDK::IGraphicsExporter::SetSelectionSet ( int  exportSelectionSetID )

pure virtual

Sets the selection set (of nodes from the scene) to export.

Parameters

exportSelectionSetID

the desired selection set id to use

---

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

• SimplygonSDK.h