aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Button.h
blob: d42527e5c79d3647f029051271a3581c0bbe6a86 (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
#pragma once

#include <functional>

#include "Event.h"
#include "UIObject.h"

namespace crepe {

/**
 * \brief Button component.
 * 
 * This component creates a clickable surface at the transform location with the specified width and height.
 * 
 * The Button can be used in scripts by subscribing a EventHandler to the following events:
 * - ButtonPressEvent
 * - ButtonEnterEvent
 * - ButtonExitEvent
 * \see EventManager
 * 
 */
class Button : public UIObject {
public:
	/**
	 * \brief Constructs a Button with the specified game object ID and dimensions.
	 *
	 * \param id The unique ID of the game object associated with this button.
	 * \param dimensions The width and height of the UIObject
	 * \param offset The offset relative this GameObjects Transform
	 */
	Button(game_object_id_t id, const vec2 & dimensions, const vec2 & offset);
	/**
	 * \brief Get the maximum number of instances for this component
	 *
	 * Since the button Event transfers the GameObject Metadata it will be the same for each button so only one button is allowed per GameObject	
	 * 
	 * \return 1
	 */
	virtual int get_instances_max() const { return 1; }

private:
	//! friend relation hover variable
	friend class InputSystem;
	//! Indicates whether the mouse is currently hovering over the button
	bool hover = false;
};

} // namespace crepe