aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Camera.h
blob: 54d9a7360d58407fb10f6684204991e7077baa3b (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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
#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:
	struct Data {
		/**
		 * \bg_color background color of the game
		 *
		 * This will make the background the same color as the given value.
		 */
		const Color bg_color = Color::BLACK;

		/**
		 * \zoom Zooming level of the game
		 *
		 * zoom = 1 --> no zoom.
		 * zoom < 1 --> zoom out
		 * zoom > 1 --> zoom in
		 */
		double zoom = 1;

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

public:
	/**
	 * \brief Constructs a Camera with the specified ID and background color.
	 * \param id Unique identifier for the camera component.
	 * \param screen is the actual screen size in pixels
	 * \param viewport_size is the view of the world in game units
	 * \param data the camera component data
	 */
	Camera(game_object_id_t id, const ivec2 & screen, const vec2 & viewport_size,
		   const Camera::Data & data);
	~Camera(); // dbg_trace only

public:
	Camera::Data data;

	//! 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;

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