aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Camera.h
blob: 2d8fa489d3cfde5a56fab9458fef57532bf60536 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#pragma once

#include "Color.h"
#include "Component.h"
#include "types.h"

namespace crepe {

/**
 * \class Camera
 * \brief Represents a camera component for rendering in the game.
 *
 * The Camera class defines the view parameters, including background color, aspect ratio,
 * position, and zoom level. It controls what part of the game world is visible on the screen.
 */
class Camera : public Component {

public:
	/**
	 * \brief Constructs a Camera with the specified ID and background color.
	 * \param id Unique identifier for the camera component.
	 * \param bg_color Background color for the camera view.
	 */
	Camera(game_object_id_t id, const Color & bg_color, const ivec2 & screen,
		   const vec2 & viewport_size, const double & zoom, const vec2 & offset = {0, 0});
	~Camera(); // dbg_trace only

public:
	//! Background color of the camera view.
	const Color bg_color;

	//! offset postion from the game object transform component
	vec2 offset;

	//! screen the display size in pixels ( output resolution )
	const ivec2 screen;

	//! viewport is the area of the world visible through the camera (in world units)
	const vec2 viewport_size;

	//! Zoom level of the camera view.
	const double zoom;

public:
	/**
	 * \brief Gets the maximum number of camera instances allowed.
	 * \return Maximum instance count as an integer.
	 */
	virtual int get_instances_max() const { return 1; }
};
} // namespace crepe