Documentation for module 'NDK'

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

SDK/src/NDK/Systems/ListenerSystem.cpp

@@ -10,11 +10,29 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::ListenerSystem
+	* \brief NDK class that represents the audio system
+	*
+	* \remark This system is enabled if the entity owns the trait: ListenerComponent and NodeComponent
+	*/
+
+	/*!
+	* \brief Constructs an ListenerSystem object by default
+	*/
+
 	ListenerSystem::ListenerSystem()
 	{
 		Requires<ListenerComponent, NodeComponent>();
 	}
 
+	/*!
+	* \brief Operation to perform when system is updated
+	*
+	* \param elapsedTime Delta time used for the update
+	*/
+
 	void ListenerSystem::OnUpdate(float elapsedTime)
 	{
 		NazaraUnused(elapsedTime);
@@ -23,18 +41,18 @@ namespace Ndk
 
 		for (const Ndk::EntityHandle& entity : GetEntities())
 		{
-			// Le listener est-il actif ?
+			// Is the listener actif ?
 			const ListenerComponent& listener = entity->GetComponent<ListenerComponent>();
 			if (!listener.IsActive())
 				continue;
 
-			// On récupère la position et la rotation pour les affecter au listener
+			// We get the position and the rotation to affect these to the listener
 			const NodeComponent& node = entity->GetComponent<NodeComponent>();
 			Nz::Audio::SetListenerPosition(node.GetPosition(Nz::CoordSys_Global));
 			Nz::Audio::SetListenerRotation(node.GetRotation(Nz::CoordSys_Global));
 
-			// On vérifie la présence d'une donnée de vitesse, et on l'affecte
-			// (La vitesse du listener Audio ne le fait pas se déplacer, mais affecte par exemple l'effet Doppler)
+			// We verify the presence of a component of velocity
+			// (The listener'speed does not move it, but disturbs the sound like Doppler effect)
 			if (entity->HasComponent<VelocityComponent>())
 			{
 				const VelocityComponent& velocity = entity->GetComponent<VelocityComponent>();

SDK/src/NDK/Systems/ParticleSystem.cpp

@@ -7,11 +7,29 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::ParticleSystem
+	* \brief NDK class that represents the particle system
+	*
+	* \remark This system is enabled if the entity has the trait: NodeComponent and any of these two: ParticleGroupComponent
+	*/
+
+	/*!
+	* \brief Constructs an ParticleSystem object by default
+	*/
+
 	ParticleSystem::ParticleSystem()
 	{
 		Requires<ParticleGroupComponent>();
 	}
 
+	/*!
+	* \brief Operation to perform when system is updated
+	*
+	* \param elapsedTime Delta time used for the update
+	*/
+
 	void ParticleSystem::OnUpdate(float elapsedTime)
 	{
 		for (const Ndk::EntityHandle& entity : GetEntities())

SDK/src/NDK/Systems/PhysicsSystem.cpp

@@ -10,24 +10,50 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::PhysicsSystem
+	* \brief NDK class that represents the physics system
+	*
+	* \remark This system is enabled if the entity has the trait: NodeComponent and any of these two: CollisionComponent or PhysicsComponent
+	* \remark Static objects do not have a velocity specified by the physical engine
+	*/
+
+	/*!
+	* \brief Constructs an PhysicsSystem object by default
+	*/
+
 	PhysicsSystem::PhysicsSystem()
 	{
 		Requires<NodeComponent>();
 		RequiresAny<CollisionComponent, PhysicsComponent>();
 	}
 
+	/*!
+	* \brief Constructs a PhysicsSystem object by copy semantic
+	*
+	* \param system PhysicsSystem to copy
+	*/
+
 	PhysicsSystem::PhysicsSystem(const PhysicsSystem& system) :
 	System(system),
 	m_world()
 	{
 	}
 
+	/*!
+	* \brief Operation to perform when entity is validated for the system
+	*
+	* \param entity Pointer to the entity
+	* \param justAdded Is the entity newly added
+	*/
+
 	void PhysicsSystem::OnEntityValidation(Entity* entity, bool justAdded)
 	{
-		// Si l'entité ne vient pas d'être ajoutée au système, il est possible qu'elle fasse partie du mauvais tableau
+		// If entity has not been just added to the system, it is possible that it does not own to the right array
 		if (!justAdded)
 		{
-			// On prend le tableau inverse de celui dont l'entité devrait faire partie
+			// We take the inverted array from which the entity should belong to
 			auto& entities = (entity->HasComponent<PhysicsComponent>()) ? m_staticObjects : m_dynamicObjects;
 			entities.Remove(entity);
 		}
@@ -36,6 +62,12 @@ namespace Ndk
 		entities.Insert(entity);
 	}
 
+	/*!
+	* \brief Operation to perform when system is updated
+	*
+	* \param elapsedTime Delta time used for the update
+	*/
+
 	void PhysicsSystem::OnUpdate(float elapsedTime)
 	{
 		m_world.Step(elapsedTime);
@@ -63,8 +95,8 @@ namespace Ndk
 			Nz::Quaternionf newRotation = node.GetRotation(Nz::CoordSys_Global);
 			Nz::Vector3f newPosition = node.GetPosition(Nz::CoordSys_Global);
 
-			// Pour déplacer des objets statiques et assurer les collisions, il faut leur définir une vitesse
-			// (note importante: le moteur physique n'applique pas la vitesse sur les objets statiques)
+			// To move static objects and ensure their collisions, we have to specify them a velocity
+			// (/!\: the physical motor does not apply the speed on static objects)
 			if (newPosition != oldPosition)
 			{
 				physObj->SetPosition(newPosition);

SDK/src/NDK/Systems/RenderSystem.cpp

@@ -14,6 +14,21 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::RenderSystem
+	* \brief NDK class that represents the rendering system
+	*
+	* \remark This system is enabled if the entity is a 'camera' with the trait: CameraComponent and NodeComponent
+	* or a drawable element with trait: GraphicsComponent and NodeComponent
+	* or a light element with trait: LightComponent and NodeComponent
+	* or a set of particles with trait: ParticleGroupComponent
+	*/
+
+	/*!
+	* \brief Constructs an RenderSystem object by default
+	*/
+
 	RenderSystem::RenderSystem() :
 	m_coordinateSystemMatrix(Nz::Matrix4f::Identity()),
 	m_coordinateSystemInvalidated(true)
@@ -23,6 +38,12 @@ namespace Ndk
 		SetUpdateRate(0.f);
 	}
 
+	/*!
+	* \brief Operation to perform when an entity is removed
+	*
+	* \param entity Pointer to the entity
+	*/
+
 	void RenderSystem::OnEntityRemoved(Entity* entity)
 	{
 		m_cameras.Remove(entity);
@@ -33,6 +54,13 @@ namespace Ndk
 		m_pointSpotLights.Remove(entity);
 	}
 
+	/*!
+	* \brief Operation to perform when entity is validated for the system
+	*
+	* \param entity Pointer to the entity
+	* \param justAdded Is the entity newly added
+	*/
+
 	void RenderSystem::OnEntityValidation(Entity* entity, bool justAdded)
 	{
 		NazaraUnused(justAdded);
@@ -82,6 +110,12 @@ namespace Ndk
 			m_particleGroups.Remove(entity);
 	}
 
+	/*!
+	* \brief Operation to perform when system is updated
+	*
+	* \param elapsedTime Delta time used for the update
+	*/
+
 	void RenderSystem::OnUpdate(float elapsedTime)
 	{
 		NazaraUnused(elapsedTime);
@@ -146,6 +180,12 @@ namespace Ndk
 		}
 	}
 
+	/*!
+	* \brief Updates the directional shadow maps according to the position of the viewer
+	*
+	* \param viewer Viewer of the scene
+	*/
+
 	void RenderSystem::UpdateDirectionalShadowMaps(const Nz::AbstractViewer& viewer)
 	{
 		if (!m_shadowRT.IsValid())
@@ -191,6 +231,10 @@ namespace Ndk
 		}
 	}
 
+	/*!
+	* \brief Updates the point spot shadow maps
+	*/
+
 	void RenderSystem::UpdatePointSpotShadowMaps()
 	{
 		if (!m_shadowRT.IsValid())

SDK/src/NDK/Systems/VelocitySystem.cpp

@@ -9,12 +9,31 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::VelocitySystem
+	* \brief NDK class that represents the velocity system
+	*
+	* \remark This system is enabled if the entity owns the trait: NodeComponent and VelocityComponent
+	* but it's disabled with the trait: PhysicsComponent
+	*/
+
+	/*!
+	* \brief Constructs an VelocitySystem object by default
+	*/
+
 	VelocitySystem::VelocitySystem()
 	{
 		Requires<NodeComponent, VelocityComponent>();
 		Excludes<PhysicsComponent>();
 	}
 
+	/*!
+	* \brief Operation to perform when system is updated
+	*
+	* \param elapsedTime Delta time used for the update
+	*/
+
 	void VelocitySystem::OnUpdate(float elapsedTime)
 	{
 		for (const Ndk::EntityHandle& entity : GetEntities())