sceneAmbientSoundObject.h

Engine/source/scene/mixin/sceneAmbientSoundObject.h

More...

Classes:

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 _SCENEAMBIENTSOUNDOBJECT_H_
25#define _SCENEAMBIENTSOUNDOBJECT_H_
26
27
28class SFXAmbience;
29
30
31/// Template mixin to add ability to hold a custom SFXAmbience to
32/// a SceneObject.
33template< typename Base >
34class SceneAmbientSoundObject : public Base
35{
36   public:
37
38      typedef Base Parent;
39
40   protected:
41
42      enum
43      {
44         SoundMask     = Parent::NextFreeMask << 0,   ///< Ambient sound properties have changed.
45         NextFreeMask  = Parent::NextFreeMask << 1,
46      };
47
48      /// Ambient sound properties for this space.
49      SFXAmbience* mSoundAmbience;
50
51   public:
52
53      SceneAmbientSoundObject();
54
55      /// Set the ambient sound properties for the space.
56      void setSoundAmbience( SFXAmbience* ambience );
57
58      // SimObject.
59      static void initPersistFields();
60
61      // NetObject.
62      virtual U32 packUpdate( NetConnection* connection, U32 mask, BitStream* stream );
63      virtual void unpackUpdate( NetConnection* connection, BitStream* stream );
64
65      // SceneObject.
66      virtual SFXAmbience* getSoundAmbience() const { return mSoundAmbience; }
67
68   private:
69
70      // Console field getters/setters.
71      static bool _setSoundAmbience( void* object, const char* index, const char* data );
72};
73
74#endif // !_SCENEAMBIENTSOUNDOBJECT_H_
75