aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Sprite.h
blob: 2d73879b785663a935409a0c1fdad1fd8b7423ab (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#pragma once

#include "../Component.h"

#include "Color.h"
#include "Texture.h"
#include <cstdint>

namespace crepe {

class SDLContext;
class Animator;
class AnimatorSystem;

/**
 * \brief Represents a renderable sprite component.
 *
 * A renderable sprite that can be displayed in the game. It includes a texture, color, and
 * flip settings, and is managed in layers with defined sorting orders.
 */
class Sprite : public Component {

public:
	struct FlipSettings {
		bool flip_x = false;
		bool flip_y = false;
	};

public:
	// TODO: Loek comment in github #27 will be looked another time
	// about shared_ptr Texture
	/**
	 * \brief Constructs a Sprite with specified parameters.
	 * \param game_id Unique identifier for the game object this sprite belongs to.
	 * \param image Shared pointer to the texture for this sprite.
	 * \param color Color tint applied to the sprite.
	 * \param flip Flip settings for horizontal and vertical orientation.
	 * \param order_layer decides the sorting in layer of the sprite.
	 * \param sort_layer decides the order in layer of the sprite.
	 * \param height the height of the image in game units
	 */
	Sprite(game_object_id_t id, Texture & image, const Color & color,
		   const FlipSettings & flip, uint8_t sort_layer, uint8_t order_layer, int height);

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

	//! Texture used for the sprite
	const Texture sprite_image;

	//! Color tint of the sprite
	Color color;

	//! Flip settings for the sprite
	FlipSettings flip;

	//! Layer sorting level of the sprite
	const uint8_t sorting_in_layer;
	//! Order within the sorting layer
	const uint8_t order_in_layer;

	//! height in world units
	const int height;

	/**
	 * \aspect_ratio ratio of the img so that scaling will not become weird
	 *
	 * cannot be const because if Animator component is addded then ratio becomes scuffed and
	 * does it need to be calculated again in the Animator
	 */
	double aspect_ratio;

private:
	//! Reads the sprite_rect of sprite
	friend class SDLContext;

	//! Reads the all the variables plus the  sprite_rect
	friend class Animator;

	//! Reads the all the variables plus the  sprite_rect
	friend class AnimatorSystem;

	struct Rect {
		int w = 0;
		int h = 0;
		int x = 0;
		int y = 0;
	};
	//! Render area of the sprite this will also be adjusted by the AnimatorSystem if an Animator
	// object is present in GameObject. this is in sprite pixels
	Rect sprite_rect;
};

} // namespace crepe