SimplygonSDK::IWavefrontImporter Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IWavefrontImporter:

Public Member Functions
virtual const char *	GetClass ()
virtual bool	GetExtractGroups ()=0
virtual rstring	GetMaterialFilePath ()=0
virtual bool	GetUseAlphaAsOpacity ()=0
virtual bool	IsA (const char *type) const
virtual void	SetExtractGroups (bool value)=0
virtual void	SetMaterialFilePath (const char *value)=0
virtual void	SetUseAlphaAsOpacity (bool value)=0
Public Member Functions inherited from SimplygonSDK::IGraphicsImporter
virtual void	Clear ()=0
virtual rstring	GetImportFilePath ()=0
virtual CountedPointer< IScene >	GetScene ()=0
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 IWavefrontImporter *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IGraphicsImporter
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 8470 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

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

GetExtractGroups()

virtual bool SimplygonSDK::IWavefrontImporter::GetExtractGroups ( )

pure virtual

Get the ExtractGroups boolean. If true, each group within the wavefront file is extracted into a separate geometry data object, that is named as the group. If false, the whole file is imported into one geometry data, and groups are ignored.

Returns

the current value of the ExtractGroups bool

GetMaterialFilePath()

virtual rstring SimplygonSDK::IWavefrontImporter::GetMaterialFilePath ( )

pure virtual

Get the material file path. If the path is not set, it is assumed to equal the path of the main obj file, but with the extension '.mtl' instead of '.obj'. If no material file is found or specified, materials that are found in the Wavefront file is added using default material settings to the material table.

Returns

the path to the material file

GetUseAlphaAsOpacity()

virtual bool SimplygonSDK::IWavefrontImporter::GetUseAlphaAsOpacity ( )

pure virtual

Get the AlphaAsOpacity boolean. If set, then if the material has a map_d texture definition, and that texture is RGBA, the material will use the alpha channel rather than the color (R) to specify the opacity.

Returns

the current value of the AlphaAsOpacity bool

IsA()

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

IsClassA()

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

inlinestatic

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

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IWavefrontImporter pointer

Returns

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

Definition at line 8504 of file SimplygonSDK.h.

SetExtractGroups()

virtual void SimplygonSDK::IWavefrontImporter::SetExtractGroups ( bool  value )

pure virtual

Set the ExtractGroups boolean. If true, each group within the wavefront file is extracted into a separate geometry data object, that is named as the group. If false, the whole file is imported into one geometry data, and groups are ignored.

Parameters

value

is the bool the parameter is to be set to

SetMaterialFilePath()

virtual void SimplygonSDK::IWavefrontImporter::SetMaterialFilePath ( const char *  value )

pure virtual

Set the material file path. If the path is not set, it is assumed to equal the path of the main obj file, but with the extension '.mtl' instead of '.obj'. If no material file is found or specified, materials that are found in the Wavefront file is added using default material settings to the material table.

Parameters

value

is the path to the material file

SetUseAlphaAsOpacity()

virtual void SimplygonSDK::IWavefrontImporter::SetUseAlphaAsOpacity ( bool  value )

pure virtual

Set the UseAlphaAsOpacity boolean. If set, then if the material has a map_d texture definition, and that texture is RGBA, the material will use the alpha channel rather than the color (R) to specify the opacity.

Parameters

value

is the bool the parameter is to be set to

---

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

• SimplygonSDK.h