A small utility class that manages the viewport coordinates, together with the virtual "camera" position and zoom. More...

#include <view.h>

Public Member Functions
	View (int width=800, int height=600, glm::vec3 position=glm::vec3(0.0f, 0.0f, 1.0f), glm::vec3 up=glm::vec3(0.0f, 1.0f, 0.0f))

void	update (float dt, int w, int h)
	Move the current position and zoom a bit closer to the target position and zoom. More...

glm::mat4	get_view_matrix () const
	Compute view matrix for drawing into the "view" space. More...

glm::mat4	get_proj_matrix () const
	Compute projection matrix for orthographic projection. More...

glm::vec2	screen_mouse_coords (glm::vec2 mouse) const
	Convert mouse coordinates ([0,0] in the upper left corner), to screen coordinates ([0,0] in the middle of the screen). More...

glm::vec2	model_mouse_coords (glm::vec2 mouse) const
	Convert mouse coordinates ([0,0] in the upper left corner), to model coordinates ([0,0] in the middle of the screen). More...

glm::vec2	screen_coords (glm::vec2 point) const
	Converts point to screen coordinates([0,0] in the middle of the screen). More...

void	move_y (int dir)
	Move view along Y-axis. More...

void	move_x (int dir)
	Move view along X-axis. More...

void	zoom (float yoffset, glm::vec2 mouse)
	Adjust zoom accordingly. More...

void	look_at (glm::vec2 tgt)
	Cause the camera to look at the specified point. More...

Public Attributes
const float	movement_speed = 0.2f

const float	smooth_speed = 0.005f

const float	zoom_depth = 0.009f

glm::vec3	target_pos

glm::vec3	current_pos

glm::vec3	front

glm::vec3	up

glm::vec3	right

glm::vec3	world_up

float	target_zoom

float	current_zoom

int	width

int	height

Private Member Functions
void	update_view_vectors ()
	Re-calculates the right and up vector from the View's updated vectors. More...

glm::vec2	screen_point_coords (glm::vec2 point) const
	Convert point coordinates ([0,0] in the upper left corner), to screen coordinates ([0,0] in the middle of the screen). More...

Detailed Description

A small utility class that manages the viewport coordinates, together with the virtual "camera" position and zoom.

Definition at line 36 of file view.h.

Constructor & Destructor Documentation

◆ View()

View::View	(	int	width = `800`,
		int	height = `600`,
		glm::vec3	position = `glm::vec3(0.0f, 0.0f, 1.0f)`,
		glm::vec3	up = `glm::vec3(0.0f, 1.0f, 0.0f)`
	)

inline

Definition at line 59 of file view.h.

Here is the call graph for this function:

Member Function Documentation

◆ get_proj_matrix()

glm::mat4 View::get_proj_matrix ( ) const

inline

Compute projection matrix for orthographic projection.

Returns: glm::mat4 Projection matrix

Definition at line 108 of file view.h.

Here is the caller graph for this function:

◆ get_view_matrix()

glm::mat4 View::get_view_matrix ( ) const

inline

Compute view matrix for drawing into the "view" space.

Returns: glm::mat4 View matrix

Definition at line 98 of file view.h.

Here is the caller graph for this function:

◆ look_at()

void View::look_at ( glm::vec2 tgt )

inline

Cause the camera to look at the specified point.

Parameters

tgt	This point will eventually get to the middle of the screen. It needs to be converted from mouse to model coordinates.

Definition at line 218 of file view.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ model_mouse_coords()

glm::vec2 View::model_mouse_coords ( glm::vec2 mouse ) const

inline

Convert mouse coordinates ([0,0] in the upper left corner), to model coordinates ([0,0] in the middle of the screen).

Parameters

mouse Mouse coordinates ([0,0] in the upper left corner)

Returns: glm::vec2 Model coordinates ([0,0] in the middle of the screen)

Definition at line 139 of file view.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move_x()

void View::move_x ( int dir )

inline

Move view along X-axis.

Parameters

dir	Direction of the movement. (-1 - left, 1 - right)

Definition at line 183 of file view.h.

Here is the caller graph for this function:

◆ move_y()

void View::move_y ( int dir )

inline

Move view along Y-axis.

Parameters

dir	Direction of the movement. (-1 - down, 1 - up)

Definition at line 171 of file view.h.

Here is the caller graph for this function:

◆ screen_coords()

glm::vec2 View::screen_coords ( glm::vec2 point ) const

inline

Converts point to screen coordinates([0,0] in the middle of the screen).

Parameters

point Input point in original not projected coordinates.

Returns: glm::vec2 Point in screen coordinates.

Definition at line 157 of file view.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ screen_mouse_coords()

glm::vec2 View::screen_mouse_coords ( glm::vec2 mouse ) const

inline

Convert mouse coordinates ([0,0] in the upper left corner), to screen coordinates ([0,0] in the middle of the screen).

Parameters

mouse Mouse coordinates ([0,0] in the upper left corner)

Returns: glm::vec2 Screen coordinates ([0,0] in the middle of the screen)

Definition at line 127 of file view.h.

Here is the caller graph for this function:

◆ screen_point_coords()

glm::vec2 View::screen_point_coords ( glm::vec2 point ) const

inlineprivate

Convert point coordinates ([0,0] in the upper left corner), to screen coordinates ([0,0] in the middle of the screen).

Parameters

point Point coordinates ([0,0] in the upper left corner)

Returns: glm::vec2 Screen coordinates ([0,0] in the middle of the screen)

Definition at line 247 of file view.h.

Here is the caller graph for this function:

◆ update()

void View::update	(	float	dt,
		int	w,
		int	h
	)

inline

Move the current position and zoom a bit closer to the target position and zoom.

Parameters

dt	Time difference.
input	Values collected by event callbacks.

Definition at line 80 of file view.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update_view_vectors()

void View::update_view_vectors ( )

inlineprivate

Re-calculates the right and up vector from the View's updated vectors.

Definition at line 231 of file view.h.

Here is the caller graph for this function:

◆ zoom()

void View::zoom	(	float	yoffset,
		glm::vec2	mouse
	)

inline

Adjust zoom accordingly.

Parameters

yoffset	Direction of the scroll (-1, 0, 1).
mouse	Mouse coordinates ([0,0] in the upper left corner).

Definition at line 196 of file view.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ current_pos

glm::vec3 View::current_pos

Definition at line 46 of file view.h.

◆ current_zoom

float View::current_zoom

Definition at line 53 of file view.h.

◆ front

glm::vec3 View::front

Definition at line 47 of file view.h.

◆ height

int View::height

Definition at line 57 of file view.h.

◆ movement_speed

const float View::movement_speed = 0.2f

Definition at line 40 of file view.h.

◆ right

glm::vec3 View::right

Definition at line 49 of file view.h.

◆ smooth_speed

const float View::smooth_speed = 0.005f

Definition at line 41 of file view.h.

◆ target_pos

glm::vec3 View::target_pos

Definition at line 45 of file view.h.

◆ target_zoom

float View::target_zoom

Definition at line 52 of file view.h.

◆ up

glm::vec3 View::up

Definition at line 48 of file view.h.

◆ width

int View::width

Definition at line 56 of file view.h.

◆ world_up

glm::vec3 View::world_up

Definition at line 50 of file view.h.

◆ zoom_depth

const float View::zoom_depth = 0.009f

Definition at line 42 of file view.h.

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

src/view.h

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ View()

Member Function Documentation

◆ get_proj_matrix()

◆ get_view_matrix()

◆ look_at()

◆ model_mouse_coords()

◆ move_x()

◆ move_y()

◆ screen_coords()

◆ screen_mouse_coords()

◆ screen_point_coords()

◆ update()

◆ update_view_vectors()

◆ zoom()

Member Data Documentation

◆ current_pos

◆ current_zoom

◆ front

◆ height

◆ movement_speed

◆ right

◆ smooth_speed

◆ target_pos

◆ target_zoom

◆ up

◆ width

◆ world_up

◆ zoom_depth