Frustum.h

#pragma once
 
#include <Foundation/Math/Mat4.h>
#include <Foundation/Math/Plane.h>
#include <Foundation/SimdMath/SimdBBox.h>
#include <Foundation/SimdMath/SimdBSphere.h>
#include <Foundation/SimdMath/SimdVec4b.h>
#include <Foundation/SimdMath/SimdVec4f.h>
 
struct plVolumePosition
{
  enum Enum
  {
    Outside,      //< means an object is ENTIRELY inside a volume
    Inside,       //< means an object is outside a volume
    Intersecting, //< means an object is PARTIALLY inside/outside a volume
  };
};
 
class PL_FOUNDATION_DLL plFrustum
{
public:
  enum PlaneType : plUInt8
  {
    NearPlane,
    LeftPlane,
    RightPlane,
    FarPlane,
    BottomPlane,
    TopPlane,
 
    PLANE_COUNT
  };
 
  enum FrustumCorner : plUInt8
  {
    NearTopLeft,
    NearTopRight,
    NearBottomLeft,
    NearBottomRight,
    FarTopLeft,
    FarTopRight,
    FarBottomLeft,
    FarBottomRight,
 
    CORNER_COUNT = 8
  };
 
  plFrustum();
  ~plFrustum();
 
  [[nodiscard]] static plFrustum MakeFromPlanes(const plPlane* pPlanes); // [tested]
 
  [[nodiscard]] static plResult TryMakeFromPlanes(plFrustum& out_frustum, const plPlane* pPlanes);
 
  [[nodiscard]] static plFrustum MakeFromMVP(const plMat4& mModelViewProjection, plClipSpaceDepthRange::Enum depthRange = plClipSpaceDepthRange::Default, plHandedness::Enum handedness = plHandedness::Default); // [tested]
 
  [[nodiscard]] static plResult TryMakeFromMVP(plFrustum& out_frustum, const plMat4& mModelViewProjection, plClipSpaceDepthRange::Enum depthRange = plClipSpaceDepthRange::Default, plHandedness::Enum handedness = plHandedness::Default);
 
  [[nodiscard]] static plFrustum MakeFromFOV(const plVec3& vPosition, const plVec3& vForwards, const plVec3& vUp, plAngle fovX, plAngle fovY, float fNearPlane, float fFarPlane); // [tested]
 
  [[nodiscard]] static plResult TryMakeFromFOV(plFrustum& out_frustum, const plVec3& vPosition, const plVec3& vForwards, const plVec3& vUp, plAngle fovX, plAngle fovY, float fNearPlane, float fFarPlane);
 
  [[nodiscard]] static plFrustum MakeFromCorners(const plVec3 pCorners[FrustumCorner::CORNER_COUNT]);
 
  [[nodiscard]] static plResult TryMakeFromCorners(plFrustum& out_frustum, const plVec3 pCorners[FrustumCorner::CORNER_COUNT]);
 
  const plPlane& GetPlane(plUInt8 uiPlane) const; // [tested]
 
  plPlane& AccessPlane(plUInt8 uiPlane);
 
  bool IsValid() const;
 
  void TransformFrustum(const plMat4& mTransform); // [tested]
 
  plFrustum GetTransformedFrustum(const plMat4& mTransform) const; // [tested]
 
  void InvertFrustum(); // [tested]
 
  plResult ComputeCornerPoints(plVec3 out_pPoints[FrustumCorner::CORNER_COUNT]) const; // [tested]
 
  plVolumePosition::Enum GetObjectPosition(const plVec3* pVertices, plUInt32 uiNumVertices) const; // [tested]
 
  plVolumePosition::Enum GetObjectPosition(const plVec3* pVertices, plUInt32 uiNumVertices, const plMat4& mObjectTransform) const; // [tested]
 
  plVolumePosition::Enum GetObjectPosition(const plBoundingSphere& sphere) const; // [tested]
 
  plVolumePosition::Enum GetObjectPosition(const plBoundingBox& box) const; // [tested]
 
  bool Overlaps(const plSimdBBox& object) const; // [tested]
 
  bool Overlaps(const plSimdBSphere& object) const; // [tested]
 
private:
  plPlane m_Planes[PLANE_COUNT];
};
 
#include <Foundation/Math/Implementation/Frustum_inl.h>