neo/renderer/ModelOverlay.h

   1 /*
   2 ===========================================================================
   3
   4 Doom 3 GPL Source Code
   5 Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
   6
   7 This file is part of the Doom 3 GPL Source Code (?Doom 3 Source Code?).
   8
   9 Doom 3 Source Code is free software: you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation, either version 3 of the License, or
  12 (at your option) any later version.
  13
  14 Doom 3 Source Code is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with Doom 3 Source Code.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code.  If not, please request a copy in writing from id Software at the address below.
  23
  24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
  25
  26 ===========================================================================
  27 */
  28
  29 #ifndef __MODELOVERLAY_H__
  30 #define __MODELOVERLAY_H__
  31
  32 /*
  33 ===============================================================================
  34
  35         Render model overlay for adding decals on top of dynamic models.
  36
  37 ===============================================================================
  38 */
  39
  40 const int MAX_OVERLAY_SURFACES  = 16;
  41
  42 typedef struct overlayVertex_s {
  43         int                                                     vertexNum;
  44         float                                           st[2];
  45 } overlayVertex_t;
  46
  47 typedef struct overlaySurface_s {
  48         int                                                     surfaceNum;
  49         int                                                     surfaceId;
  50         int                                                     numIndexes;
  51         glIndex_t *                                     indexes;
  52         int                                                     numVerts;
  53         overlayVertex_t *                       verts;
  54 } overlaySurface_t;
  55
  56 typedef struct overlayMaterial_s {
  57         const idMaterial *                      material;
  58         idList<overlaySurface_t *>      surfaces;
  59 } overlayMaterial_t;
  60
  61
  62 class idRenderModelOverlay {
  63 public:
  64                                                                 idRenderModelOverlay();
  65                                                                 ~idRenderModelOverlay();
  66
  67         static idRenderModelOverlay *Alloc( void );
  68         static void                                     Free( idRenderModelOverlay *overlay );
  69
  70         // Projects an overlay onto deformable geometry and can be added to
  71         // a render entity to allow decals on top of dynamic models.
  72         // This does not generate tangent vectors, so it can't be used with
  73         // light interaction shaders. Materials for overlays should always
  74         // be clamped, because the projected texcoords can run well off the
  75         // texture since no new clip vertexes are generated.
  76         void                                            CreateOverlay( const idRenderModel *model, const idPlane localTextureAxis[2], const idMaterial *material );
  77
  78         // Creates new model surfaces for baseModel, which should be a static instantiation of a dynamic model.
  79         void                                            AddOverlaySurfacesToModel( idRenderModel *baseModel );
  80
  81         // Removes overlay surfaces from the model.
  82         static void                                     RemoveOverlaySurfacesFromModel( idRenderModel *baseModel );
  83
  84         void                                            ReadFromDemoFile( class idDemoFile *f );
  85         void                                            WriteToDemoFile( class idDemoFile *f ) const;
  86
  87 private:
  88         idList<overlayMaterial_t *>     materials;
  89
  90         void                                            FreeSurface( overlaySurface_t *surface );
  91 };
  92
  93 #endif /* !__MODELOVERLAY_H__ */