PortalFrustum.h

#pragma once
#include "ShapeAABB.h"
#include "ShapeSphere.h"
#include <boost/circular_buffer.hpp>
#include <deque>

namespace ParaEngine
{
    class CPortalNode;
    class CShapeFrustum;
    class CBaseObject;

    class PCPlane : public Plane
    {
    public:
        PCPlane();
        PCPlane(const Plane & plane);
        PCPlane(const Vector3& rkNormal, const Vector3& rkPoint);
        PCPlane(const Vector3& rkPoint0, const Vector3& rkPoint1, const Vector3& rkPoint2);

        void SetPlane(const Plane & plane);

        ~PCPlane();

        CPortalNode * GetPortal()
        {
            return m_portal;
        };

        void SetPortal( CPortalNode *o )
        {
            m_portal = o;
        };

    protected:

        CPortalNode *m_portal;
    };

    typedef boost::circular_buffer < PCPlane * > PCPlaneList;

    class CPortalFrustum
    {
    public:
        // visibility types
        enum Visibility
        {
            NONE,
            PARTIAL,
            FULL
        };

        CPortalFrustum(void);
        ~CPortalFrustum(void);
    public:
        // set the origin value
        void setOrigin(const Vector3 & newOrigin);

        /* isVisible function for aabb */
        bool isVisible( const CShapeAABB &bound) const;

        /* return true if we can see the view clipping scene object. it will use the OBB of the view clipping object. */
        bool CanSeeObject( IViewClippingObject * pViewClippingObject) const;
        bool CanSeeObject_PortalOnly( IViewClippingObject * pViewClippingObject) const;

        bool CanSeeObject_CompleteCull( IViewClippingObject * pViewClippingObject, int nFullCullIndex=-1) const;

        /* isVisible function for sphere */
        bool isVisible( const CShapeSphere &bound) const;
        /* isVisible() function for portals 
        * @param bIgnorePortalDirection: default to true. This should be set to false, if you are testing within a zone that may contain other zones. 
        * such as the root zone. however, for all convex zones that does not contain other zones, one can set this to true. 
        */
        bool isVisible (CPortalNode * portal, bool bIgnorePortalDirection = true);

        /* more detailed check for visibility of an AABB */
        Visibility getVisibility(const CShapeAABB & bound);

        // calculate extra culling planes from portal and camera 
        // origin and add to list of extra culling planes
        // @param bAutoDirection: it will correct portal direction, so that it does not face away from the camera eye
        int AddPortalCullingPlanes(CPortalNode * portal, bool bAutoDirection = true);

        bool AddCullingPlane(const Plane& plane, bool bAddToFront = true);

        int AddFrustum(CShapeFrustum * frustum, float fNearPlaneShiftDistance = 0.f);

        // remove extra culling planes created from the given portal
        void RemovePortalCullingPlanes(CPortalNode *portal);

        // remove all extra culling planes
        void RemoveAllExtraCullingPlanes(void);

        // get an unused PCPlane from the CullingPlane Reservoir
        PCPlane * getUnusedCullingPlane(void);
        
    private:
        Vector3 m_vOrigin;
        PCPlaneList m_ActiveCullingPlanes;
        PCPlaneList m_CullingPlaneReservoir;
    };
}