Documentation for module 'NDK'

Former-commit-id: 63e1cac538c577a1f1aafa71fa7eef69a6d4daab [formerly b2d8769fd02a0e7d9c476d4ad7be1988a1fd6789] [formerly 636b5cb79bcb8da44d9aa45ba1023565bcf29f0d [formerly a2361ec2b8679d4d4ba096e543b5d4b91825dd62]]
Former-commit-id: d402d35477f9db0135c553d55c401939426bf62d [formerly 607336ea0f42731e4604f3a8c2df06f3aecfc401]
Former-commit-id: 69e23cd6c06723486de5e4641ce810012dac66da

tests/SDK/NDK/Entity.cpp

@@ -0,0 +1,101 @@
+#include <NDK/World.hpp>
+#include <NDK/Component.hpp>
+#include <Catch/catch.hpp>
+
+namespace
+{
+	class UpdatableComponent : public Ndk::Component<UpdatableComponent>
+	{
+		public:
+			bool IsUpdated()
+			{
+				return m_updated;
+			}
+
+			void SetUpdated()
+			{
+				m_updated = true;
+			}
+
+			static Ndk::ComponentIndex componentIndex;
+
+		private:
+			bool m_updated = false;
+	};
+
+	Ndk::ComponentIndex UpdatableComponent::componentIndex;
+
+	class UpdateSystem : public Ndk::System<UpdateSystem>
+	{
+		public:
+			UpdateSystem()
+			{
+				Requires<UpdatableComponent>();
+			}
+
+			~UpdateSystem() = default;
+
+			static Ndk::SystemIndex systemIndex;
+
+		private:
+			void OnUpdate(float elapsedTime) override
+			{
+				for (const Ndk::EntityHandle& entity : GetEntities())
+				{
+					UpdatableComponent& updatable = entity->GetComponent<UpdatableComponent>();
+					updatable.SetUpdated();
+				}
+			}
+	};
+
+	Ndk::SystemIndex UpdateSystem::systemIndex;
+}
+
+SCENARIO("Entity", "[NDK][ENTITY]")
+{
+	GIVEN("A world & an entity")
+	{
+		Ndk::World world;
+		Ndk::BaseSystem& system = world.AddSystem<UpdateSystem>();
+		const Ndk::EntityHandle& entity = world.CreateEntity();
+
+		WHEN("We add our UpdateComponent")
+		{
+			UpdatableComponent& updatableComponent = entity->AddComponent<UpdatableComponent>();
+			REQUIRE(!updatableComponent.IsUpdated());
+
+			THEN("Update the world should update the entity's component")
+			{
+				world.Update(1.f);
+				UpdatableComponent& updatableComponentGet = entity->GetComponent<UpdatableComponent>();
+				REQUIRE(updatableComponentGet.IsUpdated());
+			}
+
+			THEN("Update the world should not update the entity's component if it's disabled")
+			{
+				entity->Enable(false);
+				world.Update(1.f);
+				UpdatableComponent& updatableComponentGet = entity->GetComponent<UpdatableComponent>();
+				REQUIRE(!updatableComponentGet.IsUpdated());
+			}
+
+			THEN("We can remove its component")
+			{
+				entity->RemoveComponent(Ndk::GetComponentIndex<UpdatableComponent>());
+				world.Update(1.f);
+				REQUIRE(!entity->HasComponent<UpdatableComponent>());
+			}
+		}
+
+		WHEN("We kill our entity")
+		{
+			entity->Kill();
+			world.Update(1.f);
+
+			THEN("It's no more valid")
+			{
+				REQUIRE(!world.IsEntityValid(entity));
+			}
+		}
+	}
+}