sfxEnvironment.h

Classes:

class
A datablock that defines a reverb environment.
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _SFXENVIRONMENT_H_
25#define _SFXENVIRONMENT_H_
26
27#ifndef _SIMDATABLOCK_H_
28   #include "console/simDatablock.h"
29#endif
30#ifndef _CONSOLETYPES_H_
31   #include "console/consoleTypes.h"
32#endif
33#ifndef _SFXCOMMON_H_
34   #include "sfx/sfxCommon.h"
35#endif
36
37
38/// A datablock that defines a reverb environment.
39class SFXEnvironment : public SimDataBlock
40{
41   public:
42
43      typedef SimDataBlock Parent;
44
45   protected:
46   
47      /// The reverb properties.
48      SFXReverbProperties mReverb;
49
50   public:
51
52      SFXEnvironment();
53      
54      ///
55      void validate();
56      
57      DECLARE_CONOBJECT( SFXEnvironment );
58      DECLARE_CATEGORY( "SFX" );
59      DECLARE_DESCRIPTION( "A reverb environment." );
60      
61      static void initPersistFields();
62
63      virtual bool onAdd();
64      virtual bool preload( bool server, String& errorStr );
65      virtual void packData( BitStream* stream );
66      virtual void unpackData( BitStream* stream );
67      virtual void inspectPostApply();
68
69      /// @return The reverb properties of the sound environment.
70      const SFXReverbProperties& getReverb() const { return mReverb; }
71};
72
73
74#endif // _SFXENVIRONMENT_H_
75