Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ add_library(ecs_engine STATIC
src/engine/EngineStepContext.h
src/engine/EngineSystem.h
src/engine/FrameClock.h
src/engine/WorldQuery.h
src/engine/EntityRegistry.cpp
src/engine/EngineRuntime.cpp
src/engine/FrameClock.cpp
Expand Down Expand Up @@ -103,6 +104,7 @@ if (BUILD_TESTING)
tests/EcsCoreTests.cpp
tests/ImportContractsTests.cpp
tests/DxfImportServiceTests.cpp
tests/WorldQueryTests.cpp
)

target_include_directories(safecrowd_tests
Expand Down
10 changes: 10 additions & 0 deletions src/engine/EntityRegistry.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ class EntityRegistry {
void setSignature(Entity entity, Signature signature);
[[nodiscard]] Signature signatureOf(Entity entity) const;

template <typename Fn>
void eachAlive(Fn&& fn) const {
for (std::size_t i = 0; i < entries_.size(); ++i) {
const Entry& entry = entries_[i];
if (entry.alive) {
fn(Entity{static_cast<EntityIndex>(i), entry.generation}, entry.signature);
}
}
}

private:
struct Entry {
EntityGeneration generation{0};
Expand Down
56 changes: 56 additions & 0 deletions src/engine/WorldQuery.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
#pragma once

#include <vector>

#include "engine/EcsCore.h"

namespace safecrowd::engine {

class WorldQuery {
public:
explicit WorldQuery(EcsCore& core) : core_(core) {}

template <typename... Ts>
[[nodiscard]] std::vector<Entity> view() const {
Signature required{};
bool allRegistered = true;
([&] {
const auto id = core_.componentRegistry().tryTypeOf<Ts>();
if (!id.has_value()) {
allRegistered = false;
} else {
required.set(id.value());
}
}(), ...);

if (!allRegistered) return {};

std::vector<Entity> result;
core_.entityRegistry().eachAlive([&](Entity entity, const Signature& sig) {
if ((sig & required) == required) {
result.push_back(entity);
}
});
return result;
}

template <typename T>
[[nodiscard]] bool contains(Entity entity) const {
return core_.hasComponent<T>(entity);
}

template <typename T>
[[nodiscard]] T& get(Entity entity) {
return core_.getComponent<T>(entity);
}

template <typename T>
[[nodiscard]] const T& get(Entity entity) const {
return core_.getComponent<T>(entity);
}

private:
EcsCore& core_;
};

} // namespace safecrowd::engine
84 changes: 84 additions & 0 deletions tests/WorldQueryTests.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
#include "TestSupport.h"

#include "engine/WorldQuery.h"

namespace {

struct Position {
float x{0.0f};
float y{0.0f};
};

struct Velocity {
float vx{0.0f};
float vy{0.0f};
};

} // namespace

SC_TEST(WorldQuery_ViewFiltersEntitiesBySignature) {
safecrowd::engine::EcsCore core;
safecrowd::engine::WorldQuery query{core};

const auto e1 = core.createEntity();
const auto e2 = core.createEntity();
const auto e3 = core.createEntity();

core.addComponent(e1, Position{});
core.addComponent(e1, Velocity{});
core.addComponent(e2, Position{});
core.addComponent(e3, Velocity{});

const auto result = query.view<Position, Velocity>();
SC_EXPECT_EQ(result.size(), std::size_t{1});
SC_EXPECT_TRUE(result[0] == e1);
}

SC_TEST(WorldQuery_ViewReturnsEmptyIfTypeNotRegistered) {
safecrowd::engine::EcsCore core;
safecrowd::engine::WorldQuery query{core};

static_cast<void>(core.createEntity());

const auto result = query.view<Position>();
SC_EXPECT_TRUE(result.empty());
}

SC_TEST(WorldQuery_ViewExcludesDestroyedEntities) {
safecrowd::engine::EcsCore core;
safecrowd::engine::WorldQuery query{core};

const auto e1 = core.createEntity();
core.addComponent(e1, Position{});
core.destroyEntity(e1);

const auto e2 = core.createEntity();
core.addComponent(e2, Position{});

const auto result = query.view<Position>();
SC_EXPECT_EQ(result.size(), std::size_t{1});
SC_EXPECT_TRUE(result[0] == e2);
}

SC_TEST(WorldQuery_ContainsReflectsComponentPresence) {
safecrowd::engine::EcsCore core;
safecrowd::engine::WorldQuery query{core};

const auto e = core.createEntity();
core.addComponent(e, Position{});

SC_EXPECT_TRUE(query.contains<Position>(e));
SC_EXPECT_TRUE(!query.contains<Velocity>(e));
}

SC_TEST(WorldQuery_GetReturnsComponentRef) {
safecrowd::engine::EcsCore core;
safecrowd::engine::WorldQuery query{core};

const auto e = core.createEntity();
core.addComponent(e, Position{3.0f, 4.0f});

const auto& pos = query.get<Position>(e);
SC_EXPECT_NEAR(pos.x, 3.0f, 1e-6);
SC_EXPECT_NEAR(pos.y, 4.0f, 1e-6);
}
Loading