Light culling and draw frustum

Light culling now works. It is a camera option. When a camera is
selected its frustum is now drawn

Author: Adrien GIVRY

Sources/Overload/OvCore/include/OvCore/ECS/Components/CCamera.h

@@ -59,6 +59,18 @@ namespace OvCore::ECS::Components
 		*/
 		void SetClearColor(const OvMaths::FVector3& p_clearColor);
 
+		/**
+		* Defines if the camera should apply frustum geometry culling in rendering
+		* @param p_enable
+		*/
+		void SetFrustumGeometryCulling(bool p_enable);
+
+		/**
+		* Defines if the camera should apply frustum light culling in rendering
+		* @param p_enable
+		*/
+		void SetFrustumLightCulling(bool p_enable);
+
 		/**
 		* Returns the fov of the camera
 		*/
@@ -79,6 +91,16 @@ namespace OvCore::ECS::Components
 		*/
 		const OvMaths::FVector3& GetClearColor() const;
 
+		/**
+		* Returns true if the frustum geometry culling is enabled
+		*/
+		bool HasFrustumGeometryCulling() const;
+
+		/**
+		* Returns true if the frustum light culling is enabled
+		*/
+		bool HasFrustumLightCulling() const;
+
 		/**
 		* Returns the OvRendering camera instance attached to this component
 		*/

Sources/Overload/OvCore/include/OvCore/ECS/Components/CModelRenderer.h

@@ -21,6 +21,17 @@ namespace OvCore::ECS::Components
 	class API_OVCORE CModelRenderer : public AComponent
 	{
 	public:
+		/**
+		* Defines how the model renderer bounding sphere should be interpreted
+		*/
+		enum class EFrustumBehaviour
+		{
+			DISABLED = 0,
+			CULL_MODEL = 1,
+			CULL_MESHES = 2,
+			CULL_CUSTOM = 3
+		};
+
 		/**
 		* Constructor
 		* @param p_owner
@@ -43,6 +54,28 @@ namespace OvCore::ECS::Components
 		*/
 		OvRendering::Resources::Model* GetModel() const;
 
+		/**
+		* Sets a bounding mode
+		* @param p_boundingMode
+		*/
+		void SetFrustumBehaviour(EFrustumBehaviour p_boundingMode);
+
+		/**
+		* Returns the current bounding mode
+		*/
+		EFrustumBehaviour GetFrustumBehaviour() const;
+
+		/**
+		* Returns the custom bounding sphere
+		*/
+		const OvRendering::Geometry::BoundingSphere& GetCustomBoundingSphere() const;
+
+		/**
+		* Sets the custom bounding sphere
+		* @param p_boundingSphere
+		*/
+		void SetCustomBoundingSphere(const OvRendering::Geometry::BoundingSphere& p_boundingSphere);
+
 		/**
 		* Serialize the component
 		* @param p_doc
@@ -66,5 +99,7 @@ namespace OvCore::ECS::Components
 	private:
 		OvRendering::Resources::Model* m_model = nullptr;
 		OvTools::Eventing::Event<> m_modelChangedEvent;
+		OvRendering::Geometry::BoundingSphere m_customBoundingSphere = { {}, 1.0f };
+		EFrustumBehaviour m_frustumBehaviour = EFrustumBehaviour::CULL_MODEL;
 	};
 }

Sources/Overload/OvCore/include/OvCore/ECS/Renderer.h

@@ -52,31 +52,60 @@ namespace OvCore::ECS
 		/**
 		* Fill the given FMatrix4 vector with lights information
 		* @param p_scene
-		* @param p_out
 		*/
-		void FindLightMatrices(const OvCore::SceneSystem::Scene& p_scene, std::vector<OvMaths::FMatrix4>& p_out);
+		std::vector<OvMaths::FMatrix4> FindLightMatrices(const OvCore::SceneSystem::Scene& p_scene);
+
+		/**
+		* Fill the given FMatrix4 vector with lights information that are inside the frustum
+		* @param p_scene
+		* @param p_frustum
+		*/
+		std::vector<OvMaths::FMatrix4> FindLightMatricesInFrustum(const OvCore::SceneSystem::Scene& p_scene, const OvRendering::Data::Frustum& p_frustum);
 
 		/**
 		* Draw the given scene using the given default material (optional) if no material found on an actor
 		* @param p_scene
 		* @param p_cameraPosition
-		* @param p_frustum
+		* @param p_camera
+		* @param p_customFrustum
 		* @param p_defaultMaterial
 		*/
-		void RenderScene(OvCore::SceneSystem::Scene& p_scene, const OvMaths::FVector3& p_cameraPosition, OvRendering::Data::Frustum const* p_frustum = nullptr, Resources::Material* p_defaultMaterial = nullptr);
+		void RenderScene
+		(
+			OvCore::SceneSystem::Scene& p_scene,
+			const OvMaths::FVector3& p_cameraPosition,
+			const OvRendering::LowRenderer::Camera& p_camera,
+			const OvRendering::Data::Frustum* p_customFrustum = nullptr,
+			OvCore::Resources::Material* p_defaultMaterial = nullptr
+		);
 
 		/**
-		* Find every drawables objects in the scene. Sorting order:
-		* - Opaques (Front to back)
-		* - Transparents (Back to front)
-		* @param p_opaques
-		* @param p_transparents
+		* Returns opaque and transparents drawables from the scene with frustum culling
 		* @param p_scene
 		* @param p_cameraPosition
 		* @param p_frustum
 		* @param p_defaultMaterial
 		*/
-		void FindAndSortDrawables(OpaqueDrawables& p_opaques, TransparentDrawables& p_transparents, const OvCore::SceneSystem::Scene& p_scene, const OvMaths::FVector3& p_cameraPosition, OvRendering::Data::Frustum const* p_frustum = nullptr, Resources::Material* p_defaultMaterial = nullptr);
+		std::pair<OpaqueDrawables, TransparentDrawables> FindAndSortFrustumCulledDrawables
+		(
+			const OvCore::SceneSystem::Scene& p_scene,
+			const OvMaths::FVector3& p_cameraPosition,
+			const OvRendering::Data::Frustum& p_frustum,
+			OvCore::Resources::Material* p_defaultMaterial
+		);
+
+		/**
+		* Returns opaque and transparents drawables from the scene
+		* @param p_scene
+		* @param p_cameraPosition
+		* @param p_defaultMaterial
+		*/
+		std::pair<OpaqueDrawables, TransparentDrawables> FindAndSortDrawables
+		(
+			const OvCore::SceneSystem::Scene& p_scene,
+			const OvMaths::FVector3& p_cameraPosition,
+			OvCore::Resources::Material* p_defaultMaterial
+		);
 
 		/**
 		* Draw a Drawable instance

Sources/Overload/OvCore/src/OvCore/ECS/Components/CCamera.cpp

@@ -50,6 +50,16 @@ void OvCore::ECS::Components::CCamera::SetFar(float p_value)
 	m_camera.SetFar(p_value);
 }
 
+void OvCore::ECS::Components::CCamera::SetFrustumGeometryCulling(bool p_enable)
+{
+	m_camera.SetFrustumGeometryCulling(p_enable);
+}
+
+void OvCore::ECS::Components::CCamera::SetFrustumLightCulling(bool p_enable)
+{
+	m_camera.SetFrustumLightCulling(p_enable);
+}
+
 float OvCore::ECS::Components::CCamera::GetFov() const
 {
 	return m_camera.GetFov();
@@ -70,11 +80,21 @@ const OvMaths::FVector3 & OvCore::ECS::Components::CCamera::GetClearColor() cons
 	return m_camera.GetClearColor();
 }
 
+bool OvCore::ECS::Components::CCamera::HasFrustumGeometryCulling() const
+{
+	return m_camera.HasFrustumGeometryCulling();
+}
+
 void OvCore::ECS::Components::CCamera::SetClearColor(const OvMaths::FVector3 & p_clearColor)
 {
 	m_camera.SetClearColor(p_clearColor);
 }
 
+bool OvCore::ECS::Components::CCamera::HasFrustumLightCulling() const
+{
+	return m_camera.HasFrustumLightCulling();
+}
+
 OvRendering::LowRenderer::Camera & OvCore::ECS::Components::CCamera::GetCamera()
 {
 	return m_camera;
@@ -86,14 +106,18 @@ void OvCore::ECS::Components::CCamera::OnSerialize(tinyxml2::XMLDocument & p_doc
 	OvCore::Helpers::Serializer::SerializeFloat(p_doc, p_node, "near", m_camera.GetNear());
 	OvCore::Helpers::Serializer::SerializeFloat(p_doc, p_node, "far", m_camera.GetFar());
 	OvCore::Helpers::Serializer::SerializeVec3(p_doc, p_node, "clear_color", m_camera.GetClearColor());
+	OvCore::Helpers::Serializer::SerializeBoolean(p_doc, p_node, "frustum_geometry_culling", m_camera.HasFrustumGeometryCulling());
+	OvCore::Helpers::Serializer::SerializeBoolean(p_doc, p_node, "frustum_light_culling", m_camera.HasFrustumLightCulling());
 }
 
 void OvCore::ECS::Components::CCamera::OnDeserialize(tinyxml2::XMLDocument & p_doc, tinyxml2::XMLNode * p_node)
 {
 	m_camera.SetFov(OvCore::Helpers::Serializer::DeserializeFloat(p_doc, p_node, "fov"));
 	m_camera.SetNear(OvCore::Helpers::Serializer::DeserializeFloat(p_doc, p_node, "near"));
 	m_camera.SetFar(OvCore::Helpers::Serializer::DeserializeFloat(p_doc, p_node, "far"));
-	SetClearColor(OvCore::Helpers::Serializer::DeserializeVec3(p_doc, p_node, "clear_color"));
+	m_camera.SetClearColor(OvCore::Helpers::Serializer::DeserializeVec3(p_doc, p_node, "clear_color"));
+	m_camera.SetFrustumGeometryCulling(OvCore::Helpers::Serializer::DeserializeBoolean(p_doc, p_node, "frustum_geometry_culling"));
+	m_camera.SetFrustumLightCulling(OvCore::Helpers::Serializer::DeserializeBoolean(p_doc, p_node, "frustum_light_culling"));
 }
 
 void OvCore::ECS::Components::CCamera::OnInspector(OvUI::Internal::WidgetContainer& p_root)
@@ -102,4 +126,6 @@ void OvCore::ECS::Components::CCamera::OnInspector(OvUI::Internal::WidgetContain
 	OvCore::Helpers::GUIDrawer::DrawScalar<float>(p_root, "Near", std::bind(&CCamera::GetNear, this), std::bind(&CCamera::SetNear, this, std::placeholders::_1));
 	OvCore::Helpers::GUIDrawer::DrawScalar<float>(p_root, "Far", std::bind(&CCamera::GetFar, this), std::bind(&CCamera::SetFar, this, std::placeholders::_1));
 	OvCore::Helpers::GUIDrawer::DrawColor(p_root, "Clear color", [this]() {return reinterpret_cast<const OvUI::Types::Color&>(GetClearColor()); }, [this](OvUI::Types::Color p_color) { SetClearColor({ p_color.r, p_color.g, p_color.b }); }, false);
+	OvCore::Helpers::GUIDrawer::DrawBoolean(p_root, "Frustum Geometry Culling", std::bind(&CCamera::HasFrustumGeometryCulling, this), std::bind(&CCamera::SetFrustumGeometryCulling, this, std::placeholders::_1));
+	OvCore::Helpers::GUIDrawer::DrawBoolean(p_root, "Frustum Light Culling", std::bind(&CCamera::HasFrustumLightCulling, this), std::bind(&CCamera::SetFrustumLightCulling, this, std::placeholders::_1));
 }

Sources/Overload/OvCore/src/OvCore/ECS/Components/CModelRenderer.cpp

@@ -5,8 +5,12 @@
 */
 
 #include <OvUI/Widgets/Texts/Text.h>
+#include <OvUI/Widgets/Texts/TextColored.h>
 #include <OvUI/Plugins/DDTarget.h>
 #include <OvUI/Widgets/Visual/Image.h>
+#include <OvUI/Widgets/Selection/ComboBox.h>
+#include <OvUI/Widgets/Selection/CheckBox.h>
+#include <OvUI/Widgets/Drags/DragFloat.h>
 
 #include "OvCore/Global/ServiceLocator.h"
 #include "OvCore/ResourceManagement/TextureManager.h"
@@ -41,17 +45,71 @@ OvRendering::Resources::Model * OvCore::ECS::Components::CModelRenderer::GetMode
 	return m_model;
 }
 
+void OvCore::ECS::Components::CModelRenderer::SetFrustumBehaviour(EFrustumBehaviour p_boundingMode)
+{
+	m_frustumBehaviour = p_boundingMode;
+}
+
+OvCore::ECS::Components::CModelRenderer::EFrustumBehaviour OvCore::ECS::Components::CModelRenderer::GetFrustumBehaviour() const
+{
+	return m_frustumBehaviour;
+}
+
+const OvRendering::Geometry::BoundingSphere& OvCore::ECS::Components::CModelRenderer::GetCustomBoundingSphere() const
+{
+	return m_customBoundingSphere;
+}
+
+void OvCore::ECS::Components::CModelRenderer::SetCustomBoundingSphere(const OvRendering::Geometry::BoundingSphere& p_boundingSphere)
+{
+	m_customBoundingSphere = p_boundingSphere;
+}
+
 void OvCore::ECS::Components::CModelRenderer::OnSerialize(tinyxml2::XMLDocument & p_doc, tinyxml2::XMLNode * p_node)
 {
 	OvCore::Helpers::Serializer::SerializeModel(p_doc, p_node, "model", m_model);
+	OvCore::Helpers::Serializer::SerializeInt(p_doc, p_node, "frustum_behaviour", reinterpret_cast<int&>(m_frustumBehaviour));
+	OvCore::Helpers::Serializer::SerializeVec3(p_doc, p_node, "custom_bounding_sphere_position", m_customBoundingSphere.position);
+	OvCore::Helpers::Serializer::SerializeFloat(p_doc, p_node, "custom_bounding_sphere_radius", m_customBoundingSphere.radius);
 }
 
 void OvCore::ECS::Components::CModelRenderer::OnDeserialize(tinyxml2::XMLDocument & p_doc, tinyxml2::XMLNode* p_node)
 {
 	OvCore::Helpers::Serializer::DeserializeModel(p_doc, p_node, "model", m_model);
+	OvCore::Helpers::Serializer::DeserializeInt(p_doc, p_node, "frustum_behaviour", reinterpret_cast<int&>(m_frustumBehaviour));
+	OvCore::Helpers::Serializer::DeserializeVec3(p_doc, p_node, "custom_bounding_sphere_position", m_customBoundingSphere.position);
+	OvCore::Helpers::Serializer::DeserializeFloat(p_doc, p_node, "custom_bounding_sphere_radius", m_customBoundingSphere.radius);
 }
 
 void OvCore::ECS::Components::CModelRenderer::OnInspector(OvUI::Internal::WidgetContainer& p_root)
 {
-	OvCore::Helpers::GUIDrawer::DrawMesh(p_root, "Model", m_model, &m_modelChangedEvent);
+	using namespace OvCore::Helpers;
+
+	GUIDrawer::DrawMesh(p_root, "Model", m_model, &m_modelChangedEvent);
+
+	GUIDrawer::CreateTitle(p_root, "Frustum Culling Behaviour");
+	auto& boundingMode = p_root.CreateWidget<OvUI::Widgets::Selection::ComboBox>(0);
+	boundingMode.choices.emplace(0, "Disabled");
+	boundingMode.choices.emplace(1, "Cull model");
+	boundingMode.choices.emplace(2, "Cull model & sub-meshes");
+	boundingMode.choices.emplace(3, "Cull custom bounding sphere");
+	auto& boundingModeDispatcher = boundingMode.AddPlugin<OvUI::Plugins::DataDispatcher<int>>();
+	boundingModeDispatcher.RegisterReference(reinterpret_cast<int&>(m_frustumBehaviour));
+
+	auto& centerLabel = p_root.CreateWidget<OvUI::Widgets::Texts::TextColored>("Bounding Sphere Center", GUIDrawer::TitleColor);
+	auto& centerWidget = p_root.CreateWidget<OvUI::Widgets::Drags::DragMultipleScalars<float, 3>>(GUIDrawer::GetDataType<float>(), GUIDrawer::_MIN_FLOAT, GUIDrawer::_MAX_FLOAT, 0.f, 0.05f, "", GUIDrawer::GetFormat<float>());
+	auto& centerDispatcher = centerWidget.AddPlugin<OvUI::Plugins::DataDispatcher<std::array<float, 3>>>();
+	centerDispatcher.RegisterReference(reinterpret_cast<std::array<float, 3>&>(m_customBoundingSphere.position));
+
+	auto& radiusLabel = p_root.CreateWidget<OvUI::Widgets::Texts::TextColored>("Bounding Sphere Radius", GUIDrawer::TitleColor);
+	auto& radiusWidget = p_root.CreateWidget<OvUI::Widgets::Drags::DragFloat>(0.0f, GUIDrawer::_MAX_FLOAT, 0.f, 0.1f);
+	auto& radiusDispatcher = radiusWidget.AddPlugin<OvUI::Plugins::DataDispatcher<float>>();
+	radiusDispatcher.RegisterReference(m_customBoundingSphere.radius);
+
+	boundingMode.ValueChangedEvent += [&](int p_choice)
+	{
+		centerLabel.enabled = centerWidget.enabled = radiusLabel.enabled = radiusWidget.enabled = p_choice == 3;
+	};
+
+	centerLabel.enabled = centerWidget.enabled = radiusLabel.enabled = radiusWidget.enabled = m_frustumBehaviour == EFrustumBehaviour::CULL_CUSTOM;
 }