sfxSpace.h

Classes:

class
A convex space that defines a custom ambient sound space.
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 _SFXSPACE_H_
25#define _SFXSPACE_H_
26
27#ifndef _SCENESPACE_H_
28#include "scene/sceneSpace.h"
29#endif
30
31#ifndef _SCENEAMBIENTSOUNDOBJECT_H_
32#include "scene/mixin/sceneAmbientSoundObject.h"
33#endif
34
35#ifndef _SCENEPOLYHEDRALOBJECT_H_
36#include "scene/mixin/scenePolyhedralObject.h"
37#endif
38
39
40/// A convex space that defines a custom ambient sound space.
41class SFXSpace : public SceneAmbientSoundObject< ScenePolyhedralObject< SceneSpace > >
42{
43   public:
44
45      typedef SceneAmbientSoundObject< ScenePolyhedralObject< SceneSpace> > Parent;
46
47   protected:
48
49      // SceneSpace.
50      virtual ColorI _getDefaultEditorSolidColor() const { return ColorI( 244, 135, 18, 45 ); }
51
52   public:
53
54      SFXSpace();
55
56      // SimObject.
57      DECLARE_CONOBJECT( SFXSpace );
58      DECLARE_DESCRIPTION( "A box volume that defines an ambient sound space." );
59      DECLARE_CATEGORY( "3D Sound" );
60
61      static void consoleInit();
62};
63
64#endif // !_SFXSPACE_H_
65