OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreOctreeZoneOctree.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 OgreOctree.h - description
28 -----------------------------------------------------------------------------
29 begin : Mon Sep 30 2002
30 copyright : (C) 2002 by Jon Anderson
31 email : janders@users.sf.net
32 
33 Modified slightly for use with PCZSceneManager Octree Zones by Eric Cha
34 
35 -----------------------------------------------------------------------------
36 */
37 
38 #ifndef OCTREE_H
39 #define OCTREE_H
40 
41 #include "OgreAxisAlignedBox.h"
42 
43 #include <list>
44 
45 namespace Ogre
46 {
47 
48 class PCZSceneNode;
49 class PCZone;
50 
52 
53 
62 class Octree : public SceneCtlAllocatedObject
63 {
64 public:
65  Octree( PCZone * zone, Octree * p );
66  ~Octree();
67 
73  void _addNode( PCZSceneNode * );
74 
77  void _removeNode( PCZSceneNode * );
78 
81  int numNodes()
82  {
83  return mNumNodes;
84  };
85 
92 
96 
100 
106  Octree * mChildren[ 2 ][ 2 ][ 2 ];
107 
113  bool _isTwiceSize( const AxisAlignedBox &box ) const;
114 
121  void _getChildIndexes( const AxisAlignedBox &, int *x, int *y, int *z ) const;
122 
127  void _getCullBounds( AxisAlignedBox * ) const;
128 
129  /* Recurse through the Octree to find the scene nodes which intersect an aab
130  */
131  void _findNodes(const AxisAlignedBox &t,
133  PCZSceneNode *exclude,
134  bool includeVisitors,
135  bool full );
136 
137  /* Recurse through the Octree to find the scene nodes which intersect a ray
138  */
139  void _findNodes(const Ray &t,
141  PCZSceneNode *exclude,
142  bool includeVisitors,
143  bool full );
144 
145  /* Recurse through the Octree to find the scene nodes which intersect a sphere
146  */
147  void _findNodes(const Sphere &t,
149  PCZSceneNode *exclude,
150  bool includeVisitors,
151  bool full );
152 
153  /* Recurse through the Octree to find the scene nodes which intersect a PBV
154  */
155  void _findNodes(const PlaneBoundedVolume &t,
157  PCZSceneNode *exclude,
158  bool includeVisitors,
159  bool full );
160 
164 
165  /* Zone that this octree is in */
167 
168 protected:
169 
172  inline void _ref()
173  {
174  mNumNodes++;
175 
176  if ( mParent != 0 ) mParent -> _ref();
177  };
178 
181  inline void _unref()
182  {
183  mNumNodes--;
184 
185  if ( mParent != 0 ) mParent -> _unref();
186  };
187 
189  int mNumNodes;
190 
192  Octree * mParent;
193 
194 };
195 
196 }
197 
198 #endif
199 
200 
Representation of a ray in space, i.e.
Definition: OgreRay.h:45
set< PCZSceneNode * >::type PCZSceneNodeList
Vector3 mHalfSize
Vector containing the dimensions of this octree / 2.
Definition: OgreOctree.h:94
int mNumNodes
number of SceneNodes in this octree and all its children.
Definition: OgreOctree.h:148
void _removeNode(OctreeNode *)
Removes an Octree scene node to this octree level.
void _addNode(OctreeNode *)
Adds an Octree scene node to this octree level.
Octree * mChildren[2][2][2]
3D array of children of this octree.
Definition: OgreOctree.h:101
A 3D box aligned with the x/y/z axes.
void _unref()
Decrements the overall node count of this octree and all its parents.
bool _isTwiceSize(const AxisAlignedBox &box) const
Determines if this octree is twice as big as the given box.
void _findNodes(const AxisAlignedBox &t, PCZSceneNodeList &list, PCZSceneNode *exclude, bool includeVisitors, bool full)
int numNodes()
Returns the number of scene nodes attached to this octree.
AxisAlignedBox mBox
The bounding box of the octree.
Definition: OgreOctree.h:79
Octree * mParent
parent octree
Definition: OgreOctree.h:154
A sphere primitive, mostly used for bounds checking.
Definition: OgreSphere.h:51
Octree datastructure for managing scene nodes.
Definition: OgreOctree.h:57
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
void _getChildIndexes(const AxisAlignedBox &, int *x, int *y, int *z) const
Returns the appropriate indexes for the child of this octree into which the box will fit...
PCZSceneNodeList mNodes
Public list of SceneNodes attached to this particular octree.
Standard 3-dimensional vector.
Definition: OgreVector3.h:50
WireBoundingBox * mWireBoundingBox
Definition: OgreOctree.h:86
Represents a convex volume bounded by planes.
Allows the rendering of a wireframe bounding box.
void _ref()
Increments the overall node count of this octree and all its parents.
WireBoundingBox * getWireBoundingBox()
Creates the wire frame bounding box for this octant.
Portal-Connected Zone datastructure for managing scene nodes.
Definition: OgrePCZone.h:81
void _getCullBounds(AxisAlignedBox *) const
Creates the AxisAlignedBox used for culling this octree.
Octree(Octree *p)