Controls projection matrices. More...

#include <ProjectionControl.h>

Inheritance diagram for Carna::base::ProjectionControl:

Public Member Functions
	ProjectionControl ()
	Instantiates.

virtual	~ProjectionControl ()
	Deletes.

void	setViewportWidth (unsigned int width)
	Sets the width of the viewport updateProjection should create projection matrices for.

void	setViewportHeight (unsigned int height)
	Sets the height of the viewport updateProjection should create projection matrices for.

unsigned int	viewportWidth () const
	Tells the width of the viewport updateProjection should create projection matrices for.

unsigned int	viewportHeight () const
	Tells the height of the viewport updateProjection should create projection matrices for.

void	setMinimumVisibleDistance (float minimumVisibleDistance)
	Sets near clipping plane distance that should be used by updateProjection.

void	setMaximumVisibleDistance (float maximumVisibleDistance)
	Sets far clipping plane distance that should be used by updateProjection.

float	minimumVisibleDistance () const
	Tells near clipping plane distance that is used by updateProjection.

float	maximumVisibleDistance () const
	Tells far clipping plane distance that is used by updateProjection.

virtual void	updateProjection (math::Matrix4f &projectionMatrix) const =0
	Creates projectionMatrix based on previously set parameters.

bool	isUpdateAvailable () const
	Tells `true` when probably a new projection matrix is available and `false` when updateProjection is likely to return the same result as the last time.

Static Public Attributes
static const float	DEFAULT_MINIMUM_VISIBLE_DISTANCE
	Holds default near clipping plane distance that should be used by updateProjection.

static const float	DEFAULT_MAXIMUM_VISIBLE_DISTANCE
	Holds default far clipping plane distance that should be used by updateProjection.

Protected Member Functions
void	invalidateProjection ()
	Denotes that an update is available.

void	setProjectionValidated () const
	Denotes that no update is available.

Detailed Description

Controls projection matrices.

Author: Leonid Kostrykin

Date: 22.2.15 - 16.3.15

Definition at line 41 of file ProjectionControl.h.

Member Function Documentation

◆ setMaximumVisibleDistance()

void Carna::base::ProjectionControl::setMaximumVisibleDistance ( float maximumVisibleDistance )

Sets far clipping plane distance that should be used by updateProjection.

Precondition: maximumVisibleDistance > 0

◆ setMinimumVisibleDistance()

void Carna::base::ProjectionControl::setMinimumVisibleDistance ( float minimumVisibleDistance )

Sets near clipping plane distance that should be used by updateProjection.

Precondition: minimumVisibleDistance >= 0

◆ setViewportHeight()

void Carna::base::ProjectionControl::setViewportHeight ( unsigned int height )

Sets the height of the viewport updateProjection should create projection matrices for.

Precondition: height > 0

◆ setViewportWidth()

void Carna::base::ProjectionControl::setViewportWidth ( unsigned int width )

Sets the width of the viewport updateProjection should create projection matrices for.

Precondition: width > 0

◆ updateProjection()

virtual void Carna::base::ProjectionControl::updateProjection ( math::Matrix4f & projectionMatrix ) const

pure virtual

Creates projectionMatrix based on previously set parameters.

Implemented in Carna::presets::OrthogonalControl, and Carna::presets::PerspectiveControl.

Member Data Documentation

◆ DEFAULT_MAXIMUM_VISIBLE_DISTANCE

const float Carna::base::ProjectionControl::DEFAULT_MAXIMUM_VISIBLE_DISTANCE

static

Holds default far clipping plane distance that should be used by updateProjection.

Definition at line 61 of file ProjectionControl.h.

◆ DEFAULT_MINIMUM_VISIBLE_DISTANCE

const float Carna::base::ProjectionControl::DEFAULT_MINIMUM_VISIBLE_DISTANCE

static

Holds default near clipping plane distance that should be used by updateProjection.

Definition at line 55 of file ProjectionControl.h.

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

include/Carna/base/ProjectionControl.h

Public Member Functions

Static Public Attributes

Protected Member Functions