sceneSpace.h

Classes:

class
Abstract base class for SceneObjects that define subspaces in a scene.
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 _SCENESPACE_H_
25#define _SCENESPACE_H_
26
27#ifndef _SCENEOBJECT_H_
28#include "scene/sceneObject.h"
29#endif
30
31
32/// Abstract base class for SceneObjects that define subspaces in a scene.
33///
34/// Use SceneObject::containsPoint to find out whether a given space contains a particular point.
35class SceneSpace : public SceneObject
36{
37   public:
38
39      typedef SceneObject Parent;
40
41   protected:
42
43      enum
44      {
45         TransformMask = Parent::NextFreeMask << 0,   ///< Object transform has changed.
46         NextFreeMask  = Parent::NextFreeMask << 1,
47      };
48
49      ///
50      BaseMatInstance* mEditorRenderMaterial;
51
52      ///
53      virtual BaseMatInstance* _createEditorRenderMaterial();
54
55      /// Render a visualization of the volume.
56      virtual void _renderObject( ObjectRenderInst* ri, SceneRenderState* state, BaseMatInstance* overrideMat );
57
58      ///
59      virtual ColorI _getDefaultEditorSolidColor() const { return ColorI( 255, 255, 255, 45 ); }
60      virtual ColorI _getDefaultEditorWireframeColor() const { return ColorI::BLACK; }
61
62   public:
63
64      SceneSpace();
65      ~SceneSpace();
66
67      // SimObject.
68      virtual bool onAdd();
69      virtual void onRemove();
70
71      // SceneObject.
72      virtual void setTransform( const MatrixF &mat );
73      virtual void prepRenderImage( SceneRenderState* state );
74
75      // NetObject.
76      virtual U32 packUpdate( NetConnection* connection, U32 mask, BitStream* stream );
77      virtual void unpackUpdate( NetConnection* connection, BitStream* stream );
78
79      // SimObject.
80      virtual void onEditorEnable();
81      virtual void onEditorDisable();
82};
83
84#endif // !_SCENESPACE_H_
85