Frustum.hpp

#pragma once
#ifndef __H__OCULAR_MATH_FRUSTUM__H__
#define __H__OCULAR_MATH_FRUSTUM__H__

#include "Math/Matrix4x4.hpp"
#include "Math/Geometry/Plane.hpp"
#include <array>

//------------------------------------------------------------------------------------------

namespace Ocular
{
    namespace Math
    {
        class BoundsAABB;
        class BoundsOBB;
        class BoundsSphere;

        class Frustum
        {
        public:

            Frustum();
            ~Frustum();

            //------------------------------------------------------------
            // View and Projection matrix setting
            //------------------------------------------------------------

            void rebuild();

            void setViewMatrix(Math::Matrix4x4 const& viewMatrix);

            void setProjectionMatrix(Math::Matrix4x4 const& projMatrix);

            Math::Matrix4x4 getViewMatrix() const;

            Math::Matrix4x4 getProjectionMatrix() const;

            //------------------------------------------------------------
            // Misc Getters
            //------------------------------------------------------------

            Vector3f const& getOrigin() const;

            std::array<Vector3f, 4> const& getNearClipCorners() const;

            std::array<Vector3f, 4> const& getFarClipCorners() const;

            //------------------------------------------------------------
            // Containment Testing
            //------------------------------------------------------------

            bool contains(Point3f const& point) const;

            bool contains(BoundsSphere const& bounds) const;
            
            bool contains(BoundsAABB const& bounds) const;
            
            bool contains(BoundsOBB const& bounds) const;

            //------------------------------------------------------------
            // Property Retrieval
            //------------------------------------------------------------

            float getNearClipDistance() const;

            float getFarClipDistance() const;

            Plane const& getLeftPlane() const;

            Plane const& getRightPlane() const;

            Plane const& getTopPlane() const;

            Plane const& getBottomPlane() const;

            Plane const& getNearPlane() const;

            Plane const& getFarPlane() const;

            float getFieldOfView() const;

            float getAspectRatio() const;

            float getXMin() const;
            
            float getXMax() const;
            
            float getYMin() const;
            
            float getYMax() const;

        protected:

        private:

            Math::Matrix4x4 m_ViewMatrix;
            Math::Matrix4x4 m_ProjMatrix;

            float m_MinX;
            float m_MaxX;
            float m_MinY;
            float m_MaxY;
            float m_NearClip;
            float m_FarClip;

            // Perspective-specific variables saved for user querying

            float m_FieldOfView;
            float m_AspectRatio;

            Vector3f m_Origin;

            std::array<Vector3f, 4> m_NearCorners;  
            std::array<Vector3f, 4> m_FarCorners;   

            Plane m_LeftPlane;
            Plane m_RightPlane;
            Plane m_TopPlane;
            Plane m_BottomPlane;
            Plane m_NearPlane;
            Plane m_FarPlane;
        };
    }
}
//------------------------------------------------------------------------------------------

#endif