aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Camera.h
blob: 022496d36a9d956b4b70528a78f5bafc2e5fc987 (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
68
69
70
#pragma once

#include "Component.h"
#include "api/Color.h"
#include <cstdint>

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(uint32_t id, const Color & bg_color);

	/**
     * \brief Destroys the Camera instance.
     */
	~Camera();

public:
	/**
     * \brief Background color of the camera view.
     */
	Color bg_color;

	/**
     * \brief Aspect ratio height for the camera.
     */
	double aspect_height;

	/**
     * \brief Aspect ratio width for the camera.
     */
	double aspect_width;

	/**
     * \brief X-coordinate of the camera position.
     */
	double x;

	/**
     * \brief Y-coordinate of the camera position.
     */
	double y;

	/**
     * \brief Zoom level of the camera view.
     */
	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 10; }
};
} // namespace crepe