Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IRmGeometryLoaderPlugIn Class Reference

Geometry loader plugin. More...

#include <RmPlugIn.h>

Inheritance diagram for IRmGeometryLoaderPlugIn:

IRmPlugIn List of all members.

Public Member Functions

virtual void GetSupportedExtensions (RmLinkedList< RmStringT > &formatDescriptions, RmLinkedList< RmStringT > &formatExtensions)=0
virtual bool CanLoadGeometry (const RM_TCHAR *strFileName)=0
virtual bool LoadGeometry (const RM_TCHAR *strFileName, RmMeshModelContainer *pModelContainer)=0

Detailed Description

Geometry loader plugin.

This plug-in type is used by the main application to import geometry data from a supported file format into RenderMonkey model data node. The plug-in must use RM_PLUGINTYPE_GEOMETRY_LOADER in its plug-in data description structure.


Member Function Documentation

virtual bool IRmGeometryLoaderPlugIn::CanLoadGeometry const RM_TCHAR *  strFileName  )  [pure virtual]
 

This method lets the main application know whether the plug-in that implements the geometry loader interface can load a specified file described by the given file name.

Parameters:
strFileName Filename to load
Returns:
True if this plugin can load the file, False otherwise

virtual void IRmGeometryLoaderPlugIn::GetSupportedExtensions RmLinkedList< RmStringT > &  formatDescriptions,
RmLinkedList< RmStringT > &  formatExtensions
[pure virtual]
 

This method is used to query a geometry loader plug-in about the file types that it supports for importing geometry models. The file types are identified by their extensions, returned in a list 'formatExtensions'. The 'formatDescriptions' list is used to store descriptions of the supported file formats. For example, if a plug-in implementing this interface supports importing 3DStudioMax geometry, it would report ".3DS" in its list of extentions and "3DS StudioMax geometry file" in its list of file format descriptions list. The format descriptions are going to be displayed in the FileOpen dialog when the model data will be loaded by using this geometry plug-in. Note: the number of entries for format extensions and descriptions must match.

Parameters:
formatDescriptions List of format description string
formatExtensions List of extension string
Returns:
None

virtual bool IRmGeometryLoaderPlugIn::LoadGeometry const RM_TCHAR *  strFileName,
RmMeshModelContainer pModelContainer
[pure virtual]
 

Load geometry object(s) from the given file described by the specified file name ('strFileName') into a given geometry model data container ('pModelContainer').

Parameters:
strFileName Filename to load
pModelContainer ModelContainer to load models into
Returns:
True on success


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:08:49 2005 for RenderMonkey SDK by doxygen 1.3.6