SimplygonSDK::IGraphicsImporter Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IGraphicsImporter:

Public Member Functions
virtual void	Clear ()=0
virtual const char *	GetClass ()
virtual rstring	GetImportFilePath ()=0
virtual CountedPointer< IScene >	GetScene ()=0
virtual bool	IsA (const char *type) const
virtual bool	RunImport ()=0
virtual void	SetImportFilePath (const char *value)=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 IGraphicsImporter *	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 import classes

Definition at line 8380 of file SimplygonSDK.h.

Member Function Documentation

Clear()

virtual void SimplygonSDK::IGraphicsImporter::Clear ( )

pure virtual

Close any open file or stream, release any allocated data .

GetClass()

virtual const char* SimplygonSDK::IGraphicsImporter::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::IBinaryImporter, and SimplygonSDK::IWavefrontImporter.

GetImportFilePath()

virtual rstring SimplygonSDK::IGraphicsImporter::GetImportFilePath ( )

pure virtual

Get the main import file path. This must always be set. Some importers, such as IWavefrontImporter, also have secondary files that may be set. For info regarding these secondary files, please see the documentation for the specific importer.

Returns

the current ImportFilePath string

GetScene()

virtual CountedPointer<IScene> SimplygonSDK::IGraphicsImporter::GetScene ( )

pure virtual

The the scene loaded from the importer.

Returns

the loaded scene

IsA()

virtual bool SimplygonSDK::IGraphicsImporter::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::IBinaryImporter, and SimplygonSDK::IWavefrontImporter.

IsClassA()

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

inlinestatic

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

RunImport()

virtual bool SimplygonSDK::IGraphicsImporter::RunImport ( )

pure virtual

Runs the import. Note that all parameters must be setup before importing.

Returns

true if the import was successful, false otherwise

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IGraphicsImporter pointer

Returns

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

Definition at line 8414 of file SimplygonSDK.h.

SetImportFilePath()

virtual void SimplygonSDK::IGraphicsImporter::SetImportFilePath ( const char *  value )

pure virtual

Set the main import file path. This must always be set. Some importers, such as IWavefrontImporter, also have secondary files that may be set. For info regarding these secondary files, please see the documentation for the specific importer.

Parameters

value

the desired ImportFilePath string

---

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

• SimplygonSDK.h