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

IRmTextureLoaderPlugIn Class Reference

Texture loader plugin. More...

#include <RmPlugIn.h>

Inheritance diagram for IRmTextureLoaderPlugIn:

IRmPlugIn List of all members.

Public Member Functions

virtual void GetSupportedExtensions (RmTextureType textureType, RmLinkedList< RmStringT > &formatDescriptions, RmLinkedList< RmStringT > &formatExtensions)=0
virtual bool CanLoadTexture (RmTextureType textureType, const RM_TCHAR *strFileName)=0
virtual bool LoadTexture (const RM_TCHAR *strFileName, RmTexture *pTexture, RmPixelFormatType format=RM_PIXELFORMAT_UNKNOWN)=0

Detailed Description

Texture loader plugin.

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


Member Function Documentation

virtual bool IRmTextureLoaderPlugIn::CanLoadTexture RmTextureType  textureType,
const RM_TCHAR *  strFileName
[pure virtual]
 

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

Parameters:
textureType Tetxure type
See also:
RmTextureType
Parameters:
strFileName Filename to load
Returns:
True if this plugin can load the file, False otherwise

virtual void IRmTextureLoaderPlugIn::GetSupportedExtensions RmTextureType  textureType,
RmLinkedList< RmStringT > &  formatDescriptions,
RmLinkedList< RmStringT > &  formatExtensions
[pure virtual]
 

This method is used to query a Texture loader plug-in about the file types that it supports for importing Textures. 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 Texture, it would report ".BMP" in its list of extentions and "3DS StudioMax Texture 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 Texture plug-in. Note: the number of entries for format extensions and descriptions must match.

Parameters:
textureType Tetxure type
See also:
RmTextureType
Parameters:
formatDescriptions List of format description string
formatExtensions List of extension string
Returns:
None

virtual bool IRmTextureLoaderPlugIn::LoadTexture const RM_TCHAR *  strFileName,
RmTexture pTexture,
RmPixelFormatType  format = RM_PIXELFORMAT_UNKNOWN
[pure virtual]
 

Load Texture from the given file described by the specified file name

Parameters:
strFileName Filename to load
pTexture Texture to load into
See also:
RmTexture
Parameters:
format Requested fromat to bring texture into. If RM_PIXELFORMAT_UNKNOWN, use format from file
Returns:
True on success


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