castor3d::Frustum Class Reference

#include <Frustum.hpp>

Public Types
using	Planes = std::array< castor::PlaneEquation, size_t(FrustumPlane::eCount) >

Public Member Functions
C3D_API	Frustum (Viewport &viewport)
	Constructor. More...
C3D_API Planes	update (castor::Matrix4x4f const &projection, castor::Matrix4x4f const &view)
	Updates the frustum planes. More...
C3D_API Planes	update (castor::Point3f const &position, castor::Point3f const &right, castor::Point3f const &up, castor::Point3f const &front)
	Updates the frustum planes. More...
C3D_API Planes	update (castor::Point3f const &eye, castor::Point3f const &target, castor::Point3f const &up)
	Updates the frustum planes. More...
C3D_API bool	isVisible (castor::BoundingBox const &box, castor::Matrix4x4f const &transformations) const
	Checks if given BoundingBox is in the view frustum. More...
C3D_API bool	isVisible (castor::BoundingSphere const &sphere, castor::Matrix4x4f const &transformations, castor::Point3f const &scale) const
	Checks if given BoundingSphere is in the view frustum. More...
C3D_API bool	isVisible (castor::Point3f const &point) const
	Checks if given point is in the view frustum. More...
std::array< InterleavedVertex, 6u *4u > const &	getPoints () const

Member Typedef Documentation

Planes

using castor3d::Frustum::Planes = std::array< castor::PlaneEquation, size_t( FrustumPlane::eCount ) >

Constructor & Destructor Documentation

Frustum()

C3D_API castor3d::Frustum::Frustum ( Viewport &  viewport )

explicit

Constructor.

Parameters

[in]

viewport

The viewport.

Member Function Documentation

getPoints()

std::array< InterleavedVertex, 6u *4u > const & castor3d::Frustum::getPoints ( ) const

inline

isVisible() [1/3]

C3D_API bool castor3d::Frustum::isVisible	(	castor::BoundingBox const &	box,
		castor::Matrix4x4f const &	transformations
	)		const

Checks if given BoundingBox is in the view frustum.

Parameters

[in]	box	The BoundingBox.
[in]	transformations	The BoundingBox transformations matrix.

Returns

false if the BoundingBox is completely out of the view frustum.

Referenced by castor3d::Camera::isVisible().

Here is the caller graph for this function:

isVisible() [2/3]

C3D_API bool castor3d::Frustum::isVisible	(	castor::BoundingSphere const &	sphere,
		castor::Matrix4x4f const &	transformations,
		castor::Point3f const &	scale
	)		const

Checks if given BoundingSphere is in the view frustum.

Parameters

[in]	sphere	The BoundingSphere.
[in]	transformations	The BoundingSphere transformations matrix.
[in]	scale	The scale for the BoundingSphere.

Returns

false if the BoundingSphere is completely out of the view frustum.

isVisible() [3/3]

C3D_API bool castor3d::Frustum::isVisible

(

castor::Point3f const &

point

)

const

Checks if given point is in the view frustum.

Parameters

[in]

point

The point.

Returns

false if the point out of the view frustum.

update() [1/3]

C3D_API Planes castor3d::Frustum::update	(	castor::Matrix4x4f const &	projection,
		castor::Matrix4x4f const &	view
	)

Updates the frustum planes.

Parameters

[in]	projection	The projection matrix.
[in]	view	The view matrix.

update() [2/3]

C3D_API Planes castor3d::Frustum::update	(	castor::Point3f const &	eye,
		castor::Point3f const &	target,
		castor::Point3f const &	up
	)

Updates the frustum planes.

Parameters

[in]	eye	The view position.
[in]	target	The view target vector.
[in]	up	The direction of the up vector according to the orientation of the view.

update() [3/3]

C3D_API Planes castor3d::Frustum::update	(	castor::Point3f const &	position,
		castor::Point3f const &	right,
		castor::Point3f const &	up,
		castor::Point3f const &	front
	)

Updates the frustum planes.

Parameters

[in]	position	The view position.
[in]	right	The X vector.
[in]	up	The Y vector.
[in]	front	The Z vector.

---

The documentation for this class was generated from the following file:

• Render/Frustum.hpp