writing documentation

Author: ShumWengSang

Perspective/CMakeLists.txt

@@ -2,9 +2,11 @@ cmake_minimum_required(VERSION 3.17)
 project(Perspective)
 option(BUILD_ANIMATION "Build Animation" ON)
 set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
+set_property(GLOBAL PROPERTY USE_FOLDERS ON)
+# set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
+# set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
+# set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
+
 
 add_subdirectory(Source/deps/)
 
@@ -37,7 +39,6 @@ message("Sources ${SOURCES}")
 add_executable(Perspective ${SOURCES} ${SHADER_CROSS_SOURCES} ${EXT_SOURCES} )
 
 
-
 source_group("Source" FILES ${SOURCES})
 source_group("Cross Shaders" FILES ${SHADER_CROSS_SOURCES})
 
@@ -53,12 +54,32 @@ target_link_libraries(Perspective PRIVATE glm_static)
 target_link_libraries(Perspective PRIVATE tinyobjloader)
 target_link_libraries(Perspective PRIVATE assimp)
 
-set_target_properties( assimp
-    PROPERTIES
+# Set Perspective, assimp, and glfw output to the bin directory
+set_target_properties(assimp glfw Perspective PROPERTIES
     ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
     LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
     RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin"
-)
+    )
+
+################ Macro to retrieve all targets #####################
+function(get_all_targets var)
+    set(targets)
+    get_all_targets_recursive(targets ${CMAKE_CURRENT_SOURCE_DIR})
+    set(${var} ${targets} PARENT_SCOPE)
+endfunction()
+
+macro(get_all_targets_recursive targets dir)
+    get_property(subdirectories DIRECTORY ${dir} PROPERTY SUBDIRECTORIES)
+    foreach(subdir ${subdirectories})
+        get_all_targets_recursive(${targets} ${subdir})
+    endforeach()
+
+    get_property(current_targets DIRECTORY ${dir} PROPERTY BUILDSYSTEM_TARGETS)
+    list(APPEND ${targets} ${current_targets})
+endmacro()
+###############################################################
+
+
 
 target_precompile_headers(Perspective PRIVATE "Source/src/stdafx.cpp")
 
@@ -71,4 +92,10 @@ if(MSVC)
     target_link_options(Perspective  PUBLIC /incremental PUBLIC /debug:fastlink)
     set_property(TARGET Perspective PROPERTY VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}")
     set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT Perspective)
+    
+    # Now we can put all targets into nice folders for msvc
+    get_all_targets(all_targets)
+    message("All targets: ${all_targets}")
+    list(REMOVE_ITEM all_targets "Perspective")
+    set_target_properties(${all_targets} PROPERTIES FOLDER "External")
 endif()

Perspective/Common/anim_allAnim_01.fbx

@@ -0,0 +1,114 @@
+# Advanced Animation CS460 Assignment 1
+### Student: Roland Shum
+### Professor: Prof Xin Li
+
+# Assignment Objectives
+(1) Modelling:
+* Loading of .fbx model 
+  * Imported ASSIMP library
+  * https://github.com/assimp/assimp
+  * Library has known issues with fbx files, so untested models may break
+* Imported animation using .fbx files 
+  * Using ASSIMP library again
+* Used node tree to graph bones
+  * Used my own implementation of Quaternion and VQS
+  * Used VQS concatenation to transform spaces
+
+(2) Animation:
+* Read key frames and interpolate between keyframes for animation
+* Implemented Lerp, Slerp, ELerp
+  * Demonstrated and used in exe
+* Implemented iSlerp and iVQS
+  * iSlerp is used and demonstrated in build
+  * iVQS proved very troublesome to showcase as it requires preprocessing of each frame 
+    * ASSIMP gives a [position, timestamp], [rotation, timestamp], and [scale, timestamp] for each bone
+    * To properly use iVQS I would need to
+      * At each timestamp regardless of position, rotation or scale
+      * Record the [position, rotation or scale]
+      * Interpolate the other two elements to find the right values for them
+      * Insert into keyframe
+    * This proved too long to do 
+* Incremental approaches run at 60 FPS, while others run at a variadic rate
+
+# How to Build:
+* Run prepackaged file "RunCMake.bat" which will 
+  * Run the packaged portable cmake
+    * cmake will generate the visual studio solution
+  * Open VS solution
+  * Build + Run
+
+# Instructions / Controls:
+* **[WASD] camera movement**
+* **[Hold Right Mouse button + Drag] to rotate camera**
+* Rendering speed of ~110 FPS on my laptop
+* Modify ImGui GUI at will to make things nice and simple
+  * There are GUI controls in the ImGui meant for showcasing different lerp
+  * GUI controls for selecting which animation to play
+
+
+# High Level Explanation
+* Framework modified from previous CS class
+  * That is why it uses a CMake pipeline
+  * Has deferred and forward rendering for OpenGL
+* Relevant files for grading:
+  * Project: Perspective
+    * CS460AssignmentOne.cpp 
+      * Main entry point to the scene
+    * Bone.cpp
+      * Abstracts a bone 
+      * **Interpolation functions for bones are called here**
+    * Model.cpp
+      * Holds multiple meshes
+      * Loads meshes from assimp
+      * Loads vertex data
+    * Quaternions.cpp
+      * **My implementation of quaternions**
+      * **My implementation of VQS**
+    * Main.cpp
+      * Holds test cases for VQS and quaternion implementation
+    * Animation.cpp
+      * Holds a specific animation reel loaded from ASSIMP
+    * Animator.cpp
+      * Holds a pointer to the current animation playing
+      * Updates that animation 
+    * MyMath.cpp
+      * Holds implemntation for 
+        * Lerp
+        * Slerp
+          * Slight modification to slerp 
+            * When alpha < 0.0f
+              * It swaps around one of the quaternions for correct interpolation
+            * When alpha is close to 1.0f
+              * Use Lerp to avoid side effects of flipping
+        * iLerp
+        * iSlerp
+        * eLerp
+  * Shaders
+    * shader/material/Phong_Animated.vert.glsl
+      * Skinning
+      * VQS sent to shaders via UBO
+      * VQS conversion to mat4 
+
+# Developed on
+Windows:
+
+    OS: Windows NT 10.0.18362.0
+
+    Host: GIGABYTE AERO 15WV8
+
+    CPU: Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz
+          
+    GPU: Intel(R) UHD Graphics 630 NVIDIA GeForce GTX 1060
+
+    OpenGL version: 4.6 NVIDIA 451.67
+
+    Visual Studio 2019 Preview 
+    
+    Windows SDK version : 10.0.18362.0
+
+
+
+
+
+
+

Perspective/Common/anim_roll_01.fbx

@@ -2,10 +2,11 @@
 
 set BUILD_CONFIG=%1
 set BUILD_DIR=%2
+set CMAKE_EXE="tools\\cmake\\bin\\cmake.exe"
 
 IF NOT DEFINED BUILD_CONFIG (SET BUILD_CONFIG="RelWithDebInfo") 
 IF NOT DEFINED BUILD_DIR (SET BUILD_DIR="vsbuild") 
 
-cmake -G "Visual Studio 16 2019" -A x64 -S . -B %BUILD_DIR%
+%CMAKE_EXE% -G "Visual Studio 16 2019" -A x64 -S . -B %BUILD_DIR%
 
 

Perspective/Readme.md

@@ -20,9 +20,6 @@
 #include "FinalPass.h"
 #include "ForwardRendering.h"
 #include "DebugDraw.h"
-#include <assimp/Importer.hpp>      // C++ importer interface
-#include <assimp/scene.h>           // Output data structure
-#include <assimp/postprocess.h>     // Post processing flags
 #include "Model.h"
 #include "TransformSystem.h"
 #include "Animation.h"
@@ -188,6 +185,4 @@ void CS460AssignmentOne::Draw(const Input &input, float deltaTime, float running
             ImGui::TreePop();
         }
     }
-
-
 }