OgreOctreeZoneOctree.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
OgreOctree.h  -  description
-----------------------------------------------------------------------------
begin                : Mon Sep 30 2002
copyright            : (C) 2002 by Jon Anderson
email                : janders@users.sf.net

Enhancements 2003 - 2004 (C) The OGRE Team

Modified slightly for use with PCZSceneManager Octree Zones by Eric Cha

-----------------------------------------------------------------------------
*/

#ifndef OCTREE_H
#define OCTREE_H

#include <OgreAxisAlignedBox.h>
#include <OgreWireBoundingBox.h>

#include <list>

namespace Ogre
{

class PCZSceneNode;
class PCZone;

typedef set< PCZSceneNode * >::type PCZSceneNodeList;


class Octree : public SceneCtlAllocatedObject
{
public:
    Octree( PCZone * zone, Octree * p );
    ~Octree();

    void _addNode( PCZSceneNode * );

    void _removeNode( PCZSceneNode * );

    int numNodes()
    {
        return mNumNodes;
    };

    AxisAlignedBox mBox;
    WireBoundingBox* mWireBoundingBox;
    
    WireBoundingBox* getWireBoundingBox();

    Vector3 mHalfSize;

    Octree * mChildren[ 2 ][ 2 ][ 2 ];

    bool _isTwiceSize( const AxisAlignedBox &box ) const;

    void _getChildIndexes( const AxisAlignedBox &, int *x, int *y, int *z ) const;

    void _getCullBounds( AxisAlignedBox * ) const;

    /* Recurse through the Octree to find the scene nodes which intersect an aab
    */
    void _findNodes(const AxisAlignedBox &t, 
                    PCZSceneNodeList &list, 
                    PCZSceneNode *exclude, 
                    bool includeVisitors,
                    bool full );

    /* Recurse through the Octree to find the scene nodes which intersect a ray
    */
    void _findNodes(const Ray &t, 
                    PCZSceneNodeList &list, 
                    PCZSceneNode *exclude, 
                    bool includeVisitors,
                    bool full );

    /* Recurse through the Octree to find the scene nodes which intersect a sphere
    */
    void _findNodes(const Sphere &t, 
                    PCZSceneNodeList &list, 
                    PCZSceneNode *exclude, 
                    bool includeVisitors,
                    bool full );

    /* Recurse through the Octree to find the scene nodes which intersect a PBV
    */
    void _findNodes(const PlaneBoundedVolume &t, 
                    PCZSceneNodeList &list, 
                    PCZSceneNode *exclude, 
                    bool includeVisitors,
                    bool full );

    PCZSceneNodeList mNodes;

    /* Zone that this octree is in */
    PCZone * mZone;

protected:

    inline void _ref()
    {
        mNumNodes++;

        if ( mParent != 0 ) mParent -> _ref();
    };

    inline void _unref()
    {
        mNumNodes--;

        if ( mParent != 0 ) mParent -> _unref();
    };

    int mNumNodes;

    Octree * mParent;

};

}

#endif