v0.3.1 - Doodad wireframe display ability

CMakeLists.txt

@@ -300,6 +300,13 @@ add_subdirectory("${QUARTZ_SOURCE_DIR}/scene/light")
 add_subdirectory("${QUARTZ_SOURCE_DIR}/scene/scene")
 add_subdirectory("${QUARTZ_SOURCE_DIR}/scene/sky_box")
 
+#====================================================================
+# Tooling
+#====================================================================
+
+include(CreateToolExecutable)
+add_subdirectory("${QUARTZ_ROOT_SOURCE_DIR}/tools")
+
 #====================================================================
 # The tests
 #====================================================================

cmake/CreateScratchExecutable.cmake

@@ -1,5 +1,5 @@
 #====================================================================
-# Functionality for easily creating scratch unit tests
+# Functionality for easily creating scratch tests
 #====================================================================
 
 function(create_scratch_executable main_file)

cmake/CreateToolExecutable.cmake

@@ -0,0 +1,19 @@
+#====================================================================
+# Functionality for easily creating tooling executables tests
+#====================================================================
+
+function(create_tool_executable main_file)
+    get_filename_component(executable_name ${main_file} NAME_WE)
+    add_executable(${executable_name} ${main_file})
+
+    target_compile_definitions(${executable_name} PRIVATE ${QUARTZ_COMPILE_DEFINITIONS})
+    target_compile_options(${executable_name} PRIVATE ${QUARTZ_CMAKE_CXX_FLAGS})
+    target_include_directories(${executable_name} PRIVATE ${QUARTZ_INCLUDE_DIRS})
+
+    set(link_libraries ${ARGN})
+
+    target_link_libraries(${executable_name} PRIVATE ${link_libraries} UTIL_Logger)
+
+    set_target_properties(${executable_name} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/tools)
+endfunction()
+

cmake/QuartzVersion.cmake

@@ -3,15 +3,9 @@
 # ====================================================================
 
 function(set_quartz_major_minor_patch_versions major minor patch)
-    set(QUARTZ_MAJOR_VERSION
-      ${major}
-      PARENT_SCOPE)
-    set(QUARTZ_MINOR_VERSION
-      ${minor}
-      PARENT_SCOPE)
-    set(QUARTZ_PATCH_VERSION
-      ${patch}
-      PARENT_SCOPE)
+    set(QUARTZ_MAJOR_VERSION ${major} PARENT_SCOPE)
+    set(QUARTZ_MINOR_VERSION ${minor} PARENT_SCOPE)
+    set(QUARTZ_PATCH_VERSION ${patch} PARENT_SCOPE)
 endfunction()
 
 # -----=====***** the versions *****=====----- #
@@ -47,9 +41,11 @@ endfunction()
 # set_quartz_major_minor_patch_versions(0 2 11) # scene libarary fixes
 # set_quartz_major_minor_patch_versions(0 2 12) # fixes for linux
 # set_quartz_major_minor_patch_versions(0 2 13) # RichException implementation and usage
-# set_quartz_major_minor_patch_versions(0 2 14) # Custom source_location and mocked stacktrace for Mac so we can still use rich exceptions
+# set_quartz_major_minor_patch_versions(0 2 14) # custom source_location and mocked stacktrace for Mac so we can still use rich exceptions
 
 # Minor Version 3 - Scene Debugging Capabilities
 
-set_quartz_major_minor_patch_versions(0 3 0) # Enable Quartz to enter a debugging mode
+# set_quartz_major_minor_patch_versions(0 3 0) # enable Quartz to enter a debugging mode
+# set_quartz_major_minor_patch_versions(0 3 1) # allow for wireframe display of doodads when in scene debugging mode
+set_quartz_major_minor_patch_versions(0 3 2) # allow for display of box colliders when in scene debugging mode
 

src/quartz/application/Application.cpp

@@ -40,7 +40,7 @@ quartz::Application::Application(
     m_isPaused(false),
     m_sceneDebugMode(false),
     m_wireframeDoodadMode(false),
-    m_wireframeColliderMode(false)
+    m_displayColliderMode(false)
 {
     LOG_FUNCTION_CALL_TRACEthis("");
 }
@@ -103,7 +103,7 @@ void quartz::Application::run() {
         double frameInterpolationFactor = (frameTimeAccumulator + targetTickTimeDelta) / targetTickTimeDelta;
 
         currentScene.update(m_renderingContext.getRenderingWindow(), m_inputManager, totalElapsedTime, currentFrameTimeDelta, frameInterpolationFactor);
-        m_renderingContext.draw(currentScene, m_wireframeDoodadMode, m_wireframeColliderMode);
+        m_renderingContext.draw(currentScene, m_wireframeDoodadMode, m_displayColliderMode);
     }
 
     LOG_INFOthis("Unloading scene");
@@ -158,7 +158,7 @@ quartz::Application::determineSceneDebugMode(
 
     if (!m_sceneDebugMode) {
         m_wireframeDoodadMode = false;
-        m_wireframeColliderMode = false;
+        m_displayColliderMode = false;
         return;
     }
 
@@ -168,7 +168,7 @@ quartz::Application::determineSceneDebugMode(
     }
 
     if (shouldToggleWireframeColliderMode) {
-        m_wireframeColliderMode = !m_wireframeColliderMode;
-        LOG_INFOthis("{} collider wireframe mode", (m_wireframeColliderMode ? "Entering" : "Exiting"));
+        m_displayColliderMode = !m_displayColliderMode;
+        LOG_INFOthis("{} collider wireframe mode", (m_displayColliderMode ? "Entering" : "Exiting"));
     }
 }

src/quartz/application/Application.hpp

@@ -43,7 +43,7 @@ class quartz::Application {
 
     bool getSceneDebugMode() const { return m_sceneDebugMode; }
     bool getWireframeDoodadMode() const { return m_wireframeDoodadMode; }
-    bool getWireframeColliderMode() const { return m_wireframeColliderMode; }
+    bool getWireframeColliderMode() const { return m_displayColliderMode; }
 
     void run();
 
@@ -75,7 +75,7 @@ class quartz::Application {
 
     bool m_sceneDebugMode;
     bool m_wireframeDoodadMode;
-    bool m_wireframeColliderMode;
+    bool m_displayColliderMode;
 
 private: // friends
     friend class quartz::unit_test::ApplicationUnitTestClient;

src/quartz/physics/collider/Collider.cpp

@@ -13,6 +13,7 @@
 #include "quartz/physics/collider/SphereShape.hpp"
 #include "quartz/physics/collider/Collider.hpp"
 
+uint32_t quartz::physics::Collider::colliderCount = 0;
 std::map<reactphysics3d::Collider*, quartz::physics::Collider*> quartz::physics::Collider::colliderMap;
 
 quartz::physics::Collider::CollisionType
@@ -71,6 +72,7 @@ quartz::physics::Collider::Collider(
     const quartz::physics::Collider::CollisionCallback& collisionStayCallback,
     const quartz::physics::Collider::CollisionCallback& collisionEndCallback
 ) :
+    m_id(quartz::physics::Collider::colliderCount++),
     mo_boxShape(
         (std::holds_alternative<quartz::physics::BoxShape>(v_shape)) ?
             std::optional<quartz::physics::BoxShape>{std::get<quartz::physics::BoxShape>(std::move(v_shape))} :
@@ -87,13 +89,14 @@ quartz::physics::Collider::Collider(
     m_collisionEndCallback(collisionEndCallback ? collisionEndCallback : quartz::physics::Collider::noopCollisionCallback)
 {
     LOG_FUNCTION_SCOPE_TRACEthis("");
-    LOG_TRACEthis("Constructing Collider. Setting collider map rp3d pointer at {} to point to quartz pointer at {}", reinterpret_cast<void*>(mp_collider), reinterpret_cast<void*>(this));
+    LOG_TRACEthis("Constructing Collider {}. Setting collider map rp3d pointer at {} to point to quartz pointer at {}", m_id, reinterpret_cast<void*>(mp_collider), reinterpret_cast<void*>(this));
     quartz::physics::Collider::colliderMap[mp_collider] = this;
 }
 
 quartz::physics::Collider::Collider(
     quartz::physics::Collider&& other
 ) :
+    m_id(other.m_id),
     mo_boxShape(std::move(other.mo_boxShape)),
     mo_sphereShape(std::move(other.mo_sphereShape)),
     mp_collider(std::move(other.mp_collider)),
@@ -102,7 +105,7 @@ quartz::physics::Collider::Collider(
     m_collisionEndCallback(std::move(other.m_collisionEndCallback))
 {
     LOG_FUNCTION_SCOPE_TRACEthis("");
-    LOG_TRACEthis("Move-constructing Collider. Setting collider map rp3d pointer at {} to point to quartz pointer at {}", reinterpret_cast<void*>(mp_collider), reinterpret_cast<void*>(this));
+    LOG_TRACEthis("Move-constructing Collider {}. Setting collider map rp3d pointer at {} to point to quartz pointer at {}", m_id, reinterpret_cast<void*>(mp_collider), reinterpret_cast<void*>(this));
     quartz::physics::Collider::colliderMap[mp_collider] = this;
 }
 

src/quartz/physics/collider/Collider.hpp

@@ -110,6 +110,7 @@ class quartz::physics::Collider {
 
     quartz::physics::Collider::CategoryProperties getCategoryProperties() const;
 
+    uint32_t getId() const { return m_id; }
     bool getIsTrigger() const;
     math::Vec3 getLocalPosition() const;
     math::Quaternion getLocalRotation() const;
@@ -145,9 +146,12 @@ class quartz::physics::Collider {
     static void eraseCollider(reactphysics3d::Collider* const p_collider) { quartz::physics::Collider::colliderMap.erase(p_collider); }
 
 private: // static variables
+    static uint32_t colliderCount; 
     static std::map<reactphysics3d::Collider*, quartz::physics::Collider*> colliderMap;
 
 private: // member variables
+    const uint32_t m_id;
+
     std::optional<quartz::physics::BoxShape> mo_boxShape;
     std::optional<quartz::physics::SphereShape> mo_sphereShape;
 

src/quartz/rendering/buffer/LocallyMappedBuffer.hpp

@@ -28,6 +28,7 @@ class quartz::rendering::LocallyMappedBuffer {
     USE_LOGGER(BUFFER_MAPPED);
 
     const vk::UniqueBuffer& getVulkanLogicalBufferPtr() const { return mp_vulkanLogicalBuffer; }
+    const vk::UniqueDeviceMemory& getVulkanPhysicalDeviceMemoryPtr() const { return mp_vulkanPhysicalDeviceMemory; }
     void* getMappedLocalMemoryPtr() { return mp_mappedLocalMemory; }
 
 private: // static functions
@@ -45,4 +46,5 @@ class quartz::rendering::LocallyMappedBuffer {
     vk::UniqueBuffer mp_vulkanLogicalBuffer;
     vk::UniqueDeviceMemory mp_vulkanPhysicalDeviceMemory;
     void* mp_mappedLocalMemory;
-};
+};
+

src/quartz/rendering/context/CMakeLists.txt

@@ -21,12 +21,14 @@ target_compile_options(
 
 target_compile_definitions(
     QUARTZ_RENDERING_Context
-    PUBLIC ${QUARTZ_COMPILE_DEFINITIONS}
+    PUBLIC
+    ${QUARTZ_COMPILE_DEFINITIONS}
 )
 
 target_compile_definitions(
-        QUARTZ_RENDERING_Context
-        PUBLIC ${QUARTZ_COMPILE_DEFINITIONS}
+    QUARTZ_RENDERING_Context
+    PUBLIC
+    ${QUARTZ_COMPILE_DEFINITIONS}
 )
 
 target_link_libraries(
@@ -57,3 +59,4 @@ target_link_libraries(
     QUARTZ_SCENE_Light
     QUARTZ_SCENE_Scene
 )
+