#include <Camera.hpp>

Inheritance diagram for jop::Camera:

Classes
union	ProjectionData

Public Types
enum	Projection { Projection::Orthographic, Projection::Perspective }

typedef std::pair< float, float >	ClippingPlanes

typedef std::pair< glm::vec2, glm::vec2 >	ViewPort

Public Member Functions
	Camera (Object &object, Renderer &renderer, const Projection mode)
	Constructor. More...

	~Camera () override
	Destructor. More...

const glm::mat4 &	getProjectionMatrix () const
	Get the projection matrix. More...

const glm::mat4 &	getViewMatrix () const
	Get the view matrix. More...

Camera &	setRenderMask (const uint32 mask)
	Set the render mask. More...

uint32	getRenderMask () const
	Get the render mask. More...

Camera &	setProjectionMode (const Projection mode)
	Set the projection mode. More...

Projection	getProjectionMode () const
	Get the projection mode. More...

Camera &	setClippingPlanes (const float clipNear, const float clipFar)
	Set the near and far clipping planes. More...

const ClippingPlanes &	getClippingPlanes () const
	Get the values of the clipping planes. More...

Camera &	setSize (const glm::vec2 &size)
	Brief set the size of the projection. More...

Camera &	setSize (const float x, const float y)
	Brief set the size of the projection. More...

glm::vec2	getSize () const
	Get the size of the projection. More...

Camera &	setAspectRatio (const float ratio)
	Set the aspect ratio. More...

float	getAspectRatio () const
	Get the aspect ratio. More...

Camera &	setFieldOfView (const float fovY)
	Set the vertical field of view. More...

float	getFieldOfView () const
	Get the field of view value. More...

Camera &	setViewport (const glm::vec2 &start, const glm::vec2 &end)
	Set the view port. More...

const ViewPort &	getViewport () const
	Get the view port. More...

void	applyViewport (const RenderTarget &mainTarget) const
	Apply this camera's view port. More...

RenderTexture &	getRenderTexture ()
	Get the internal render texture. More...

const RenderTexture &	getRenderTexture () const
	Get the internal render texture. More...

glm::vec3	getPickRay (const glm::vec2 &mouseCoords, const RenderTarget &target) const
	Get a ray for mouse picking purposes. More...

Public Member Functions inherited from jop::Component
virtual	~Component ()=0
	Virtual destructor. More...

Message::Result	sendMessage (const Message &message)
	Send a message to this component. More...

virtual void	update (const float deltaTime)
	Update function. More...

uint32	getID () const
	Get the identifier. More...

void	setID (const uint32 ID)
	Set the identifier. More...

WeakReference< Object >	getObject ()
	Get the object this component is bound to. More...

WeakReference< const Object >	getObject () const
	Get the object this component is bound to. More...

bool	isActive () const
	Check if this component is active. More...

void	removeSelf ()
	Remove this component from its object. More...

Protected Member Functions
Message::Result	receiveMessage (const Message &message) override
	Receive a message. More...

Protected Member Functions inherited from jop::Component
	Component (Object &object, const uint32 ID)
	Constructor. More...

	Component (const Component &other, Object &newObj)
	Copy constructor. More...

Detailed Description

Definition at line 39 of file Camera.hpp.

Member Typedef Documentation

typedef std::pair<float, float> jop::Camera::ClippingPlanes

Definition at line 47 of file Camera.hpp.

typedef std::pair<glm::vec2, glm::vec2> jop::Camera::ViewPort

Definition at line 48 of file Camera.hpp.

Member Enumeration Documentation

enum jop::Camera::Projection

strong

Projection mode

Enumerator
Orthographic	Usually used in 2D rendering.
Perspective	Usually used in 3D rendering.

Definition at line 69 of file Camera.hpp.

Constructor & Destructor Documentation

jop::Camera::Camera	(	Object &	object,
		Renderer &	renderer,
		const Projection	mode
	)

Constructor.

Parameters

object	The object this camera will be bound to
renderer	Reference to the renderer
mode	The initial projection mode

jop::Camera::~Camera ( )

override

Destructor.

Member Function Documentation

void jop::Camera::applyViewport ( const RenderTarget & mainTarget ) const

Apply this camera's view port.

Parameters

mainTarget The main render target. This will be used to calculate the absolute coordinates

float jop::Camera::getAspectRatio ( ) const

Get the aspect ratio.

In orthographic mode the return value is undefined

Returns: The aspect ratio

const ClippingPlanes& jop::Camera::getClippingPlanes ( ) const

Get the values of the clipping planes.

The first value is the near clipping plane. The second value is the far clipping plane.

Returns: Reference to the internal pair of clipping planes

float jop::Camera::getFieldOfView ( ) const

Get the field of view value.

Returns: The field of view value

glm::vec3 jop::Camera::getPickRay	(	const glm::vec2 &	mouseCoords,
		const RenderTarget &	target
	)		const

Get a ray for mouse picking purposes.

The resulting ray is normalized

Parameters

mouseCoords	Mouse coordinates. Origin is assumed to be in the upper left corner
target	The render target (main usually). This is used to get the correct view port dimensions

Returns: Normalized ray pointing from camera to the pointed position

const glm::mat4& jop::Camera::getProjectionMatrix ( ) const

Get the projection matrix.

Returns: The projection matrix

Projection jop::Camera::getProjectionMode ( ) const

Get the projection mode.

Returns: The projection mode

uint32 jop::Camera::getRenderMask ( ) const

Get the render mask.

Returns: The render mask

RenderTexture& jop::Camera::getRenderTexture ( )

Get the internal render texture.

Returns: Reference to the render texture

const RenderTexture& jop::Camera::getRenderTexture ( ) const

Get the internal render texture.

Returns: Reference to the render texture

glm::vec2 jop::Camera::getSize ( ) const

Get the size of the projection.

In perspective mode the return value is undefined.

Returns: Size of the projection

const glm::mat4& jop::Camera::getViewMatrix ( ) const

Get the view matrix.

The matrix will be fetched straight from the object.

Returns: The view matrix

const ViewPort& jop::Camera::getViewport ( ) const

Get the view port.

first = start second = size

See also: setViewport

Returns: Reference to the view port

Message::Result jop::Camera::receiveMessage ( const Message & message )

overrideprotectedvirtual

Receive a message.

Override this to handle messages sent to this. Don't forget to call the base class' method as well to ensure that the message gets forwarded correctly.

Parameters

message The message

Returns: The message result

Reimplemented from jop::Component.

Camera& jop::Camera::setAspectRatio ( const float ratio )

Set the aspect ratio.

This call is only valid in perspective mode.

Parameters

ratio The new aspect ratio to be set

This method is exposed as command named setAspectRatio

Camera& jop::Camera::setClippingPlanes	(	const float	clipNear,
		const float	clipFar
	)

Set the near and far clipping planes.

In perspective projection the clipping planes need to be positive. Otherwise, the projection result is undefined.

Parameters

clipNear	The near clipping plane
clipFar	The far clipping plane

Returns: Reference to self

This method is exposed as command named setClippingPlanes

Camera& jop::Camera::setFieldOfView ( const float fovY )

Set the vertical field of view.

The minimum value is glm::radians(1) and maximum glm::radians(179). The value will be clamped inside this range.

Parameters

fovY	The new field of view value

Returns: Reference to self

This method is exposed as command named setFieldOfView

Camera& jop::Camera::setProjectionMode ( const Projection mode )

Set the projection mode.

You need to accompany this call with calls to set the camera properties, as they won't be set to defaults automatically. Failing to set the properties will cause the projection to malfunction.

Parameters

mode	The mode to be set

Returns: Reference to self

This method is exposed as command named setProjectionMode

Camera& jop::Camera::setRenderMask ( const uint32 mask )

Set the render mask.

Parameters

mask	The new mask to set

Camera& jop::Camera::setSize ( const glm::vec2 & size )

Brief set the size of the projection.

In perspective mode this call is equal to calling setAspectRatio(size.x / size.y)

Parameters

size	The new size of the projection

Returns: Reference to self

Camera& jop::Camera::setSize	(	const float	x,
		const float	y
	)

Brief set the size of the projection.

Parameters

x	The width
y	The height

Returns: Reference to self

This method is exposed as command named setSize

Camera& jop::Camera::setViewport	(	const glm::vec2 &	start,
		const glm::vec2 &	end
	)

Set the view port.

The values are in relative coordinates. For example, [0.5,0.5] and [1.0,1.0] will select the right half of the screen.

Parameters

start	The start coordinates
end	The end coordinates

Returns: Reference to self

This method is exposed as command named setViewport

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

Camera.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation