OgreBspNode.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-2011 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.
-----------------------------------------------------------------------------
*/
#ifndef _BspNode_H__
#define _BspNode_H__

#include "OgreBspPrerequisites.h"
#include "OgrePlane.h"
#include "OgreAxisAlignedBox.h"
#include "OgreSceneQuery.h"

namespace Ogre {

    class BspNode : public NodeAlloc
    {
        friend class BspLevel;

    public:
        BspNode(BspLevel* owner, bool isLeaf);

        BspNode();
        ~BspNode();

        bool isLeaf(void) const;

        BspNode* getFront(void) const;

        BspNode* getBack(void) const;

        Plane::Side getSide (const Vector3& point) const;

        BspNode* getNextNode(const Vector3& point) const;


        const Plane& getSplitPlane(void) const;

        const AxisAlignedBox& getBoundingBox(void) const;

        int getNumFaceGroups(void) const;
        int getFaceGroupStart(void) const;

        bool isLeafVisible(const BspNode* leaf) const;

        friend std::ostream& operator<< (std::ostream& o, BspNode& n);

        void _addMovable(const MovableObject* mov);

        void _removeMovable(const MovableObject* mov);

        Real getDistance(const Vector3& pos) const;

        typedef set<const MovableObject*>::type IntersectingObjectSet;

        struct Brush
        {
            list<Plane>::type planes;
            SceneQuery::WorldFragment fragment; // For query reporting
        };
        typedef vector<Brush*>::type NodeBrushList; // Main brush memory held on level

        const NodeBrushList& getSolidBrushes(void) const;
    protected:
        BspLevel* mOwner; // Back-reference to containing level
        bool mIsLeaf;

        // Node-only members
        Plane mSplitPlane;
        BspNode* mFront;
        BspNode* mBack;

        // Leaf-only members
        int mVisCluster;

        AxisAlignedBox mBounds;
        int mNumFaceGroups;
        int mFaceGroupStart;

        IntersectingObjectSet mMovables;

        NodeBrushList mSolidBrushes;
    public:
        const IntersectingObjectSet& getObjects(void) const { return mMovables; }


    };


}

#endif