aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-12-07 14:18:54 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-12-07 14:18:54 +0100
commit90c6bf03e59fdec64f850310bcbff45ae86f69e3 (patch)
treef80305e8b712e17c41a1860ec82a139842c67ba0 /src
parentf4824f5e7e6cee12bec602f3240770945a73d043 (diff)
more script utilities
Diffstat (limited to 'src')
-rw-r--r--src/crepe/api/Script.h12
-rw-r--r--src/crepe/api/Script.hpp27
-rw-r--r--src/crepe/manager/ComponentManager.h20
-rw-r--r--src/crepe/manager/ComponentManager.hpp23
-rw-r--r--src/test/CMakeLists.txt1
-rw-r--r--src/test/ECSTest.cpp50
-rw-r--r--src/test/ScriptECSTest.cpp42
-rw-r--r--src/test/ScriptEventTest.cpp2
-rw-r--r--src/test/ScriptSceneTest.cpp3
-rw-r--r--src/test/ScriptTest.cpp3
-rw-r--r--src/test/ScriptTest.h2
11 files changed, 175 insertions, 10 deletions
diff --git a/src/crepe/api/Script.h b/src/crepe/api/Script.h
index 5862bae..a040608 100644
--- a/src/crepe/api/Script.h
+++ b/src/crepe/api/Script.h
@@ -90,6 +90,18 @@ protected:
*/
template <typename T>
RefVector<T> get_components_by_id(game_object_id_t id) const;
+ /**
+ * \copydoc ComponentManager::get_components_by_name
+ * \see ComponentManager::get_components_by_name
+ */
+ template <typename T>
+ RefVector<T> get_components_by_name(const std::string & name) const;
+ /**
+ * \copydoc ComponentManager::get_components_by_tag
+ * \see ComponentManager::get_components_by_tag
+ */
+ template <typename T>
+ RefVector<T> get_components_by_tag(const std::string & tag) const;
/**
* \brief Log a message using Log::logf
diff --git a/src/crepe/api/Script.hpp b/src/crepe/api/Script.hpp
index 45f1ff1..16e0dc5 100644
--- a/src/crepe/api/Script.hpp
+++ b/src/crepe/api/Script.hpp
@@ -20,10 +20,7 @@ T & Script::get_component() const {
template <typename T>
RefVector<T> Script::get_components() const {
- Mediator & mediator = this->mediator;
- ComponentManager & mgr = mediator.component_manager;
-
- return mgr.get_components_by_id<T>(this->game_object_id);
+ return this->get_components_by_id<T>(this->game_object_id);
}
template <typename... Args>
@@ -56,4 +53,26 @@ void Script::subscribe(const EventHandler<EventType> & callback) {
this->subscribe_internal(callback, EventManager::CHANNEL_ALL);
}
+template <typename T>
+RefVector<T> Script::get_components_by_id(game_object_id_t id) const {
+ Mediator & mediator = this->mediator;
+ ComponentManager & mgr = mediator.component_manager;
+
+ return mgr.get_components_by_id<T>(id);
+}
+template <typename T>
+RefVector<T> Script::get_components_by_name(const std::string & name) const {
+ Mediator & mediator = this->mediator;
+ ComponentManager & mgr = mediator.component_manager;
+
+ return mgr.get_components_by_name<T>(name);
+}
+template <typename T>
+RefVector<T> Script::get_components_by_tag(const std::string & tag) const {
+ Mediator & mediator = this->mediator;
+ ComponentManager & mgr = mediator.component_manager;
+
+ return mgr.get_components_by_tag<T>(tag);
+}
+
} // namespace crepe
diff --git a/src/crepe/manager/ComponentManager.h b/src/crepe/manager/ComponentManager.h
index 5f2cf3c..4e53954 100644
--- a/src/crepe/manager/ComponentManager.h
+++ b/src/crepe/manager/ComponentManager.h
@@ -135,10 +135,30 @@ public:
*/
template <typename T>
RefVector<T> get_components_by_type() const;
+ /**
+ * \brief Get all components of a specific type on a GameObject with name \c name
+ *
+ * \tparam T The type of the component
+ * \param name Metadata::name for the same game_object_id as the returned components
+ * \return Components matching criteria
+ */
+ template <typename T>
+ RefVector<T> get_components_by_name(const std::string & name) const;
+ /**
+ * \brief Get all components of a specific type on a GameObject with tag \c tag
+ *
+ * \tparam T The type of the component
+ * \param name Metadata::tag for the same game_object_id as the returned components
+ * \return Components matching criteria
+ */
+ template <typename T>
+ RefVector<T> get_components_by_tag(const std::string & tag) const;
private:
template <typename T>
std::set<game_object_id_t> get_objects_by_predicate(const std::function<bool (const T &)> & pred) const;
+ template <typename T>
+ RefVector<T> get_components_by_ids(const std::set<game_object_id_t> & ids) const;
std::set<game_object_id_t> get_objects_by_name(const std::string & name) const;
std::set<game_object_id_t> get_objects_by_tag(const std::string & tag) const;
diff --git a/src/crepe/manager/ComponentManager.hpp b/src/crepe/manager/ComponentManager.hpp
index 25c2747..52df368 100644
--- a/src/crepe/manager/ComponentManager.hpp
+++ b/src/crepe/manager/ComponentManager.hpp
@@ -167,4 +167,27 @@ std::set<game_object_id_t> ComponentManager::get_objects_by_predicate(const std:
return objects;
}
+template <typename T>
+RefVector<T> ComponentManager::get_components_by_ids(const std::set<game_object_id_t> & ids) const {
+ using namespace std;
+
+ RefVector<T> out = {};
+ for (game_object_id_t id : ids) {
+ RefVector<T> components = get_components_by_id<T>(id);
+ out.insert(out.end(), components.begin(), components.end());
+ }
+
+ return out;
+}
+
+template <typename T>
+RefVector<T> ComponentManager::get_components_by_name(const std::string & name) const {
+ return this->get_components_by_ids<T>(this->get_objects_by_name(name));
+}
+
+template <typename T>
+RefVector<T> ComponentManager::get_components_by_tag(const std::string & tag) const {
+ return this->get_components_by_ids<T>(this->get_objects_by_tag(tag));
+}
+
} // namespace crepe
diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt
index e19d7de..43f564a 100644
--- a/src/test/CMakeLists.txt
+++ b/src/test/CMakeLists.txt
@@ -15,4 +15,5 @@ target_sources(test_main PUBLIC
InputTest.cpp
ScriptEventTest.cpp
ScriptSceneTest.cpp
+ ScriptECSTest.cpp
)
diff --git a/src/test/ECSTest.cpp b/src/test/ECSTest.cpp
index a169b3b..ed5341e 100644
--- a/src/test/ECSTest.cpp
+++ b/src/test/ECSTest.cpp
@@ -17,6 +17,10 @@ class ECSTest : public ::testing::Test {
public:
ComponentManager mgr{m};
+
+ class TestComponent : public Component {
+ using Component::Component;
+ };
};
TEST_F(ECSTest, createGameObject) {
@@ -389,7 +393,7 @@ TEST_F(ECSTest, resetPersistent) {
EXPECT_EQ(transform.size(), 0);
}
-TEST_F(ECSTest, GetByName) {
+TEST_F(ECSTest, IDByName) {
GameObject foo = mgr.new_object("foo");
GameObject bar = mgr.new_object("bar");
@@ -405,7 +409,7 @@ TEST_F(ECSTest, GetByName) {
}
}
-TEST_F(ECSTest, GetByTag) {
+TEST_F(ECSTest, IDByTag) {
GameObject foo = mgr.new_object("foo", "common tag");
GameObject bar = mgr.new_object("bar", "common tag");
@@ -421,3 +425,45 @@ TEST_F(ECSTest, GetByTag) {
EXPECT_TRUE(objects.contains(bar.id));
}
}
+
+TEST_F(ECSTest, ComponentsByName) {
+ GameObject foo = mgr.new_object("foo");
+ foo.add_component<TestComponent>();
+ GameObject bar = mgr.new_object("bar");
+ bar.add_component<TestComponent>();
+ bar.add_component<TestComponent>();
+
+ {
+ auto objects = mgr.get_components_by_name<TestComponent>("");
+ EXPECT_EQ(objects.size(), 0);
+ }
+
+ {
+ auto objects = mgr.get_components_by_name<TestComponent>("foo");
+ EXPECT_EQ(objects.size(), 1);
+ }
+
+ {
+ auto objects = mgr.get_components_by_name<TestComponent>("bar");
+ EXPECT_EQ(objects.size(), 2);
+ }
+}
+
+TEST_F(ECSTest, ComponentsByTag) {
+ GameObject foo = mgr.new_object("foo", "common tag");
+ foo.add_component<TestComponent>();
+ GameObject bar = mgr.new_object("bar", "common tag");
+ bar.add_component<TestComponent>();
+ bar.add_component<TestComponent>();
+
+ {
+ auto objects = mgr.get_components_by_tag<TestComponent>("");
+ EXPECT_EQ(objects.size(), 0);
+ }
+
+ {
+ auto objects = mgr.get_components_by_tag<TestComponent>("common tag");
+ EXPECT_EQ(objects.size(), 3);
+ }
+}
+
diff --git a/src/test/ScriptECSTest.cpp b/src/test/ScriptECSTest.cpp
new file mode 100644
index 0000000..4477e55
--- /dev/null
+++ b/src/test/ScriptECSTest.cpp
@@ -0,0 +1,42 @@
+#include <gtest/gtest.h>
+
+#define protected public
+
+#include <crepe/api/BehaviorScript.h>
+#include <crepe/api/GameObject.h>
+#include <crepe/api/Script.h>
+#include <crepe/api/Metadata.h>
+#include <crepe/manager/ComponentManager.h>
+#include <crepe/system/ScriptSystem.h>
+
+#include "ScriptTest.h"
+
+using namespace std;
+using namespace crepe;
+using namespace testing;
+
+class ScriptECSTest : public ScriptTest {
+public:
+ class TestComponent : public Component {
+ using Component::Component;
+ };
+};
+
+TEST_F(ScriptECSTest, GetOwnComponent) {
+ MyScript & script = this->script;
+ Metadata & metadata = script.get_component<Metadata>();
+
+ EXPECT_EQ(metadata.name, OBJ_NAME);
+}
+
+TEST_F(ScriptECSTest, GetOwnComponents) {
+ const unsigned COUNT = 4;
+
+ for (unsigned i = 0; i < COUNT; i++)
+ entity.add_component<TestComponent>();
+
+ MyScript & script = this->script;
+ RefVector<TestComponent> components = script.get_components<TestComponent>();
+
+ EXPECT_EQ(components.size(), COUNT);
+}
diff --git a/src/test/ScriptEventTest.cpp b/src/test/ScriptEventTest.cpp
index 5da31e7..c1b4028 100644
--- a/src/test/ScriptEventTest.cpp
+++ b/src/test/ScriptEventTest.cpp
@@ -26,7 +26,7 @@ public:
class MyEvent : public Event {};
};
-TEST_F(ScriptEventTest, Inactive) {
+TEST_F(ScriptEventTest, Default) {
BehaviorScript & behaviorscript = this->behaviorscript;
MyScript & script = this->script;
EventManager & evmgr = this->event_manager;
diff --git a/src/test/ScriptSceneTest.cpp b/src/test/ScriptSceneTest.cpp
index 9ee1e52..8e849c1 100644
--- a/src/test/ScriptSceneTest.cpp
+++ b/src/test/ScriptSceneTest.cpp
@@ -18,7 +18,7 @@ public:
class MyScene : public Scene {};
};
-TEST_F(ScriptSceneTest, Inactive) {
+TEST_F(ScriptSceneTest, Default) {
BehaviorScript & behaviorscript = this->behaviorscript;
MyScript & script = this->script;
@@ -28,3 +28,4 @@ TEST_F(ScriptSceneTest, Inactive) {
script.set_next_scene(non_default_value);
EXPECT_EQ(non_default_value, scene_manager.next_scene);
}
+
diff --git a/src/test/ScriptTest.cpp b/src/test/ScriptTest.cpp
index 1d2d6dd..b0b2546 100644
--- a/src/test/ScriptTest.cpp
+++ b/src/test/ScriptTest.cpp
@@ -6,7 +6,6 @@
#define protected public
#include "ScriptTest.h"
-#include <crepe/api/GameObject.h>
using namespace std;
using namespace crepe;
@@ -14,7 +13,6 @@ using namespace testing;
void ScriptTest::SetUp() {
auto & mgr = this->component_manager;
- GameObject entity = mgr.new_object("name");
BehaviorScript & component = entity.add_component<BehaviorScript>();
this->behaviorscript = component;
@@ -75,3 +73,4 @@ TEST_F(ScriptTest, UpdateInactive) {
system.update();
}
}
+
diff --git a/src/test/ScriptTest.h b/src/test/ScriptTest.h
index 1bbfdd3..309e016 100644
--- a/src/test/ScriptTest.h
+++ b/src/test/ScriptTest.h
@@ -11,10 +11,12 @@
class ScriptTest : public testing::Test {
protected:
crepe::Mediator mediator;
+ static constexpr const char * OBJ_NAME = "foo";
public:
crepe::ComponentManager component_manager{mediator};
crepe::ScriptSystem system{mediator};
+ crepe::GameObject entity = component_manager.new_object(OBJ_NAME);
class MyScript : public crepe::Script {
// NOTE: explicitly stating `public:` is not required on actual scripts