oe::scene::Camera Class Reference

The "eye of the scene". More...

#include <OxygenEngine/scene/camera.h>

Inheritance diagram for oe::scene::Camera:

Collaboration diagram for oe::scene::Camera:

Public Member Functions
template<CameraProjection ProjectionSettings>
	Camera (const ProjectionSettings &projection_settings)
	Constructor.
template<CameraProjection ProjectionSettings>
void	setProjectionSettings (const ProjectionSettings &projection_settings)
	Update the camera's projection matrix by recomputing it based on the provided settings.
void	lookAt (const glm::vec3 &target)
	Orient the camera to stare at a specified target.
bool	isInFrustum (const glm::vec3 &point) const
	Check if a point is visible from the camera point of view.
bool	isInFrustum (const glm::vec3 &center, const float &radius) const
	Check if a sphere is visible from the camera point of view.
bool	isInFrustum (const AABB &box) const
	Check if a AABB is visible from the camera point of view.
const glm::mat4 &	getView () const
	Get the view matrix of the camera.
const glm::mat4 &	getProjection () const
	Get the projection matrix of the camera.
const glm::mat4 &	getInverseView () const
const glm::mat4 &	getInverseProjection () const
const glm::mat4 &	getTransform () const noexcept
	Get the transformation matrix of the camera.
const glm::mat4 &	getInverseTransform () const noexcept
float	getPitch () const noexcept
float	getYaw () const noexcept
float	getRoll () const noexcept
void	setPitch (const float pitch)
void	setYaw (const float yaw)
void	setRoll (const float roll)
bool	isDirty () const
Public Member Functions inherited from oe::scene::Transform
	Transform (const glm::vec3 &translation=glm::vec3(0.f), const glm::quat &rotation=glm::quat(1.f, 0.f, 0.f, 0.f), const glm::vec3 &scale=glm::vec3(1.f), const glm::vec3 &skew=glm::vec3(0.f), const glm::vec4 &perspective=glm::vec4(glm::vec3(0.f), 1.f))
	Generate Transform from its translation, rotation, scale values.
	Transform (const glm::mat4 &model)
	Generate Transform from a model matrix.
const glm::vec3 &	getTranslation () const noexcept
	Get Translation component value of the transform.
const glm::vec3 &	getPosition () const noexcept
	Get Translation component value of the transform.
const glm::quat &	getRotation () const noexcept
	Get Rotation component value of the transform.
const glm::quat &	getOrientation () const noexcept
	Get orientation of the transform.
const glm::vec3 &	getScale () const noexcept
	Get Scaling component value of the transform.
const glm::vec3 &	getSkew () const noexcept
	Get Skew component value of the transform.
const glm::vec4 &	getPerspective () const noexcept
	get Perspective component value of the transform
void	setTranslation (const float x, const float y, const float z) noexcept
	Translate to the specified position, filled component wise.
void	setPosition (const float x, const float y, const float z) noexcept
	Translate to the specified position.
void	setPosition (const glm::vec3 &position) noexcept
	Translate to the specified position.
void	setRotation (const lit::Angle &x, const lit::Angle &y, const lit::Angle &z) noexcept
	Rotate the transform from Euler angles.
void	setRotation (const glm::quat &rotation) noexcept
	Rotate the transform using a quaternion.
void	setOrientation (const lit::Angle &x, const lit::Angle &y, const lit::Angle &z) noexcept
	Set orientation of transform using lit::Angle triad.
void	setOrientation (const glm::quat &rotation) noexcept
	Set orientation of the transform using a quaternion.
void	setScale (const float x, const float y, const float z) noexcept
	Set scaling.
void	relativeTranslate (const glm::vec3 &translation) noexcept
	Translate the transform from current position.
void	relativeTranslate (const float x, const float y, const float z) noexcept
	relative translate the transform from current position, component wise
void	loadFromModel (const glm::mat4 &model) noexcept
	Fill the transform from a model matrix.
void	relativeMove (const glm::vec3 &translation) noexcept
	Move the transform relative to current translation.
void	relativeRotate (const glm::quat &quaternion) noexcept
	Rotate the transform relative to current rotation.
void	relativeRotate (const float x, const float y, const float z) noexcept
	Rotate the transform from Euler angles (component wise)
void	relativeRotate (const lit::Angle &x, const lit::Angle &y, const lit::Angle &z) noexcept
	Relatively rotate the transform using a lit::Angle triad.
void	relativeScale (const glm::vec3 &scale) noexcept
	Multiply current scale by the new one.
void	setSkew (const glm::vec3 &skew) noexcept
	Set skew of the transform.
void	setPerspective (const glm::vec4 &perspective) noexcept
	Set perspective effect of the transform.
void	interpolateWith (const float ratio, const Transform &target) noexcept
	Interpolate this transform with another one.
void	fillFrom (const Transform &transform) noexcept
	Fill current values from another transform.
template<TranslationType T>
void	setTranslation (const T &translation) noexcept
	Translate to the specified position.
template<RotationType R>
void	setRotation (const R &rotation) noexcept
	Get rotation quaternion from a generic type.
template<ScaleType S>
void	setScale (const S &scale) noexcept
	Set scale vector from a generic type.
template<TranslationType T>
void	getTranslationAs (T &result) const noexcept
	Get translation vector and fill in generic type.
template<RotationType R>
void	getRotationAs (R &result) const noexcept
	Get rotation quaternion and fill in generic type.
template<ScaleType S>
void	getScaleAs (S &result) const noexcept
	Get scale vector and fill in generic type.
glm::mat4	getModelMatrix () const noexcept
	Generate a Model matrix from the transform.
bool	isDirty () const noexcept
	Check if something modified this transform.

Additional Inherited Members
Protected Member Functions inherited from oe::scene::Transform
void	forceDirty (const bool is_dirty) const noexcept
	Set custom dirty status.

Detailed Description

The "eye of the scene".

Standalone Camera with a custom projection

Here is how to use it (example for a perspective Camera)

oe::scene::Camera camera(oe::scene::PerspectiveProjection(90.f, 1.33f, 0.1f, 100.0f));

See also

oe::render::Shader::fillFromCamera to understand which properties are automatically sent to shaders

PerspectiveProjection, OrthographicProjection and FrustumProjection for available projections, you can also use your custom one satisfying the CameraProjection concept

Constructor & Destructor Documentation

Camera()

template<CameraProjection ProjectionSettings>

oe::scene::Camera::Camera ( const ProjectionSettings &  projection_settings )

inline

Constructor.

Parameters

projection_settings

Projection settings to use

Member Function Documentation

getProjection()

const glm::mat4 & oe::scene::Camera::getProjection

(

)

const

Get the projection matrix of the camera.

Returns

Mat4 matrix that can directly be sent to shaders

getTransform()

const glm::mat4 & oe::scene::Camera::getTransform ( ) const

noexcept

Get the transformation matrix of the camera.

Transformation matrix is computed by applying the view then the projection

Returns

Mat4 matrix that can directly be sent to shaders

getView()

const glm::mat4 & oe::scene::Camera::getView

(

)

const

Get the view matrix of the camera.

Returns

Mat4 matrix that can directly be sent to shaders

isInFrustum() [1/3]

bool oe::scene::Camera::isInFrustum

(

const AABB &

box

)

const

Check if a AABB is visible from the camera point of view.

Parameters

box	Bounding box

Returns

true if at least a part of the box is visible

isInFrustum() [2/3]

bool oe::scene::Camera::isInFrustum	(	const glm::vec3 &	center,
		const float &	radius
	)		const

Check if a sphere is visible from the camera point of view.

Parameters

center	Absolute coordinates of the center of the sphere
radius	Sphere radius

Returns

true if at least a part of the sphere is visible

isInFrustum() [3/3]

bool oe::scene::Camera::isInFrustum

(

const glm::vec3 &

point

)

const

Check if a point is visible from the camera point of view.

Parameters

point

Absolute coordinates of the point to check

Returns

true if the point is visible

lookAt()

void oe::scene::Camera::lookAt

(

const glm::vec3 &

target

)

Orient the camera to stare at a specified target.

Parameters

target

Absolute coordinates of the point to look

setProjectionSettings()

template<CameraProjection ProjectionSettings>

void oe::scene::Camera::setProjectionSettings ( const ProjectionSettings &  projection_settings )

inline

Update the camera's projection matrix by recomputing it based on the provided settings.

Parameters

projection_settings

Settings instance, can be anything as long it provides a glm::mat4 getProjectionMatrix() method

---

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

• OxygenEngine/scene/camera.h