Merge remote-tracking branch 'origin/master' into max/AI

1 files changed, 67 insertions, 0 deletions

diff --git a/src/crepe/api/Button.h b/src/crepe/api/Button.h
new file mode 100644
index 0000000..26e7526
--- /dev/null
+++ b/src/crepe/api/Button.h
@@ -0,0 +1,67 @@
+#pragma once
+
+#include <functional>
+
+#include "UIObject.h"
+
+namespace crepe {
+
+//! Represents a clickable UI button, derived from the UiObject class.
+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
+	 * \param is_toggle Optional flag to indicate if the button is a toggle button. Defaults to false.
+	 * \param on_click callback function that will be invoked when the button is clicked.
+	 */
+	Button(game_object_id_t id, const vec2 & dimensions, const vec2 & offset,
+		   const std::function<void()> & on_click, bool is_toggle = false);
+
+	/**
+	 * \brief Indicates if the button is a toggle button (can be pressed and released).
+	 * 
+	 * A toggle button allows for a pressed/released state, whereas a regular button
+	 * typically only has an on-click state.
+	 */
+	bool is_toggle = false;
+	// TODO: create separate toggle button class
+	/**
+	 * \brief The callback function to be executed when the button is clicked.
+	 * 
+	 * This function is invoked whenever the button is clicked. It can be set to any
+	 * function that matches the signature `void()`.
+	 */
+	std::function<void()> on_click = nullptr;
+
+	/**
+	 * \brief Callback function to be executed when the mouse enters the button's boundaries.
+	 *
+	 * This function is triggered when the mouse cursor moves over the button, allowing
+	 * custom actions like visual effects, highlighting, or sound effects.
+	 */
+	std::function<void()> on_mouse_enter = nullptr;
+
+	/**
+	 * \brief Callback function to be executed when the mouse exits the button's boundaries.
+	 *
+	 * This function is triggered when the mouse cursor moves out of the button's area,
+	 * allowing custom actions like resetting visual effects or playing exit-related effects.
+	 */
+	std::function<void()> on_mouse_exit = nullptr;
+
+private:
+	//! friend relation for is_pressed and hover variables
+	friend class InputSystem;
+	//! Indicates whether the toggle button is pressed
+	bool is_pressed = false;
+	//! Indicates whether the mouse is currently hovering over the button
+	bool hover = false;
+
+public:
+};
+
+} // namespace crepe