RmVolume.h

//=============================================================================
// filename: RmVolume.h                                                        
//                                                                             
//           ATI Research, Inc.                                                
//           3D Application Research Group                                     
//                                                                             
// Description: RenderMonkey's Volume Definition                               
//                                                                             
//=============================================================================
//   (C) 2004 ATI Research, Inc.  All rights reserved.                         
//=============================================================================

#ifndef _RM_CORE_VOLUME_H_
#define _RM_CORE_VOLUME_H_

#include <Core/RmTypes.h>
#include <Core/RmDefines.h>
#include <Core/RmEffect.h>
#include <Core/RmMath.h>
#include <Core/RmMatrix.h>
#include <Core/RmSurface.h>

//=============================================================================
//=============================================================================
class RM_API RmVolume
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmVolume();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmVolume();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   bool Create( RmPixelFormatType pixelFormat, int width, int height, int depth );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   void Destroy();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RM_BYTE*       GetBuffer() { return m_pBuffer; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RM_BYTE* GetBuffer() const { return m_pBuffer; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RM_BYTE* GetSlice( int z );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RM_BYTE* GetSlice( int z ) const;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RM_BYTE*       GetScanLine( int y, int z );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RM_BYTE* GetScanLine( int y, int z ) const;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RM_BYTE*       GetVoxel( int x, int y, int z );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RM_BYTE* GetVoxel( int x, int y, int z ) const;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetWidth()  const { return m_width; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetHeight() const { return m_height; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetDepth()  const { return m_depth; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetPitch() const { return m_pitch; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetSlicePitch() const { return m_slicePitch; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetBytesPerVoxel() const { return m_bytesPerVoxel; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetTotalSize() const { return m_totalSize; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmPixelFormatType GetPixelFormat() const { return m_pixelFormat; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   bool IsDXTFormat() const;

private :
   RmPixelFormatType m_pixelFormat;  
 
   int m_width;                      
   int m_height;                     
   int m_depth;                      
   int m_bytesPerVoxel;              

   int m_pitch;                      
   int m_slicePitch;                 

   int m_totalSize;                  

   int m_DXTBlockSize;               
   int m_DXTBlockWidth;              
   int m_DXTBlockHeight;             

   RM_BYTE   *m_pBuffer;             
}; // End of RmVolume


//=============================================================================
//=============================================================================
class RM_API Rm3DTexture : public RmTexture
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   Rm3DTexture();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~Rm3DTexture();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   bool Create( RmPixelFormatType pixelFormat, int width, int height, int depth,
                int numMipmaps );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   void Destroy();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int          GetNumMipmaps() const { return m_numMipmaps; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmVolume*       GetMipmap( int level );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RmVolume* GetMipmap( int level ) const;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmTextureType GetTextureType() const { return RM_TEXTURE_3D; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetWidth() const { return m_width; };    

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetHeight() const { return m_height; };  // Height of top level mipmap

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetDepth() const { return m_depth; };    // Depth of top level mipmap

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmPixelFormatType GetPixelFormat() const { return m_pixelFormat; };

private :
   int               m_numMipmaps;  
   RmVolume         *m_pMipmaps;    

   RmPixelFormatType m_pixelFormat; 
   int               m_width;       
   int               m_height;      
   int               m_depth;       

}; // End of Rm3DTexture

#endif

---