Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

include/Nazara/Graphics/Billboard.inl

@@ -7,6 +7,10 @@
 
 namespace Nz
 {
+	/*!
+	* \brief Constructs a Billboard object by default
+	*/
+
 	inline Billboard::Billboard()
 	{
 		SetColor(Color::White);
@@ -15,6 +19,12 @@ namespace Nz
 		SetSize(64.f, 64.f);
 	}
 
+	/*!
+	* \brief Constructs a Billboard object with a reference to a material
+	*
+	* \param material Reference to a material
+	*/
+
 	inline Billboard::Billboard(MaterialRef material)
 	{
 		SetColor(Color::White);
@@ -23,6 +33,12 @@ namespace Nz
 		SetSize(64.f, 64.f);
 	}
 
+	/*!
+	* \brief Constructs a Billboard object with a pointer to a texture
+	*
+	* \param texture Pointer to a texture
+	*/
+
 	inline Billboard::Billboard(Texture* texture)
 	{
 		SetColor(Color::White);
@@ -31,6 +47,12 @@ namespace Nz
 		SetTexture(texture, true);
 	}
 
+	/*!
+	* \brief Constructs a Billboard object by assignation
+	*
+	* \param billboard Billboard to copy into this
+	*/
+
 	inline Billboard::Billboard(const Billboard& billboard) :
 	InstancedRenderable(billboard),
 	m_color(billboard.m_color),
@@ -41,31 +63,61 @@ namespace Nz
 	{
 	}
 
+	/*!
+	* \brief Gets the color of the billboard
+	* \return Current color
+	*/
+
 	inline const Color& Billboard::GetColor() const
 	{
 		return m_color;
 	}
 
+	/*!
+	* \brief Gets the material of the billboard
+	* \return Current material
+	*/
+
 	inline const MaterialRef& Billboard::GetMaterial() const
 	{
 		return m_material;
 	}
 
+	/*!
+	* \brief Gets the rotation of the billboard
+	* \return Current rotation
+	*/
+
 	inline float Billboard::GetRotation() const
 	{
 		return m_rotation;
 	}
 
+	/*!
+	* \brief Gets the size of the billboard
+	* \return Current size
+	*/
+
 	inline const Vector2f& Billboard::GetSize() const
 	{
 		return m_size;
 	}
 
+	/*!
+	* \brief Sets the color of the billboard
+	*
+	* \param color Color for the billboard
+	*/
+
 	inline void Billboard::SetColor(const Color& color)
 	{
 		m_color = color;
 	}
 
+	/*!
+	* \brief Sets the default material of the billboard (just default material)
+	*/
+
 	inline void Billboard::SetDefaultMaterial()
 	{
 		MaterialRef material = Material::New();
@@ -75,6 +127,13 @@ namespace Nz
 		SetMaterial(std::move(material));
 	}
 
+	/*!
+	* \brief Sets the material of the billboard
+	*
+	* \param material Material for the billboard
+	* \param resizeBillboard Should billboard be resized to the material size (diffuse map)
+	*/
+
 	inline void Billboard::SetMaterial(MaterialRef material, bool resizeBillboard)
 	{
 		m_material = std::move(material);
@@ -86,25 +145,51 @@ namespace Nz
 		}
 	}
 
+	/*!
+	* \brief Sets the rotation of the billboard
+	*
+	* \param rotation Rotation for the billboard
+	*/
+
 	inline void Billboard::SetRotation(float rotation)
 	{
 		m_rotation = rotation;
 		m_sinCos.Set(std::sin(m_rotation), std::cos(m_rotation));
 	}
 
+	/*!
+	* \brief Sets the size of the billboard
+	*
+	* \param size Size for the billboard
+	*/
+
 	inline void Billboard::SetSize(const Vector2f& size)
 	{
 		m_size = size;
 
-		// On invalide la bounding box
+		// We invalidate the bounding volume
 		InvalidateBoundingVolume();
 	}
 
+	/*!
+	* \brief Sets the size of the billboard
+	*
+	* \param sizeX Size in X for the billboard
+	* \param sizeY Size in Y for the billboard
+	*/
+
 	inline void Billboard::SetSize(float sizeX, float sizeY)
 	{
 		SetSize(Vector2f(sizeX, sizeY));
 	}
 
+	/*!
+	* \brief Sets the texture of the billboard
+	*
+	* \param texture Texture for the billboard
+	* \param resizeBillboard Should billboard be resized to the texture size
+	*/
+
 	inline void Billboard::SetTexture(TextureRef texture, bool resizeBillboard)
 	{
 		if (!m_material)
@@ -118,6 +203,13 @@ namespace Nz
 		m_material->SetDiffuseMap(std::move(texture));
 	}
 
+	/*!
+	* \brief Sets the current billboard with the content of the other one
+	* \return A reference to this
+	*
+	* \param billboard The other Billboard
+	*/
+
 	inline Billboard& Billboard::operator=(const Billboard& billboard)
 	{
 		InstancedRenderable::operator=(billboard);
@@ -131,6 +223,13 @@ namespace Nz
 		return *this;
 	}
 
+	/*!
+	* \brief Creates a new billboard from the arguments
+	* \return A reference to the newly created billboard
+	*
+	* \param args Arguments for the billboard
+	*/
+
 	template<typename... Args>
 	BillboardRef Billboard::New(Args&&... args)
 	{