Unigine::WorldBoundFrustum Struct

#pragma once
#include <UnigineComponentSystem.h>
class FrustumChecker :
	public Unigine::ComponentBase
{
public:
	COMPONENT_DEFINE(FrustumChecker, Unigine::ComponentBase);
	COMPONENT_UPDATE(update);

private:
	void update();
};

#include "FrustumChecker.h"
#include "UnigineGame.h"
#include "UnigineMathLibBounds.h"
#include "UnigineVisualizer.h"
REGISTER_COMPONENT(FrustumChecker);

using namespace Unigine;

void FrustumChecker::update()
{	
	// getting the current camera
	Unigine::CameraPtr camera = Game::getPlayer()->getCamera();

	// getting the main window of the application
	Unigine::EngineWindowPtr main_window = WindowManager::getMainWindow();
	if (!main_window) {
		Engine::get()->quit();
		return;
	}
	
	// calculating the current aspect ratio to obtain proper aspect-corrected projection matrix
	// default projection matrix does not take aspect ratio into account
	Unigine::Math::ivec2 main_size = WindowManager::getMainWindow()->getSize();
	float aspect = float(main_size.y) / main_size.x;
	Unigine::Math::mat4 proj = camera->getAspectCorrectedProjection(aspect);
	
	// getting model-view matrix of the camera
	Unigine::Math::Mat4 model_view = camera->getModelview();
	Unigine::Math::WorldBoundFrustum bfrustum(proj, model_view);

	// checking if the node's bound gets inside the viewing frustum of the camera
	if (bfrustum.inside(node->getWorldBoundBox())) {
		Log::message("Node's bound is visible inside the frustum.");
		
		// checking whether the bound is completely or partially inside the frustum
		Log::message(bfrustum.insideAll(node->getWorldBoundBox()) ? " COMPLETELY!\n": " PARTIALLY!\n");

		// checking whether a certain point of the object (WorldPosition here) is inside the frustum
		Log::message(bfrustum.inside(node->getWorldPosition()) ? "(The point is INSIDE)\n" : "(The point is OUTSIDE)\n");
	}
	else
		Log::message("Node's bound is outside the frustum.\n");
	
	// displaying node's BoundBox, the Bound Frustum, and a point using the Visualizer
	Visualizer::renderFrustum(proj, Math::inverse(model_view), Math::vec4(1.0f, 0.0f, 0.0f, 1.0f));
	Visualizer::renderBoundBox(node->getBoundBox(), node->getTransform(), Math::vec4(0.0f, 1.0f, 0.0f, 1.0f));
	Visualizer::renderSphere(0.01f, Math::translate(node->getWorldPosition()), Math::vec4(1.0f, 0.0f, 0.0f, 1.0f));
}

WorldBoundFrustum Class

Members

---

static WorldBoundFrustumPtr create ( ) #

Default constructor.

WorldBoundFrustum ( const Math::mat4 & projection, const Math::Mat4 & modelview ) #

Constructor. Initializes the bounding frustum by given matrices.

Arguments

• const Math::mat4 & projection - A projection matrix.
• const Math::Mat4 & modelview - A modelview matrix.

WorldBoundFrustum ( const WorldBoundFrustum & bf ) #

Constructor. Initializes by given bounding frustum.

Arguments

• const WorldBoundFrustum & bf - The bounding frustum.

WorldBoundFrustum ( const BoundFrustum & bf ) #

Constructor. Initializes by given bounding frustum.

Arguments

• const BoundFrustum & bf - The bounding frustum.

WorldBoundFrustum ( const WorldBoundFrustum & bf, const Math::Mat4 & itransform ) #

Constructor. Initializes by given bounding frustum and transformation matrix.

Arguments

• const WorldBoundFrustum & bf - The bounding frustum.
• const Math::Mat4 & itransform - The inverse transformation matrix.

WorldBoundFrustum ( const BoundFrustum & bf, const Math::Mat4 & itransform ) #

Constructor. Initializes by given bounding frustum and transformation matrix.

Arguments

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

WorldBoundFrustum & operator= ( const WorldBoundFrustum & bf ) #

Assignment operator.

Arguments

• const WorldBoundFrustum & 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 given matrices.

Arguments

• const Math::mat4 & projection - A projection matrix.
• const Math::Mat4 & modelview - A modelview matrix.

void set ( const WorldBoundFrustum & bf ) #

Sets the bounding frustum by given bounding frustum.

Arguments

• const WorldBoundFrustum & bf - The bounding frustum.

void set ( const WorldBoundFrustum & bf, const Math::Mat4 & itransform ) #

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

Arguments

• const WorldBoundFrustum & bf - The bounding frustum.
• const Math::Mat4 & itransform - The inverse transformation matrix.

void set ( const BoundFrustum & bf ) #

Sets the bounding frustum by given bounding frustum.

Arguments

• const BoundFrustum & bf - The bounding frustum.

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

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

Arguments

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

bool isValid ( ) const#

Checks the bounding frustum status.

Return value

true if the bounding frustum is valid, otherwise false.

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

Sets the current transformation matrix by an inverse transformation matrix.

Arguments

• const Math::dmat4 & itransform - Inverse transformation matrix.

void setTransform ( const Math:: dmat4& transform ) #

Sets the current transformation matrix by the specified source transformation matrix.

Arguments

• const Math:: dmat4& transform - Source transformation matrix.

int compare ( const WorldBoundFrustum & bf ) const#

Compares the current bounding frustum with the given one.

Arguments

• const WorldBoundFrustum & bf - Bounding frustum.

Return value

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

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

Bounding frustum equal comparison operator.

Arguments

• const WorldBoundFrustum & 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 WorldBoundFrustum & bf ) const#

Bounding frustum not equal comparison operator.

Arguments

• const WorldBoundFrustum & bf - The bounding frustum to compare with.

Return value

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

int 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

1 if the point is inside the bounding frustum; otherwise, 0.

int inside ( const Math::Vec3 & point, Math::Scalar radius ) const#

Checks if the sphere is inside the bounding frustum.

Arguments

• const Math::Vec3 & point - The coordinates of the center of the sphere.
• Math::Scalar radius - The sphere radius.

Return value

1 if the sphere is inside the bounding frustum; otherwise, 0.

int 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

1 if the box is inside the bounding frustum; otherwise, 0.

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

1 if the points are inside the bounding frustum; otherwise, 0.

int inside ( const WorldBoundSphere & bs ) const#

Checks if the bounding sphere is inside the bounding frustum.

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the bounding sphere is inside the bounding frustum; otherwise, 0.

int inside ( const WorldBoundBox & bb ) const#

Checks if the bounding box is inside the bounding frustum.

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

1 if the bounding box is inside the bounding frustum; otherwise, 0.

int inside ( const WorldBoundFrustum & bb ) const#

Checks if the bounding frustum specified in the argument is inside the bounding frustum.

Arguments

• const WorldBoundFrustum & bb - The bounding frustum.

Return value

1 if the specified bounding frustum is inside the bounding frustum; otherwise, 0.

int 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

1 if the point is inside the bounding frustum; otherwise, 0.

int insideFast ( const Math::Vec3 & point, Math::Scalar radius ) const#

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

Arguments

• const Math::Vec3 & point - Center point.
• Math::Scalar radius - Radius.

Return value

1 if the sphere is inside the bounding frustum; otherwise, 0.

int 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

1 if the box is inside the bounding frustum; otherwise, 0.

int insideFast ( const Math::Vec3 * points, int num_points ) 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_points - Number of points.

Return value

1 if the point is inside the bounding frustum; otherwise, 0.

int insideValid ( const WorldBoundSphere & bs ) const#

Checks if the given bounding sphere is inside the bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the given bounding sphere is inside the bounding frustum; otherwise, 0.

int insideValid ( const WorldBoundBox & bb ) const#

Checks if the given bounding box is inside the bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

1 if the given bounding box is inside the bounding frustum; otherwise, 0.

int insideValid ( const WorldBoundFrustum & bb ) const#

Checks if the given bounding frustum is inside the bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundFrustum & bb - The bounding frustum.

Return value

1 if the given bounding frustum is inside the bounding frustum; otherwise, 0.

int insideValidFast ( const WorldBoundSphere & bs ) const#

Performs a fast check if the given bounding sphere is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the given bounding sphere is inside the bounding frustum; otherwise, 0.

int insideValidFast ( const WorldBoundBox & bb ) const#

Performs a fast check if the given bounding box is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

1 if the given bounding box is inside the bounding frustum; otherwise, 0.

int insideValidFast ( const WorldBoundFrustum & bb ) const#

Performs a fast check if the given bounding frustum is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundFrustum & bb - The bounding frustum.

Return value

1 if the given bounding frustum is inside the bounding frustum; otherwise, 0.

int insideAll ( const WorldBoundBox & bb ) const#

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

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

1 if the whole box is inside the bounding frustum; otherwise, 0.

int insideAll ( const WorldBoundSphere & bs ) const#

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

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the whole sphere is inside the bounding frustum; otherwise, 0.

int insideAll ( const WorldBoundFrustum & bs ) const#

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

Arguments

• const WorldBoundFrustum & bs - The bounding frustum.

Return value

1 if the given frustum is inside the bounding frustum; otherwise, 0.

int insideAllValid ( const WorldBoundSphere & bs ) const#

Checks if the whole given bounding sphere is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the given bounding sphere is inside the bounding frustum; otherwise, 0.

int insideAllValid ( const WorldBoundBox & bb ) const#

Checks if the whole given bounding box is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

1 if the given bounding box is inside the bounding frustum; otherwise, 0.

int insideAllValid ( const WorldBoundFrustum & bb ) const#

Checks if the whole given bounding frustum is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundFrustum & bb - The bounding frustum.

Return value

1 if the given bounding frustum is inside the bounding frustum; otherwise, 0.

int insideAllValidFast ( const WorldBoundSphere & bs ) const#

Performs a fast check if the whole given bounding sphere is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

1 if the given bounding sphere is inside the bounding frustum; otherwise, 0.

int insideAllValidFast ( const WorldBoundBox & bb ) const#

Performs a fast check if the whole given bounding box is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

1 if the given bounding box is inside the bounding frustum; otherwise, 0.

int insideAllValidFast ( const WorldBoundFrustum & bb ) const#

Performs a fast check if the whole given bounding frustum is inside the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundFrustum & bb - The bounding frustum.

Return value

1 if the given bounding frustum is inside the bounding frustum; otherwise, 0.

bool insidePlanes ( const WorldBoundSphere & bs ) const#

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

Arguments

• const WorldBoundSphere & bs - Bounding sphere.

Return value

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

bool insidePlanes ( const WorldBoundBox & bb ) const#

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

Arguments

• const WorldBoundBox & bb - Bounding box.

Return value

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

bool insidePlanes ( const WorldBoundFrustum & bf ) const#

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

Arguments

• const WorldBoundFrustum & bf - Bounding frustum.

Return value

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

bool insidePlanesValid ( const WorldBoundSphere & bs ) const#

Checks if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

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

bool insidePlanesValid ( const WorldBoundBox & bb ) const#

Checks if the given bounding box is inside the volume defined by the planes of the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

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

bool insidePlanesValid ( const WorldBoundFrustum & bf ) const#

Checks if the given bounding frustum is inside the volume defined by the planes of the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundFrustum & bf - The bounding frustum.

Return value

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

bool insidePlanesValidFast ( const WorldBoundSphere & bs ) const#

Performs a fast check if the given bounding sphere is inside the volume defined by the planes of the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundSphere & bs - The bounding sphere.

Return value

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

bool insidePlanesValidFast ( const WorldBoundBox & bb ) const#

Performs a fast check if the given bounding box is inside the volume defined by the planes of the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundBox & bb - The bounding box.

Return value

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

bool insidePlanesValidFast ( const WorldBoundFrustum & bf ) const#

Performs a fast check if the given bounding frustum is inside the volume defined by the planes of the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundFrustum & bf - The bounding frustum.

Return value

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

int insideShadowValid ( const WorldBoundSphere & object, const Math::Vec3 & direction ) const#

Checks if the given bounding sphere is inside the shadow of the current bounding frustum (assuming that the current bound coordinates are valid).

Arguments

• const WorldBoundSphere & object - Bounding sphere.
• const Math::Vec3 & direction - The direction vector.

Return value

1 if the given bounding sphere is inside the shadow; otherwise, 0.

bool insideShadowValid ( const WorldBoundSphere & object, const WorldBoundSphere & 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.

Arguments

• const WorldBoundSphere & object - Bounding sphere.
• const WorldBoundSphere & 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.