IGameTextureMap Class Reference

#include <IGameMaterial.h>

Class Description

Simple wrapper for 3ds Max textures.

A generic class that wraps all the 3ds Max texture maps. This class directly supports the Bitmap Texture. This can be tested for by calling IExportEntity::IsEntitySupported. If it is not supported then access to the paramblocks, if defined can be obtained by using the properties interface. The usual texture map properties including coordinate rollout access are provided.

+ Inheritance diagram for IGameTextureMap:

Public Member Functions

virtual const MCHARGetTextureName ()=0
 Get the texture map name as seen in the Material Editor. More...
 
virtual const MCHARGetTextureClass ()=0
 Get the Texture class as seen in the Material Editor. More...
 
virtual TexmapGetMaxTexmap ()=0
 Access to the actual 3ds Max definition. More...
 
virtual IGameUVGenGetIGameUVGen ()=0
 Access to the Coordinate Rollout. More...
 
virtual int GetMapChannel ()=0
 Get the map channel being used by the texture. More...
 
virtual int GetStdMapSlot ()=0
 Get the slot that the bitmap was found in. More...
 
virtual const MCHARGetBitmapFileName ()=0
 Get the filename of the bitmap used by the Bitmap Texture. More...
 
virtual IGamePropertyGetClipUData ()=0
 Get the Clip U Data from a the Bitmap Texture. More...
 
virtual IGamePropertyGetClipVData ()=0
 Get the Clip V Data from a the Bitmap Texture. More...
 
virtual IGamePropertyGetClipHData ()=0
 Get the Clip H Data from a the Bitmap Texture. More...
 
virtual IGamePropertyGetClipWData ()=0
 Get the Clip W Data from a the Bitmap Texture. More...
 
- Public Member Functions inherited from IExportEntity
virtual ~IExportEntity ()
 Destructor. More...
 
virtual IPropertyContainerGetIPropertyContainer ()
 Retrieve the Property Container. More...
 
virtual bool IsEntitySupported ()
 Is the Entity directly supported. More...
 
virtual const MCHARGetClassName ()=0
 Retrieves the name of the entity class. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 

Member Function Documentation

virtual const MCHAR* GetTextureName ( )
pure virtual

Get the texture map name as seen in the Material Editor.

The name of the TextureMap as seen in the material editor/material browser.

Returns
The name of the texture map
virtual const MCHAR* GetTextureClass ( )
pure virtual

Get the Texture class as seen in the Material Editor.

Returns
The name of the texture class
virtual Texmap* GetMaxTexmap ( )
pure virtual

Access to the actual 3ds Max definition.

This allows the developer to get hold of extra data such as Texture Transforms, specified from the Coordinates rollout. 3ds Max method of GetUVGen or GetXYZGen can be used for more advanced access

Returns
A pointer to a max class Texmap
virtual IGameUVGen* GetIGameUVGen ( )
pure virtual

Access to the Coordinate Rollout.

If the developer needs access to the transforms applied to the texture, then this can be accessed here.

Returns
A pointer to IGameUVGen
virtual int GetMapChannel ( )
pure virtual

Get the map channel being used by the texture.

Returns
The map channel. Valid value is 1..99
virtual int GetStdMapSlot ( )
pure virtual

Get the slot that the bitmap was found in.

It uses the standard 3ds Max convention ID_BU for bump etc.. If this is -1 then it means either the hosting material was not a standard material and the channel conversion could not be performed based on the active shader.

Returns
The Slot definition. Return -1 for an unsupported material.
virtual const MCHAR* GetBitmapFileName ( )
pure virtual

Get the filename of the bitmap used by the Bitmap Texture.

Returns
The name of bitmap file
virtual IGameProperty* GetClipUData ( )
pure virtual

Get the Clip U Data from a the Bitmap Texture.

Returns
A pointer to IGameProperty
virtual IGameProperty* GetClipVData ( )
pure virtual

Get the Clip V Data from a the Bitmap Texture.

Returns
A pointer to IGameProperty
virtual IGameProperty* GetClipHData ( )
pure virtual

Get the Clip H Data from a the Bitmap Texture.

Returns
A pointer to IGameProperty
virtual IGameProperty* GetClipWData ( )
pure virtual

Get the Clip W Data from a the Bitmap Texture.

Returns
A pointer to IGameProperty