sceneRootZone.h

Engine/source/scene/zones/sceneRootZone.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 _SCENEROOTZONE_H_
25#define _SCENEROOTZONE_H_
26
27#ifndef _SCENESIMPLEZONE_H_
28#include "scene/zones/sceneSimpleZone.h"
29#endif
30
31
32
33/// Root zone in a scene.
34///
35/// The root zone is an infinite zone that contains all others zones and
36/// objects in the scene.
37///
38/// This class is not declared as a ConsoleObject and is not visible
39/// from TorqueScript.  SceneRootZone objects are not registered with the
40/// Sim system.
41class SceneRootZone : public SceneSimpleZone
42{
43   public:
44
45      typedef SceneSimpleZone Parent;
46
47   protected:
48
49      // SceneObject.
50      virtual bool onSceneAdd();
51      virtual void onSceneRemove();
52
53   public:
54
55      SceneRootZone();
56
57      // SimObject.
58      virtual bool onAdd();
59      virtual void onRemove();
60      virtual String describeSelf() const;
61
62      // SceneObject.
63      virtual bool containsPoint( const Point3F &point ) const;
64
65      // SceneZoneSpace.
66      virtual U32 getPointZone( const Point3F &p ) const;
67      virtual bool getOverlappingZones( const Box3F& aabb, U32* outZones, U32& outNumZones );
68};
69
70#endif //_SCENEROOTZONE_H_
71