Unigine::BoundFrustum Struct

Header:

#include <UnigineMathLibBounds.h>

This structure serves to construct the bounding frustum in single precision coordinates.

Notice

Instances of this structure are deleted automatically, when necessary.

In case of double precision coordinates, the bounding frustum should be constructed by using the WorldBoundFrustum structure. It includes the same functions as the BoundFrustum structure, but its functions deal with the double precision coordinates.

NoticeTo support both single and double precision builds, you can use the WorldBoundFrustum structure only. The engine will automatically substitute it with the BoundFrustum, if required.

Methods:

Name	Description View: Sort by:
BoundFrustum	Constructor.
isValid	Checks the bounding frustum status.
getCamera	Returns the position of the camera.
getPlanes	Returns the bounding frustum cliping planes array.
getPoints	Returns the vector of points of the current bounding frustum.
operator =	Assignment operator.
clear	Clears the bounding frustum.
set	Sets the bounding frustum by matrices.
setITransform	Sets the transformation matrix by an inverse transformation matrix.
compare	Compares the current bounding frustum with the given one.
operator ==	Bounding frustum equal comparison operator.
operator !=	Bounding frustum not equal comparison operator.
expand	Expands the current bounding frustum by the given radius.
inside	Checks if the point is inside the bounding frustum.
insideFast	Performs a fast check if the point is inside the bounding frustum.
insideValid	Checks if the given bounding sphere is inside the bounding frustum.
insideValidFast	Performs a fast check if the given bounding sphere is inside the current bounding frustum.
insideAll	Checks if the whole given bounding box is inside the current bounding frustum.
insideAllValid	Checks if the whole given bounding sphere is inside the current bounding frustum.
insideAllValidFast	Performs a fast check if the whole given bounding sphere is inside the current bounding frustum.
insidePlanes	Checks if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum.
insidePlanesValid	Checks if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum.
insidePlanesValidFast	Performs a fast check if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum.
insideShadowValid	Checks if the given bounding sphere is inside the shadow of the current bounding frustum.

BoundFrustum Class

Members

BoundFrustum ( ) #

Constructor. Creates an empty bounding frustum.

BoundFrustum ( const Math::mat4 & projection, const Math::mat4 & modelview ) #

Initialization by the projection and modelview matrices.

Arguments

const Math::mat4 & projection - Projection matrix.
const Math::mat4 & modelview - Modelview matrix.

BoundFrustum ( const BoundFrustum & bf ) #

Initialization by the bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

BoundFrustum ( const BoundFrustum & bf, const Math::mat4 & itransform ) #

Initialization by the bounding frustum and transformation matrix.

Arguments

const BoundFrustum & bf - The bounding frustum.
const Math::mat4 & itransform - The inverse transformation matrix.

BoundFrustum & operator= ( const BoundFrustum & bf ) #

Assignment operator.

Arguments

const BoundFrustum & bf - The bounding frustum.

Return value

Bounding frustum.

void clear ( ) #

Clears the bounding frustum.

void set ( const Math::mat4 & projection, const Math::mat4 & modelview ) #

Sets the bounding frustum by matrices.

Arguments

const Math::mat4 & projection - Projection matrix.
const Math::mat4 & modelview - Modelview matrix.

void set ( const BoundFrustum & bf ) #

Sets the bounding frustum by the bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

void set ( const BoundFrustum & bf, const Math::mat4 & itransform ) #

Sets the bounding frustum by the bounding frustum and transformation matrix.

Arguments

const BoundFrustum & bf - The bounding frustum.
const Math::mat4 & itransform - The inverse transformation matrix.

void setITransform ( const Math::mat4 & itransform ) #

Sets the transformation matrix by an inverse transformation matrix.

Arguments

const Math::mat4 & itransform - The inverse transformation matrix.

void setITransform ( const Math::dmat4 & itransform ) #

Sets the transformation matrix by an inverse transformation matrix.

Arguments

const Math::dmat4 & itransform - The inverse transformation matrix.

int compare ( const BoundFrustum & bf ) const#

Compares the current bounding frustum with the given one.

Arguments

const BoundFrustum & bf - Bounding frustum.

Return value

true if the current bounding frustum is equal to the given one; otherwise, false.

int operator== ( const BoundFrustum & bf ) const#

Bounding frustum equal comparison operator.

Arguments

const BoundFrustum & bf - The bounding frustum to compare with.

Return value

true if the current bounding frustum is equal to the given one; otherwise, false.

int operator!= ( const BoundFrustum & bf ) const#

Bounding frustum not equal comparison operator.

Arguments

const BoundFrustum & bf - The bounding frustum to compare with.

Return value

true if the current bounding frustum is not equal to the given one; otherwise, false.

void expand ( float radius ) #

Expands the current bounding frustum by the given radius.

Arguments

float radius - Radius.

bool inside ( const Math::vec3 & point ) const#

Checks if the point is inside the bounding frustum.

Arguments

const Math::vec3 & point - The coordinates of the point.

Return value

true if the point is inside the bounding frustum; otherwise, false.

bool inside ( const Math::vec3 & point, float radius ) const#

Checks if the sphere is inside the bounding frustum.

Arguments

const Math::vec3 & point - The coordinates of the center of the sphere.
float radius - The sphere radius.

Return value

true if the sphere is inside the bounding frustum; otherwise, false.

bool inside ( const Math::vec3 & min, const Math::vec3 & max ) const#

Checks if the box is inside the bounding frustum.

Arguments

const Math::vec3 & min - The box minimum coordinate.
const Math::vec3 & max - The box maximum coordinate.

Return value

true if the box is inside the bounding frustum; otherwise, false.

int inside ( const Math::vec3 * points, int num ) const#

Checks if a set of points is inside the bounding frustum.

Arguments

const Math::vec3 * points - Vector of points.
int num - Number of points.

Return value

true if the points are inside the bounding frustum; otherwise, false.

bool inside ( const BoundSphere & bs ) const#

Checks if the bounding sphere is inside the bounding frustum.

Arguments

const BoundSphere & bs - Bounding sphere.

Return value

true if the bounding sphere is inside the bounding frustum; otherwise, false.

bool inside ( const BoundBox & bb ) const#

Checks if the bounding box is inside the bounding frustum.

Arguments

const BoundBox & bb - Bounding box.

Return value

true if the bounding box is inside the bounding frustum; otherwise, false.

bool inside ( const BoundFrustum & bf ) const#

Checks if the specified bounding frustum is inside the current bounding frustum.

Arguments

const BoundFrustum & bf - Bounding frustum.

Return value

true if the specified bounding frustum is inside the bounding frustum; otherwise, false.

bool insideFast ( const Math::vec3 & point ) const#

Performs a fast check if the point is inside the bounding frustum.

Arguments

const Math::vec3 & point - Point.

Return value

true if the point is inside the bounding frustum; otherwise, false.

bool insideFast ( const Math::vec3 & point, float radius ) const#

Performs a fast check if the sphere is inside the bounding frustum.

Arguments

const Math::vec3 & point - Center point.
float radius - Radius.

Return value

true if the sphere is inside the bounding frustum; otherwise, false.

bool insideFast ( const Math::vec3 & min, const Math::vec3 & max ) const#

Performs a fast check if the box is inside the bounding frustum.

Arguments

const Math::vec3 & min - Minimum point.
const Math::vec3 & max - Maximum point.

Return value

true if the box is inside the bounding frustum; otherwise, false.

bool insideFast ( const Math::vec3 * points, int num ) const#

Performs a fast check if the set of points is inside the bounding frustum.

Arguments

const Math::vec3 * points - Vector of points.
int num - Number of points.

Return value

true if the point is inside the bounding frustum; otherwise, false.

bool insideValid ( const BoundSphere & bs ) const#

Checks if the given bounding sphere is inside the bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & bs - The bounding sphere.

Return value

true if the given bounding sphere is inside the bounding frustum; otherwise, false.

bool insideValid ( const BoundBox & bb ) const#

Checks if the given bounding box is inside the bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundBox & bb - The bounding box.

Return value

true if the given bounding box is inside the bounding frustum; otherwise, false.

bool insideValid ( const BoundFrustum & bf ) const#

Checks if the given bounding frustum is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

Return value

true if the given bounding frustum is inside the bounding frustum; otherwise, false.

bool insideValidFast ( const BoundSphere & bs ) const#

Performs a fast check if the given bounding sphere is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & bs - The bounding sphere.

Return value

true if the given bounding sphere is inside the bounding frustum; otherwise, false.

bool insideValidFast ( const BoundBox & bb ) const#

Performs a fast check if the given bounding box is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundBox & bb - The bounding box.

Return value

true if the given bounding box is inside the bounding frustum; otherwise, false.

bool insideValidFast ( const BoundFrustum & bf ) const#

Performs a fast check if the given bounding frustum is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

Return value

true if the given bounding frustum is inside the bounding frustum; otherwise, false.

bool insideAll ( const BoundBox & bb ) const#

Checks if the whole given bounding box is inside the current bounding frustum.

Arguments

const BoundBox & bb - Bounding box.

Return value

true if the whole bounding box is inside the bounding frustum; otherwise, false.

bool insideAll ( const BoundSphere & bs ) const#

Checks if the whole given bounding sphere is inside the current bounding frustum.

Arguments

const BoundSphere & bs - Bounding sphere.

Return value

true if the whole bounding sphere is inside the bounding frustum; otherwise, false.

bool insideAll ( const BoundFrustum & bf ) const#

Checks if the whole specified bounding frustum is inside the current bounding frustum.

Arguments

const BoundFrustum & bf - Bounding frustum.

Return value

true if the whole specified bounding frustum is inside the current bounding frustum; otherwise, false.

bool insideAllValid ( const BoundSphere & bs ) const#

Checks if the whole given bounding sphere is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & bs - The bounding sphere.

Return value

true if the given bounding sphere is inside the bounding frustum; otherwise, false.

bool insideAllValid ( const BoundBox & bb ) const#

Checks if the whole given bounding box is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundBox & bb - The bounding box.

Return value

true if the given bounding box is inside the bounding frustum; otherwise, false.

bool insideAllValid ( const BoundFrustum & bf ) const#

Checks if the whole given bounding frustum is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

Return value

true if the given bounding frustum is inside the bounding frustum; otherwise, false.

bool insideAllValidFast ( const BoundSphere & bs ) const#

Performs a fast check if the whole given bounding sphere is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & bs - The bounding sphere.

Return value

true if the given bounding sphere is inside the bounding frustum; otherwise, false.

bool insideAllValidFast ( const BoundBox & bb ) const#

Performs a fast check if the whole given bounding box is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundBox & bb - The bounding box.

Return value

true if the given bounding box is inside the bounding frustum; otherwise, false.

bool insideAllValidFast ( const BoundFrustum & bf ) const#

Performs a fast check if the whole given bounding frustum is inside the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

Return value

true if the given bounding frustum is inside the bounding frustum; otherwise, false.

bool insidePlanes ( const BoundSphere & bs ) const#

Checks if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum.

Arguments

const BoundSphere & bs - Bounding sphere.

Return value

true if the given bounding sphere is inside the volume; otherwise, false.

bool insidePlanes ( const BoundBox & bb ) const#

Checks if the given bounding box is inside the volume defined by the planes of the current bounding frustum.

Arguments

const BoundBox & bb - Bounding box.

Return value

true if the given bounding box is inside the volume; otherwise, false.

bool insidePlanes ( const BoundFrustum & bf ) const#

Checks if the given bounding frustum is inside the volume defined by the planes of the current bounding frustum.

Arguments

const BoundFrustum & bf - Bounding frustum.

Return value

true if the given bounding frustum is inside the volume; otherwise, false.

bool insidePlanesValid ( const BoundSphere & bs ) const#

Checks if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & bs - The bounding sphere.

Return value

true if the given bounding sphere is inside the volume; otherwise, false.

bool insidePlanesValid ( const BoundBox & bb ) const#

Checks if the given bounding box is inside the volume defined by the planes of the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundBox & bb - The bounding box.

Return value

true if the given bounding box is inside the volume; otherwise, false.

bool insidePlanesValid ( const BoundFrustum & bf ) const#

Checks if the given bounding frustum is inside the volume defined by the planes of the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

Return value

true if the given bounding frustum is inside the volume; otherwise, false.

bool insidePlanesValidFast ( const BoundSphere & bs ) const#

Performs a fast check if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & bs - The bounding sphere.

Return value

true if the given bounding sphere is inside the volume; otherwise, false.

bool insidePlanesValidFast ( const BoundBox & bb ) const#

Performs a fast check if the given bounding box is inside the volume defined by the planes of the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundBox & bb - The bounding box.

Return value

true if the given bounding box is inside the volume; otherwise, false.

bool insidePlanesValidFast ( const BoundFrustum & bf ) const#

Performs a fast check if the given bounding frustum is inside the volume defined by the planes of the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundFrustum & bf - The bounding frustum.

Return value

true if the given bounding frustum is inside the volume; otherwise, false.

bool insideShadowValid ( const BoundSphere & object, const Math::vec3 & direction ) const#

Checks if the given bounding sphere is inside the shadow of the current bounding frustum.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & object - Bounding sphere.
const Math::vec3 & direction - The direction vector.

Return value

true if the given bounding sphere is inside the shadow; otherwise, false.

bool insideShadowValid ( const BoundSphere & object, const BoundSphere & light, const Math::vec3 & offset ) const#

Checks if the given bounding sphere is inside the shadow of the current bounding frustum and outside the bounding sphere of a light source.

Notice

The method doesn't check the status of the current bounding frustum.

Arguments

const BoundSphere & object - Bounding sphere.
const BoundSphere & light - The bounding sphere of the light source.
const Math::vec3 & offset - The offset vector.

Return value

true if the given bounding sphere is inside the shadow and outside the given light source bounding sphere; otherwise, false.

bool isValid ( ) const#

Checks the bounding frustum status.

Return value

true if the bounding frustum is valid, otherwise false.

Math::vec3 getCamera ( ) #

Returns the position of the camera.

Return value

Camera position.

const Math::vec4 * getPlanes ( ) const#

Returns the bounding frustum cliping planes array.

Return value

The bounding frustum cliping planes array.

const Math::vec3 * getPoints ( ) #

Returns the vector of points of the current bounding frustum.

Return value

Vector of points.

Last update: 2021-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)