fix: Default samper state for models + serialization for getters/setters

Author: NicusorN5

3DRadSpace/3DRadSpace_Editor_WindowsDX11/Frontend/Windows/AboutWindow.cpp

@@ -75,7 +75,7 @@ void AboutWindow::_createControls()
 	_label = CreateWindowExA(
 		0,
 		"Static",
-		"3DRadSpace Editor\nVersion 0.1.0Alpha\n\nhttps:\\3dradspace.github.io\n\n\n\nThis software is licensed under MIT.",
+		"3DRadSpace Editor\nVersion 0.1.0Alpha\n\nhttps://3dradspace.github.io\n\n\n\nThis software is licensed under MIT.",
 		WS_VISIBLE | WS_CHILD | SS_CENTER,
 		220, 10, 200, 200,
 		window,

3DRadSpace/Engine3DRadSpace/Content/AssetID.hpp

@@ -10,15 +10,32 @@ namespace Engine3DRadSpace::Content
 	template<AssetType T>
 	struct AssetID
 	{
+		/// <summary>
+		/// Constructs an AssetID with an null identifier.
+		/// </summary>
 		AssetID() : ID(0) {};
+		/// <summary>
+		/// Constructs an AssetID with the specified identifier.
+		/// </summary>
+		/// <param name="id">Identifier of the asset.</param>
 		AssetID(unsigned id) : ID(id) {};
+
+		/// <summary>
+		/// Underlying unsigned identifier of the asset.
+		/// </summary>
 		unsigned ID;
 
+		/// <summary>
+		/// Gets the underlying unsigned identifier of the asset.
+		/// </summary>
 		operator unsigned() const noexcept
 		{
 			return ID;
 		}
 
+		/// <summary>
+		/// Type of the asset associated with this AssetID.
+		/// </summary>
 		using Type = T;
 	};
 }

3DRadSpace/Engine3DRadSpace/Content/Assets/Assets.hpp

@@ -1,7 +1,15 @@
 #pragma once
 #include "../ContentManager.hpp"
 
+/*
+	This header is not supposed to be included by the user as it is used internally when initializing content related services.
+*/
+
 namespace Engine3DRadSpace::Internal
 {
+	/// <summary>
+	/// Registers the default asset types with the content manager.
+	/// </summary>
+	/// <param name="manager">Pointer to the content manager.</param>
 	void E3DRSP_CONTENT_ASSETS_EXPORT RegisterDefaultTypes(Content::ContentManager* manager);
 }

3DRadSpace/Engine3DRadSpace/Content/ContentManager.hpp

@@ -6,7 +6,7 @@
 namespace Engine3DRadSpace::Content
 {
 	/// <summary>
-	/// 
+	/// Manages the lifetimes of all loaded assets.
 	/// </summary>
 	class E3DRSP_CONTENT_EXPORT ContentManager : public IService
 	{
@@ -123,6 +123,10 @@ namespace Engine3DRadSpace::Content
 		std::vector<AssetEntry> _assets;
 		IGame* _owner;
 	public:
+		/// <summary>
+		/// Constructs an instance of ContentManager.
+		/// </summary>
+		/// <param name="owner">Owner of this ContentManager.</param>
 		ContentManager(IGame* owner);
 
 		ContentManager(const ContentManager &) = delete;
@@ -131,33 +135,102 @@ namespace Engine3DRadSpace::Content
 		ContentManager &operator =(const ContentManager &) = delete;
 		ContentManager &operator =(ContentManager &&) noexcept = default;
 
+		/// <summary>
+		/// Registers an type T into this ContentManager.
+		/// </summary>
+		/// <typeparam name="T">Type that must satisfy the AssetType concept</typeparam>
+		/// <param name="dummy">Type dummy used for operator overloading</param>
 		template<AssetType T>
 		void RegisterType(Tag<T> dummy);
 
+		/// <summary>
+		/// Loads an asset of type T from the specified path.
+		/// </summary>
+		/// <typeparam name="T">Asset type.</typeparam>
+		/// <param name="path">Path on disk to the asset.</param>
+		/// <param name="refID">Optional reference ID to store the asset's ID.</param>
+		/// <returns>Pointer to the loaded asset.</returns>
 		template<AssetType T>
 		T* Load(const std::filesystem::path& path, AssetID<T>* refID = nullptr);
 
+		/// <summary>
+		/// Loads an asset of type T with additional constructor parameters.
+		/// </summary>
+		/// <typeparam name="...Args">Extra type arguments</typeparam>
+		/// <typeparam name="T">Asset type</typeparam>
+		/// <param name="path">Path on disk to the asset.</param>
+		/// <param name="refID">Optional reference ID to store the asset's ID.</param>
+		/// <param name="...params">Additional constructor parameters.</param>
+		/// <returns>Pointer to the loaded asset.</returns>
 		template<AssetType T, typename ...Args>
 		T* Load(const std::filesystem::path& path, AssetID<T>* refID, Args&& ...params);
 
+		/// <summary>
+		/// Type erased asset loading function.
+		/// </summary>
+		/// <param name="uuid">UUID of the asset type.</param>
+		/// <param name="path">Path on disk to the asset.</param>
+		/// <param name="refID">Optional reference ID to store the asset's ID.</param>
+		/// <returns>Pointer to the loaded asset.</returns>
 		IAsset* Load(const Reflection::UUID &uuid, const std::filesystem::path& path, unsigned* refID = nullptr);
 
+		/// <summary>
+		/// Reloads an asset by its reference ID.
+		/// </summary>
+		/// <param name="ref">Asset reference ID</param>
 		void Reload(unsigned ref);
 
+		/// <summary>
+		/// Returns an pointer to the asset of type T associated with the given reference ID.
+		/// </summary>
+		/// <typeparam name="T">Asset type</typeparam>
+		/// <param name="ref">Asset reference ID</param>
+		/// <returns>Pointer to the asset of type T</returns>
 		template<AssetType T>
 		T *operator[](AssetID<T> ref);
 
+		/// <summary>
+		/// Returns the path an asset with the specified ID was loaded from.
+		/// </summary>
+		/// <param name="id">Asset ID</param>
+		/// <returns>Path to the asset</returns>
 		std::filesystem::path GetAssetPath(unsigned id) const noexcept;
+		/// <summary>
+		/// Returns the type UUID of the specified asset ID.
+		/// </summary>
+		/// <param name="id">Asset ID</param>
+		/// <returns>Type UUID of the asset</returns>
 		Reflection::UUID GetAssetType(unsigned id) const noexcept;
+
+		/// <summary>
+		/// Returns the name of the specified asset ID.
+		/// </summary>
+		/// <param name="id">Asset ID</param>
+		/// <returns>Name of the asset</returns>
 		std::string GetAssetName(unsigned id) const noexcept;
 
 		std::vector<AssetEntry>::iterator begin();
 		std::vector<AssetEntry>::iterator end();
 
+		/// <summary>
+		/// Frees an asset from the ContentManager by its ID.
+		/// </summary>
+		/// <param name="id">Asset ID</param>
 		void RemoveAsset(unsigned id);
+		/// <summary>
+		/// Removes all assets from the ContentManager.
+		/// </summary>
 		void Clear();
 
+		/// <summary>
+		/// Returns the graphics device associated with this ContentManager.
+		/// </summary>
+		/// <returns>Pointer to the graphics device</returns>
 		Graphics::IGraphicsDevice* GetDevice() const noexcept;
+		/// <summary>
+		/// Returns the number of loaded assets in the ContentManager.
+		/// </summary>
+		/// <returns>Number of loaded assets</returns>
 		size_t Count() const noexcept;
 
 		~ContentManager() override = default;

3DRadSpace/Engine3DRadSpace/Graphics/Model3D.cpp

@@ -213,7 +213,8 @@ Model3D::Model3D(IGraphicsDevice* Device, const std::filesystem::path& path) :
 		}
 
 		mesh->Textures.push_back(std::move(diffuseTexture));
-		mesh->TextureSamplers.push_back(Device->CreateSamplerState());
+		mesh->TextureSamplers.push_back(Device->CreateSamplerState_AnisotropicWrap());
+		mesh->GetShaders()->operator[](0)->SetSampler(0, mesh->TextureSamplers[0].get());
 		meshParts.push_back(std::move(mesh));
 	}
 

3DRadSpace/Engine3DRadSpace/Math/Math.hpp

@@ -3,26 +3,81 @@
 
 namespace Engine3DRadSpace::Math
 {
+	/// <summary>
+	/// Converts degrees to radians.
+	/// </summary>
+	/// <typeparam name="T">Floating type</typeparam>
+	/// <param name="degrees">Angle in degrees</param>
+	/// <returns>Angle in radians</returns>
 	template<typename T> 
 	constexpr T ToRadians(T degrees)
 	{
 		return static_cast<T>(std::numbers::pi * degrees / 180);
 	}
 
+	/// <summary>
+	/// Converts radians to degrees.
+	/// </summary>
+	/// <typeparam name="T">Floating type</typeparam>
+	/// <param name="radians">Angle in radians</param>
+	/// <returns>Angle in degrees</returns>
 	template<typename T>
 	constexpr T ToDegrees(T radians)
 	{
 		return static_cast<T>(radians * 180 / std::numbers::pi);
 	}
 
+	/// <summary>
+	/// Performs a Catmull-Rom interpolation.
+	/// </summary>
+	/// <param name="value1">The first value.</param>
+	/// <param name="value2">The second value.</param>
+	/// <param name="value3">The third value.</param>
+	/// <param name="value4">The fourth value.</param>
+	/// <param name="amount">The interpolation amount.</param>
+	/// <returns>The interpolated value.</returns>
 	constexpr double E3DRSP_MATH_EXPORT CatmullRom(double value1, double value2, double value3, double value4, double amount);
+	/// <summary>
+	/// Performs a Hermite spline interpolation between two values with specified tangents.
+	/// </summary>
+	/// <param name="value1">The first value.</param>
+	/// <param name="tangent1">The tangent of the first value.</param>
+	/// <param name="value2">The second value.</param>
+	/// <param name="tangent2">The tangent of the second value.</param>
+	/// <param name="amount">The interpolation amount.</param>
+	/// <returns>The interpolated value.</returns>
 	constexpr double E3DRSP_MATH_EXPORT Hermite(double value1, double tangent1, double value2, double tangent2, double amount);
 
-	//Axis aligned check for one single axis.
+	/// <summary>
+	/// Axis aligned bounding box check for one single axis.
+	/// </summary>
+	/// <param name="p1">The position of the first box.</param>
+	/// <param name="w1">The width of the first box.</param>
+	/// <param name="p2">The position of the second box.</param>
+	/// <param name="w2">The width of the second box.</param>
+	/// <returns>True if the boxes overlap, false otherwise.</returns>
 	constexpr bool E3DRSP_MATH_EXPORT AABB(float p1, float w1, float p2, float w2);
-	//Axis aligned check for one single axis.
+
+	/// <summary>
+	/// Axis aligned bounding box check for one single axis.
+	/// </summary>
+	/// <param name="p1">The position of the first box.</param>
+	/// <param name="w1">The width of the first box.</param>
+	/// <param name="p2">The position of the second box.</param>
+	/// <param name="w2">The width of the second box.</param>
+	/// <returns>True if the boxes overlap, false otherwise.</returns>
 	constexpr bool E3DRSP_MATH_EXPORT AABB(double p1, double w1, double p2, double w2);
 
+	/// <summary>
+	/// Performs a smooth step interpolation between two values.
+	/// </summary>
+	/// <remarks>
+	/// Same as Hermite(value1, 0, value2, 0, result).
+	/// </remarks>
+	/// <param name="value1">The first value.</param>
+	/// <param name="value2">The second value.</param>
+	/// <param name="amount">The interpolation amount.</param>
+	/// <returns>The interpolated value.</returns>
 	constexpr double E3DRSP_MATH_EXPORT SmoothStep(double value1, double value2, double amount);
 
 	/// <summary>

3DRadSpace/Engine3DRadSpace/Objects/Impl/Box.cpp

@@ -74,8 +74,8 @@ Graphics::Primitives::Box* Box::GetPrimitive() const noexcept
 	return _box.get();
 }
 
-REFL_BEGIN(Box, "Box", "3D Primitives", "3D box")
-	REFL_FIELD(Box, std::string, Name, "Name", "Skinmesh", "Object's name")
+REFL_BEGIN(Box, "Box (AABB)", "3D Primitives", "3D box")
+	REFL_FIELD(Box, std::string, Name, "Name", "Box", "Object's name")
 	REFL_FIELD(Box, bool, Visible, "Visible", true, "Is the object visible?")
 	REFL_FIELD(Box, Vector3, Position, "Position", Vector3::Zero(), "Object's position in world space")
 	REFL_FIELD(Box, Vector3, Scale, "Scale", Vector3::One(), "Scale")