SimplygonSDK::IImageDataExporter Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IImageDataExporter:

Public Member Functions
virtual void	Clear ()=0
virtual const char *	GetClass ()
virtual rstring	GetExportFilePath ()=0
virtual bool	IsA (const char *type) const
virtual bool	RunExport ()=0
virtual void	SetExportFilePath (const char *value)=0
virtual void	SetImage (IImageData *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 IImageDataExporter *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

Class for loading image data from different file formats.

Definition at line 18942 of file SimplygonSDK.h.

Member Function Documentation

Clear()

virtual void SimplygonSDK::IImageDataExporter::Clear ( )

pure virtual

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

GetClass()

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

GetExportFilePath()

virtual rstring SimplygonSDK::IImageDataExporter::GetExportFilePath ( )

pure virtual

Get the main import file path. This must always be set.

Returns

the main import file path

IsA()

virtual bool SimplygonSDK::IImageDataExporter::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::IImageDataExporter::IsClassA ( const char *  type )

inlinestatic

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

RunExport()

virtual bool SimplygonSDK::IImageDataExporter::RunExport ( )

pure virtual

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

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IImageDataExporter pointer

Returns

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

Definition at line 18976 of file SimplygonSDK.h.

SetExportFilePath()

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

pure virtual

Set the main import file path. This must always be set.

Parameters

value

the desired main import file path

SetImage()

virtual void SimplygonSDK::IImageDataExporter::SetImage ( IImageData *  value )

pure virtual

Set the imported image data.

Parameters

value

is the image data object to export

Returns

the imported image data

---

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

• SimplygonSDK.h