neo/framework/DeclFX.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 __DECLFX_H__
  30 #define __DECLFX_H__
  31
  32 /*
  33 ===============================================================================
  34
  35         idDeclFX
  36
  37 ===============================================================================
  38 */
  39
  40 enum {
  41         FX_LIGHT,
  42         FX_PARTICLE,
  43         FX_DECAL,
  44         FX_MODEL,
  45         FX_SOUND,
  46         FX_SHAKE,
  47         FX_ATTACHLIGHT,
  48         FX_ATTACHENTITY,
  49         FX_LAUNCH,
  50         FX_SHOCKWAVE
  51 };
  52
  53 //
  54 // single fx structure
  55 //
  56 typedef struct {
  57         int                                             type;
  58         int                                             sibling;
  59
  60         idStr                                   data;
  61         idStr                                   name;
  62         idStr                                   fire;
  63
  64         float                                   delay;
  65         float                                   duration;
  66         float                                   restart;
  67         float                                   size;
  68         float                                   fadeInTime;
  69         float                                   fadeOutTime;
  70         float                                   shakeTime;
  71         float                                   shakeAmplitude;
  72         float                                   shakeDistance;
  73         float                                   shakeImpulse;
  74         float                                   lightRadius;
  75         float                                   rotate;
  76         float                                   random1;
  77         float                                   random2;
  78
  79         idVec3                                  lightColor;
  80         idVec3                                  offset;
  81         idMat3                                  axis;
  82
  83         bool                                    soundStarted;
  84         bool                                    shakeStarted;
  85         bool                                    shakeFalloff;
  86         bool                                    shakeIgnoreMaster;
  87         bool                                    bindParticles;
  88         bool                                    explicitAxis;
  89         bool                                    noshadows;
  90         bool                                    particleTrackVelocity;
  91         bool                                    trackOrigin;
  92 } idFXSingleAction;
  93
  94 //
  95 // grouped fx structures
  96 //
  97 class idDeclFX : public idDecl {
  98 public:
  99         virtual size_t                  Size( void ) const;
 100         virtual const char *    DefaultDefinition( void ) const;
 101         virtual bool                    Parse( const char *text, const int textLength );
 102         virtual void                    FreeData( void );
 103         virtual void                    Print( void ) const;
 104         virtual void                    List( void ) const;
 105
 106         idList<idFXSingleAction>events;
 107         idStr                                   joint;
 108
 109 private:
 110         void                                    ParseSingleFXAction( idLexer &src, idFXSingleAction& FXAction );
 111 };
 112
 113 #endif /* !__DECLFX_H__ */