aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api
diff options
context:
space:
mode:
authorWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-25 11:48:01 +0100
committerWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-25 11:48:01 +0100
commitea7d7ec301968f3a542de93f487f9501b70c0cd4 (patch)
treec2a81d117f62c06d369a8e6336a4ecac675df508 /src/crepe/api
parent596358ffea72aec48b389609349f717e76396ae2 (diff)
code standard fixing
Diffstat (limited to 'src/crepe/api')
-rw-r--r--src/crepe/api/Button.cpp5
-rw-r--r--src/crepe/api/Button.h49
-rw-r--r--src/crepe/api/CMakeLists.txt2
-rw-r--r--src/crepe/api/EventManager.hpp2
-rw-r--r--src/crepe/api/UiObject.cpp5
-rw-r--r--src/crepe/api/UiObject.h32
6 files changed, 74 insertions, 21 deletions
diff --git a/src/crepe/api/Button.cpp b/src/crepe/api/Button.cpp
new file mode 100644
index 0000000..70f749d
--- /dev/null
+++ b/src/crepe/api/Button.cpp
@@ -0,0 +1,5 @@
+#include "Button.h"
+
+using namespace crepe;
+
+Button::Button(game_object_id_t id) : UiObject(id){}
diff --git a/src/crepe/api/Button.h b/src/crepe/api/Button.h
index f533452..f769d58 100644
--- a/src/crepe/api/Button.h
+++ b/src/crepe/api/Button.h
@@ -1,19 +1,44 @@
#pragma once
+
#include <functional>
-#include "Component.h"
-#include "api/EventHandler.h"
-#include "api/UiObject.h"
+#include "UiObject.h"
+
namespace crepe {
-class Button : public UiObject{
+
+/**
+ * \class Button
+ * \brief Represents a clickable UI button, derived from the UiObject class.
+ */
+class Button : public UiObject {
public:
- Button(game_object_id_t id) : UiObject(id){};
- bool interactable = true;
- bool is_toggle = false;
- bool is_pressed = false;
- bool hover = false;
- std::function<void()> on_click;
+ /**
+ * \brief Constructs a Button with the specified game object ID.
+ * \param id The unique ID of the game object associated with this button.
+ */
+ Button(game_object_id_t id);
+
+ //! Indicates if the button is interactable (can be clicked).
+ bool interactable = true;
+
+ //! Indicates if the button is a toggle button (can be pressed and released).
+ bool is_toggle = false;
+
+ //! Indicates whether the button is currently pressed.
+ bool is_pressed = false;
+
+ //! Indicates whether the mouse is currently hovering over the button.
+ bool hover = false;
+
+ //! The callback function to be executed when the button is clicked.
+ std::function<void()> on_click;
+
public:
-virtual int get_instances_max() const { return 1; }
+ /**
+ * \brief Retrieves the maximum number of instances allowed for this button type.
+ * \return Always returns 1, as only a single instance is allowed.
+ */
+ virtual int get_instances_max() const override { return 1; }
};
-}
+
+} // namespace crepe
diff --git a/src/crepe/api/CMakeLists.txt b/src/crepe/api/CMakeLists.txt
index fc27fa0..aeb451d 100644
--- a/src/crepe/api/CMakeLists.txt
+++ b/src/crepe/api/CMakeLists.txt
@@ -23,6 +23,8 @@ target_sources(crepe PUBLIC
Asset.cpp
EventHandler.cpp
Script.cpp
+ Button.cpp
+ UiObject.cpp
)
target_sources(crepe PUBLIC FILE_SET HEADERS FILES
diff --git a/src/crepe/api/EventManager.hpp b/src/crepe/api/EventManager.hpp
index 3eae90a..a5f4556 100644
--- a/src/crepe/api/EventManager.hpp
+++ b/src/crepe/api/EventManager.hpp
@@ -1,5 +1,5 @@
#pragma once
-#include <iostream>
+
#include "EventManager.h"
namespace crepe {
diff --git a/src/crepe/api/UiObject.cpp b/src/crepe/api/UiObject.cpp
new file mode 100644
index 0000000..1c11fc3
--- /dev/null
+++ b/src/crepe/api/UiObject.cpp
@@ -0,0 +1,5 @@
+#include "UiObject.h"
+
+using namespace crepe;
+
+UiObject::UiObject(game_object_id_t id) : Component(id){};
diff --git a/src/crepe/api/UiObject.h b/src/crepe/api/UiObject.h
index 82140a0..ae2e744 100644
--- a/src/crepe/api/UiObject.h
+++ b/src/crepe/api/UiObject.h
@@ -1,17 +1,33 @@
#pragma once
-#include "Component.h"
+#include "../Component.h"
-#include "api/EventHandler.h"
namespace crepe {
-class UiObject : public Component{
+/**
+ * @class UiObject
+ * \brief Represents a UI object in the game, derived from the Component class.
+ */
+class UiObject : public Component {
public:
- UiObject(game_object_id_t id) : Component(id){};
- int width = 0;
- int height = 0;
+ /**
+ * \brief Constructs a UiObject with the specified game object ID.
+ * \param id The unique ID of the game object associated with this UI object.
+ */
+ UiObject(game_object_id_t id);
+
+ //! The width of the UI object.
+ int width = 0;
+
+ //! The height of the UI object.
+ int height = 0;
+
public:
-virtual int get_instances_max() const { return 1; }
+ /**
+ * \brief Retrieves the maximum number of instances allowed for this UI object type.
+ * /return Always returns 1, as only a single instance is allowed.
+ */
+ virtual int get_instances_max() const override { return 1; }
};
-}
+} // namespace crepe