#include <CUOrthographicCamera.h>

Inheritance diagram for cugl::OrthographicCamera:

Public Member Functions
	OrthographicCamera ()

	~OrthographicCamera ()

void	dispose () override

bool	init (const Size size, bool yDown=false)

bool	init (float width, float height, bool yDown=false)

bool	initOffset (const Rect rect, bool yDown=false)

bool	initOffset (const Vec2 origin, const Size size, bool yDown=false)

bool	initOffset (float x, float y, float width, float height, bool yDown=false)

void	set (const Size size, bool yDown=false)

void	set (float width, float height, bool yDown=false)

void	set (const Rect rect, bool yDown=false)

void	set (const Vec2 origin, const Size size, bool yDown=false)

void	set (float x, float y, float width, float height, bool yDown=false)

void	update () override

float	getZoom () const

void	setZoom (float zoom)

Public Member Functions inherited from cugl::Camera
	Camera ()

	~Camera ()

const Vec3	getPosition () const

const Vec3	getDirection () const

const Vec3	getUp () const

float	getNear () const

void	setNear (float value)

float	getFar () const

void	setFar (float value)

const Rect	getViewport () const

const Mat4 &	getProjection () const

const Mat4 &	getView () const

const Mat4 &	getCombined () const

const Mat4 &	getInverseProjectView () const

void	lookAt (const Vec3 target)

void	lookAt (float x, float y, float z)

void	normalizeUp ()

void	rotate (const Quaternion &quat)

void	rotate (const Vec3 axis, float angle)

void	rotateX (float angle)

void	rotateY (float angle)

void	rotateZ (float angle)

void	rotate (float angle)

void	rotate (const Mat4 &transform)

void	rotateAround (const Vec3 point, const Vec3 axis, float angle)

void	translate (const Vec3 vec)

void	translate (const Vec2 vec)

void	translate (float tx, float ty, float tz)

void	translate (float tx, float ty)

void	transform (const Mat4 &transform)

Vec3	unproject (const Vec3 windowCoords) const

Vec3	unproject (const Vec3 windowCoords, const Rect viewport) const

Vec3	screenToWorldCoords (const Vec2 screenCoords) const

Vec3	project (const Vec3 worldCoords) const

Vec3	project (const Vec3 worldCoords, const Rect viewport) const

Vec2	worldToScreenCoords (const Vec3 worldCoords) const

Ray	getPickRay (const Vec3 windowCoords) const

Ray	getPickRay (const Vec3 windowCoords, const Rect viewport) const

Ray	getPickRayFromScreen (const Vec2 screenCoords) const

Vec2	windowToScreenCoords (const Vec3 windowCoords) const

Vec2	windowToScreenCoords (const Vec3 windowCoords, const Rect viewport) const

Vec3	screenToWindowCoords (const Vec2 screenCoords) const

Vec3	screenToWindowCoords (const Vec2 screenCoords, const Rect viewport) const

Static Public Member Functions
static std::shared_ptr< OrthographicCamera >	alloc (const Size size, bool yDown=false)

static std::shared_ptr< OrthographicCamera >	alloc (float width, float height, bool yDown=false)

static std::shared_ptr< OrthographicCamera >	allocOffset (const Rect rect, bool yDown=false)

static std::shared_ptr< OrthographicCamera >	allocOffset (const Vec2 origin, const Size size, bool yDown=false)

static std::shared_ptr< OrthographicCamera >	allocOffset (float x, float y, float width, float height, bool yDown=false)

Protected Attributes
float	_zoom

bool	_initialized

Protected Attributes inherited from cugl::Camera
Vec3	_position

Vec3	_direction

Vec3	_upwards

Mat4	_projection

Mat4	_modelview

Mat4	_combined

Mat4	_inverse

float	_near

float	_far

Rect	_viewport

Detailed Description

This is a class for a camera with orthographic projection.

This camera is used by the Scene class.

Constructor & Destructor Documentation

◆ OrthographicCamera()

cugl::OrthographicCamera::OrthographicCamera ( )

inline

Creates a degenerate camera.

All of the matrices are the identity and the viewport is empty.

◆ ~OrthographicCamera()

cugl::OrthographicCamera::~OrthographicCamera ( )

inline

Deletes this camera, disposing all resources.

Member Function Documentation

◆ alloc() [1/2]

static std::shared_ptr<OrthographicCamera> cugl::OrthographicCamera::alloc	(	const Size	size,
		bool	yDown = `false`
	)

inlinestatic

Returns a newly allocated OrthographicCamera for the given viewport.

The viewport origin is assumed to be (0,0).

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

size	The viewport size
yDown	Whether to put the origin in the top left corner

Returns: a newly allocated OrthographicCamera for the given viewport.

◆ alloc() [2/2]

static std::shared_ptr<OrthographicCamera> cugl::OrthographicCamera::alloc	(	float	width,
		float	height,
		bool	yDown = `false`
	)

inlinestatic

Returns a newly allocated OrthographicCamera for the given viewport.

The viewport origin is assumed to be (0,0).

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

width	The viewport width
height	The viewport height
yDown	Whether to put the origin in the top left corner

Returns: a newly allocated OrthographicCamera for the given viewport.

◆ allocOffset() [1/3]

static std::shared_ptr<OrthographicCamera> cugl::OrthographicCamera::allocOffset	(	const Rect	rect,
		bool	yDown = `false`
	)

inlinestatic

Returns a newly allocated OrthographicCamera for the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

rect	The viewport bounding box
yDown	Whether to put the origin in the top left corner

Returns: a newly allocated OrthographicCamera for the given viewport.

◆ allocOffset() [2/3]

static std::shared_ptr<OrthographicCamera> cugl::OrthographicCamera::allocOffset	(	const Vec2	origin,
		const Size	size,
		bool	yDown = `false`
	)

inlinestatic

Returns a newly allocated OrthographicCamera for the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

origin	The viewport offset
size	The viewport size
yDown	Whether to put the origin in the top left corner

Returns: a newly allocated OrthographicCamera for the given viewport.

◆ allocOffset() [3/3]

static std::shared_ptr<OrthographicCamera> cugl::OrthographicCamera::allocOffset	(	float	x,
		float	y,
		float	width,
		float	height,
		bool	yDown = `false`
	)

inlinestatic

Returns a newly allocated OrthographicCamera for the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

x	The viewport x offset
y	The viewport y offset
width	The viewport width
height	The viewport height
yDown	Whether to put the origin in the top left corner

Returns: a newly allocated OrthographicCamera for the given viewport.

◆ dispose()

void cugl::OrthographicCamera::dispose ( )

overridevirtual

Returns this camera to the denegerate one, with all matrices the identity.

Reimplemented from cugl::Camera.

◆ getZoom()

float cugl::OrthographicCamera::getZoom ( ) const

inline

Returns the magnification zoom of this camera.

Large values make the images larger. So, 2x magnification makes images twices as large and effectively halves the viewport.

Returns: the magnification zoom of this camera.

◆ init() [1/2]

bool cugl::OrthographicCamera::init	(	const Size	size,
		bool	yDown = `false`
	)

inline

Initializes an OrthographicCamera for the given viewport.

The viewport origin is assumed to be (0,0).

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

size	The viewport size
yDown	Whether to put the origin in the top left corner

Returns: true if initialization was successful.

◆ init() [2/2]

bool cugl::OrthographicCamera::init	(	float	width,
		float	height,
		bool	yDown = `false`
	)

inline

Initializes an OrthographicCamera for the given viewport.

The viewport origin is assumed to be (0,0).

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

width	The viewport width
height	The viewport height
yDown	Whether to put the origin in the top left corner

Returns: true if initialization was successful.

◆ initOffset() [1/3]

bool cugl::OrthographicCamera::initOffset	(	const Rect	rect,
		bool	yDown = `false`
	)

inline

Initializes an OrthographicCamera for the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

rect	The viewport bounding box
yDown	Whether to put the origin in the top left corner

Returns: true if initialization was successful.

◆ initOffset() [2/3]

bool cugl::OrthographicCamera::initOffset	(	const Vec2	origin,
		const Size	size,
		bool	yDown = `false`
	)

inline

Initializes an OrthographicCamera for the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

origin	The viewport offset
size	The viewport size
yDown	Whether to put the origin in the top left corner

Returns: true if initialization was successful.

◆ initOffset() [3/3]

bool cugl::OrthographicCamera::initOffset	(	float	x,
		float	y,
		float	width,
		float	height,
		bool	yDown = `false`
	)

Initializes an OrthographicCamera for the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

x	The viewport x offset
y	The viewport y offset
width	The viewport width
height	The viewport height
yDown	Whether to put the origin in the top left corner

Returns: true if initialization was successful.

◆ set() [1/5]

void cugl::OrthographicCamera::set	(	const Rect	rect,
		bool	yDown = `false`
	)

inline

Sets this OrthographicCamera to have the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

rect	The viewport bounding box
yDown	Whether to put the origin in the top left corner

◆ set() [2/5]

void cugl::OrthographicCamera::set	(	const Size	size,
		bool	yDown = `false`
	)

inline

Sets this OrthographicCamera to have the given viewport.

The viewport origin is assumed to be (0,0).

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

size	The viewport size
yDown	Whether to put the origin in the top left corner

◆ set() [3/5]

void cugl::OrthographicCamera::set	(	const Vec2	origin,
		const Size	size,
		bool	yDown = `false`
	)

inline

Sets this OrthographicCamera to have the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

origin	The viewport offset
size	The viewport size
yDown	Whether to put the origin in the top left corner

◆ set() [4/5]

void cugl::OrthographicCamera::set	(	float	width,
		float	height,
		bool	yDown = `false`
	)

inline

Sets this OrthographicCamera to have the given viewport.

The viewport origin is assumed to be (0,0).

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

width	The viewport width
height	The viewport height
yDown	Whether to put the origin in the top left corner

◆ set() [5/5]

void cugl::OrthographicCamera::set	(	float	x,
		float	y,
		float	width,
		float	height,
		bool	yDown = `false`
	)

Sets this OrthographicCamera to have the given viewport.

Offseting the viewport origin has no affect on the position attribute. It only affects the coordinate conversion methods Camera#project() and Camera#unproject(). It is supposed to represent the offset of the viewport in a larger canvas.

If yDown is true, the origin will be at the top left corner (similar to screen coordinates). Otherwise, it will place the origin at the traditional OpenGL origin (bottom left corner).

Parameters

x	The viewport x offset
y	The viewport y offset
width	The viewport width
height	The viewport height
yDown	Whether to put the origin in the top left corner

◆ setZoom()

void cugl::OrthographicCamera::setZoom ( float zoom )

Sets the magnification zoom of this camera.

Large values make the images larger. So, 2x magnification makes images twices as large and effectively halves the viewport.

Changing this value will have no effect on the underlying matrices until you call the update() method.

Parameters

zoom	The magnification zoom

◆ update()

void cugl::OrthographicCamera::update ( )

overridevirtual

Recalculates the projection and view matrix of this camera.

Use this after you've manipulated any of the attributes of the camera.

Implements cugl::Camera.

Member Data Documentation

◆ _initialized

bool cugl::OrthographicCamera::_initialized

protected

Whether or not the camera has been initialized

◆ _zoom

float cugl::OrthographicCamera::_zoom

protected

The magnification zoom of the camera

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

include/cugl/render/CUOrthographicCamera.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OrthographicCamera()

◆ ~OrthographicCamera()

Member Function Documentation

◆ alloc() [1/2]

◆ alloc() [2/2]

◆ allocOffset() [1/3]

◆ allocOffset() [2/3]

◆ allocOffset() [3/3]

◆ dispose()

◆ getZoom()

◆ init() [1/2]

◆ init() [2/2]

◆ initOffset() [1/3]

◆ initOffset() [2/3]

◆ initOffset() [3/3]

◆ set() [1/5]

◆ set() [2/5]

◆ set() [3/5]

◆ set() [4/5]

◆ set() [5/5]

◆ setZoom()

◆ update()

Member Data Documentation

◆ _initialized

◆ _zoom