Documentation for Frustum
Former-commit-id: 38c09bfa36e663a77ebeb19f5b2c16f60f99ea14
This commit is contained in:
Gawaboumga
parent
5d0624f03f
commit
fa48b750ae
|
|
@ -15,6 +15,20 @@
|
|||
|
||||
namespace Nz
|
||||
{
|
||||
|
||||
/*!
|
||||
* \class Nz::Frustum<T>
|
||||
* \brief Math class that represents a frustum in the three dimensional vector space
|
||||
*
|
||||
* Frustums are used to determine what is inside the camera's field of view. They help speed up the rendering process
|
||||
*/
|
||||
|
||||
/*!
|
||||
* \brief Constructs a Frustum<T> object from another type of Frustum
|
||||
*
|
||||
* \param frustum Frustum of type U to convert to type T
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
template<typename U>
|
||||
Frustum<T>::Frustum(const Frustum<U>& frustum)
|
||||
|
|
@ -22,6 +36,19 @@ namespace Nz
|
|||
Set(frustum);
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Builds the frustum object
|
||||
* \return A reference to this frustum which is the build up camera's field of view
|
||||
*
|
||||
* \param angle Unit depends on NAZARA_MATH_ANGLE_RADIAN
|
||||
* \param ratio Rendering ratio (typically 16/9 or 4/3)
|
||||
* \param zNear Distance where 'vision' begins
|
||||
* \param zFar Distance where 'vision' ends
|
||||
* \param eye Position of the camera
|
||||
* \param target Position of the target of the camera
|
||||
* \param up Direction of up vector according to the orientation of camera
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
Frustum<T>& Frustum<T>::Build(T angle, T ratio, T zNear, T zFar, const Vector3<T>& eye, const Vector3<T>& target, const Vector3<T>& up)
|
||||
{
|
||||
|
|
@ -45,7 +72,7 @@ namespace Nz
|
|||
Vector3<T> nc = eye + f * zNear;
|
||||
Vector3<T> fc = eye + f * zFar;
|
||||
|
||||
// Calcul du frustum
|
||||
// Computing the frustum
|
||||
m_corners[BoxCorner_FarLeftBottom] = fc - u * farH - s * farW;
|
||||
m_corners[BoxCorner_FarLeftTop] = fc + u * farH - s * farW;
|
||||
m_corners[BoxCorner_FarRightTop] = fc + u * farH + s * farW;
|
||||
|
|
@ -56,7 +83,7 @@ namespace Nz
|
|||
m_corners[BoxCorner_NearRightTop] = nc + u * nearH + s * nearW;
|
||||
m_corners[BoxCorner_NearRightBottom] = nc - u * nearH + s * nearW;
|
||||
|
||||
// Construction des plans du frustum
|
||||
// Construction of frustum's planes
|
||||
m_planes[FrustumPlane_Bottom].Set(m_corners[BoxCorner_NearLeftBottom], m_corners[BoxCorner_NearRightBottom], m_corners[BoxCorner_FarRightBottom]);
|
||||
m_planes[FrustumPlane_Far].Set(m_corners[BoxCorner_FarRightTop], m_corners[BoxCorner_FarLeftTop], m_corners[BoxCorner_FarLeftBottom]);
|
||||
m_planes[FrustumPlane_Left].Set(m_corners[BoxCorner_NearLeftTop], m_corners[BoxCorner_NearLeftBottom], m_corners[BoxCorner_FarLeftBottom]);
|
||||
|
|
@ -67,6 +94,18 @@ namespace Nz
|
|||
return *this;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a bounding volume is contained in the frustum
|
||||
* \return true if the bounding volume is entirely in the frustum
|
||||
*
|
||||
* \param volume Volume to check
|
||||
*
|
||||
* \remark If volume is infinite, true is returned
|
||||
* \remark If volume is null, false is returned
|
||||
* \remark If enumeration of the volume is not defined in Extend, a NazaraError is thrown and false is returned
|
||||
* \remark If enumeration of the intersection is not defined in IntersectionSide, a NazaraError is thrown and false is returned. This should not never happen for a user of the library
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
bool Frustum<T>::Contains(const BoundingVolume<T>& volume) const
|
||||
{
|
||||
|
|
@ -102,6 +141,13 @@ namespace Nz
|
|||
return false;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a box is contained in the frustum
|
||||
* \return true if the box is entirely in the frustum
|
||||
*
|
||||
* \param box Box to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
bool Frustum<T>::Contains(const Box<T>& box) const
|
||||
{
|
||||
|
|
@ -115,12 +161,26 @@ namespace Nz
|
|||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not an oriented box is contained in the frustum
|
||||
* \return true if the oriented box is entirely in the frustum
|
||||
*
|
||||
* \param orientedbox Oriented box to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
bool Frustum<T>::Contains(const OrientedBox<T>& orientedbox) const
|
||||
{
|
||||
return Contains(&orientedbox[0], 8);
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a sphere is contained in the frustum
|
||||
* \return true if the sphere is entirely in the frustum
|
||||
*
|
||||
* \param sphere Sphere to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
bool Frustum<T>::Contains(const Sphere<T>& sphere) const
|
||||
{
|
||||
|
|
@ -133,6 +193,13 @@ namespace Nz
|
|||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a Vector3 is contained in the frustum
|
||||
* \return true if the Vector3 is in the frustum
|
||||
*
|
||||
* \param point Vector3 which represents a point in the space
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
bool Frustum<T>::Contains(const Vector3<T>& point) const
|
||||
{
|
||||
|
|
@ -145,6 +212,14 @@ namespace Nz
|
|||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a set of Vector3 is contained in the frustum
|
||||
* \return true if the set of Vector3 is in the frustum
|
||||
*
|
||||
* \param points Pointer to Vector3 which represents a set of points in the space
|
||||
* \param pointCount Number of points to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
bool Frustum<T>::Contains(const Vector3<T>* points, unsigned int pointCount) const
|
||||
{
|
||||
|
|
@ -164,6 +239,15 @@ namespace Nz
|
|||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Constructs the frustum from a Matrix4
|
||||
* \return A reference to this frustum which is the build up of projective matrix
|
||||
*
|
||||
* \param clipMatrix Matrix which represents the transformation of the frustum
|
||||
*
|
||||
* \remark A NazaraWarning is produced if clipMatrix is not inversible and corners are unchanged
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
Frustum<T>& Frustum<T>::Extract(const Matrix4<T>& clipMatrix)
|
||||
{
|
||||
|
|
@ -261,8 +345,8 @@ namespace Nz
|
|||
|
||||
m_planes[FrustumPlane_Near].Set(plane);
|
||||
|
||||
// Une fois les plans extraits, il faut extraire les points du frustum
|
||||
// Je me base sur cette page: http://www.gamedev.net/topic/393309-calculating-the-view-frustums-vertices/
|
||||
// Once planes have been extracted, we must extract points of the frustum
|
||||
// Based on: http://www.gamedev.net/topic/393309-calculating-the-view-frustums-vertices/
|
||||
|
||||
Matrix4<T> invClipMatrix;
|
||||
if (clipMatrix.GetInverse(&invClipMatrix))
|
||||
|
|
@ -331,12 +415,31 @@ namespace Nz
|
|||
return *this;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Constructs the frustum from the view matrix and the projection matrix
|
||||
* \return A reference to this frustum which is the build up of projective matrix
|
||||
*
|
||||
* \param view Matrix which represents the view
|
||||
* \param projection Matrix which represents the projection (the perspective)
|
||||
*
|
||||
* \remark A NazaraWarning is produced if the product of these matrices is not inversible and corners are unchanged
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
Frustum<T>& Frustum<T>::Extract(const Matrix4<T>& view, const Matrix4<T>& projection)
|
||||
{
|
||||
return Extract(Matrix4<T>::Concatenate(view, projection));
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Gets the Vector3 for the corner
|
||||
* \return The position of the corner of the frustum according to enum BoxCorner
|
||||
*
|
||||
* \param corner Enumeration of type BoxCorner
|
||||
*
|
||||
* \remark If enumeration is not defined in BoxCorner and NAZARA_DEBUG defined, a NazaraError is thrown and a Vector3 uninitialised is returned
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
const Vector3<T>& Frustum<T>::GetCorner(BoxCorner corner) const
|
||||
{
|
||||
|
|
@ -353,6 +456,15 @@ namespace Nz
|
|||
return m_corners[corner];
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Gets the Plane for the face
|
||||
* \return The face of the frustum according to enum FrustumPlane
|
||||
*
|
||||
* \param plane Enumeration of type FrustumPlane
|
||||
*
|
||||
* \remark If enumeration is not defined in FrustumPlane and NAZARA_DEBUG defined, a NazaraError is thrown and a Plane uninitialised is returned
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
const Plane<T>& Frustum<T>::GetPlane(FrustumPlane plane) const
|
||||
{
|
||||
|
|
@ -369,6 +481,18 @@ namespace Nz
|
|||
return m_planes[plane];
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a bounding volume intersects with the frustum
|
||||
* \return IntersectionSide How the bounding volume is intersecting with the frustum
|
||||
*
|
||||
* \param volume Volume to check
|
||||
*
|
||||
* \remark If volume is infinite, IntersectionSide_Intersecting is returned
|
||||
* \remark If volume is null, IntersectionSide_Outside is returned
|
||||
* \remark If enumeration of the volume is not defined in Extend, a NazaraError is thrown and false is returned
|
||||
* \remark If enumeration of the intersection is not defined in IntersectionSide, a NazaraError is thrown and false is returned. This should not never happen for a user of the library
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
IntersectionSide Frustum<T>::Intersect(const BoundingVolume<T>& volume) const
|
||||
{
|
||||
|
|
@ -394,7 +518,7 @@ namespace Nz
|
|||
}
|
||||
|
||||
case Extend_Infinite:
|
||||
return IntersectionSide_Intersecting; // On ne peut pas contenir l'infini
|
||||
return IntersectionSide_Intersecting; // We can not contain infinity
|
||||
|
||||
case Extend_Null:
|
||||
return IntersectionSide_Outside;
|
||||
|
|
@ -404,6 +528,13 @@ namespace Nz
|
|||
return IntersectionSide_Outside;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a box intersects with the frustum
|
||||
* \return IntersectionSide How the box is intersecting with the frustum
|
||||
*
|
||||
* \param box Box to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
IntersectionSide Frustum<T>::Intersect(const Box<T>& box) const
|
||||
{
|
||||
|
|
@ -421,12 +552,26 @@ namespace Nz
|
|||
return side;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not an oriented box intersects with the frustum
|
||||
* \return IntersectionSide How the oriented box is intersecting with the frustum
|
||||
*
|
||||
* \param oriented box OrientedBox to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
IntersectionSide Frustum<T>::Intersect(const OrientedBox<T>& orientedbox) const
|
||||
{
|
||||
return Intersect(&orientedbox[0], 8);
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a sphere intersects with the frustum
|
||||
* \return IntersectionSide How the sphere is intersecting with the frustum
|
||||
*
|
||||
* \param sphere Sphere to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
IntersectionSide Frustum<T>::Intersect(const Sphere<T>& sphere) const
|
||||
{
|
||||
|
|
@ -445,6 +590,14 @@ namespace Nz
|
|||
return side;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Checks whether or not a set of Vector3 intersects with the frustum
|
||||
* \return IntersectionSide How the set of Vector3 is intersecting with the frustum
|
||||
*
|
||||
* \param points Pointer to Vector3 which represents a set of points in the space
|
||||
* \param pointCount Number of points to check
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
IntersectionSide Frustum<T>::Intersect(const Vector3<T>* points, unsigned int pointCount) const
|
||||
{
|
||||
|
|
@ -468,6 +621,13 @@ namespace Nz
|
|||
return (c == 6) ? IntersectionSide_Inside : IntersectionSide_Intersecting;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Sets the components of the frustum from another frustum
|
||||
* \return A reference to this frustum
|
||||
*
|
||||
* \param frustum The other frustum
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
Frustum<T>& Frustum<T>::Set(const Frustum& frustum)
|
||||
{
|
||||
|
|
@ -476,6 +636,13 @@ namespace Nz
|
|||
return *this;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Sets the components of the frustum from another type of Frustum
|
||||
* \return A reference to this frustum
|
||||
*
|
||||
* \param frustum Frustum of type U to convert its components
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
template<typename U>
|
||||
Frustum<T>& Frustum<T>::Set(const Frustum<U>& frustum)
|
||||
|
|
@ -489,6 +656,11 @@ namespace Nz
|
|||
return *this;
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Gives a string representation
|
||||
* \return A string representation of the object: "Frustum(Plane ...)"
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
String Frustum<T>::ToString() const
|
||||
{
|
||||
|
|
@ -503,6 +675,14 @@ namespace Nz
|
|||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
* \brief Output operator
|
||||
* \return The stream
|
||||
*
|
||||
* \param out The stream
|
||||
* \param frustum The frustum to output
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
std::ostream& operator<<(std::ostream& out, const Nz::Frustum<T>& frustum)
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue