Add instance, skip extract, and debug settings (#73)

Author: dbierek

CMakeLists.txt

@@ -3,7 +3,7 @@ cmake_policy(SET CMP0141 NEW)
 set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "$<IF:$<CONFIG:Debug>,EditAndContinue,ProgramDatabase>" CACHE STRING "MSVC debug information format")
 project(
         NavKit
-        VERSION 2.5.3
+        VERSION 2.6.0
         DESCRIPTION "An app to create NAVP and AIRG files for use with Hitman: World of Assassination"
         LANGUAGES CXX)
 set(CMAKE_CXX_STANDARD 20)

README.md

@@ -3,11 +3,11 @@
 # How to Use
 The [NavKit Guide](https://glaciermodding.org/docs/modding/hitman/customcampaigns/using_navkit) is available on the [Glacier Modding Wiki](https://glaciermodding.org/).
 
-You can run NavKit by opening `NavKit.exe`. To use the **View Navp in game** and **Scene Extraction** features, you will need ZHMModSdk installed. For the **Scene Extraction** feature, you will also need to have Blender installed.
+You can run NavKit by opening `NavKit.exe`. To use the **Scene Extraction** feature, you will need ZHMModSdk installed. For the **Build Obj** and **Build Blend file** feature, you will also need to have Blender installed.
 
 You will also need to install the latest Visual C++ Redistributable from https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-140. Make sure you get the X64 version.
 
-Functions available are loading and saving Navp and Navp.json, loading Airg and Airg.json, loading and saving Obj, scene extraction, building Navp, building Airg and viewing navp in game.  
+Functions available are loading and saving Navp and Navp.json, loading Airg and Airg.json, loading and saving Obj, scene extraction, building Obj, building blend files, building Navp, and building Airg.  
 
 # Full generation of Navp and Airg (Scene Extraction, Navp generation, Airg generation)
 1. Download the latest release of NavKit (https://github.com/glacier-modding/NavKit/releases/latest) and run the installer

include/NavKit/NavKitConfig.h

@@ -1,3 +1,3 @@
 #define NavKit_VERSION_MAJOR "2"
-#define NavKit_VERSION_MINOR "5"
-#define NavKit_VERSION_PATCH "3"
+#define NavKit_VERSION_MINOR "6"
+#define NavKit_VERSION_PATCH "0"

include/NavKit/Resource.h

@@ -41,6 +41,7 @@
 #define IDM_BUILD_OBJ_FROM_SCENE                1500
 #define IDM_BUILD_OBJ_FROM_NAVP                 1501
 #define IDM_BUILD_BLEND_FROM_SCENE				1502
+#define IDM_BUILD_BLEND_AND_OBJ_FROM_SCENE  	1503
 #define IDM_BUILD_NAVP                          1510
 #define IDM_BUILD_AIRG                          1520
 #define IDM_HELP_ABOUT                          1600
@@ -140,3 +141,7 @@
 #define IDC_CHECK_PRIM_LOD_6                    30408
 #define IDC_CHECK_PRIM_LOD_7                    30409
 #define IDC_CHECK_PRIM_LOD_8                    30410
+#define IDC_RADIO_BUILD_TYPE_COPY               30411
+#define IDC_RADIO_BUILD_TYPE_INSTANCE           30412
+#define IDC_CHECK_SKIP_RPKG_EXTRACT             30413
+#define IDC_CHECK_SHOW_BLENDER_DEBUG_LOGS       30414

include/NavKit/module/Obj.h

@@ -12,6 +12,11 @@ enum MeshType {
     PRIM
 };
 
+enum SceneMeshBuildType {
+    INSTANCE,
+    COPY
+};
+
 class Obj {
     explicit Obj();
 
@@ -32,13 +37,13 @@ class Obj {
     bool showObj;
     bool loadObj;
     std::vector<std::string> files;
-    const std::string meshesFolder = "Obj";
     std::string objToLoad;
     std::vector<bool> objLoadDone;
     bool startedObjGeneration;
     bool blenderObjStarted;
     bool blenderObjGenerationDone;
-    bool blendFileOnlyExtract;
+    bool blendFileOnlyBuild;
+    bool blendFileAndObjBuild;
     bool glacier2ObjDebugLogsEnabled;
     bool errorBuilding;
     bool skipExtractingAlocsOrPrims;
@@ -48,6 +53,7 @@ class Obj {
     std::map<std::string, std::pair<int, int> > objectTriangleRanges;
     bool doObjHitTest;
     MeshType meshTypeForBuild;
+    SceneMeshBuildType sceneMeshBuildType;
     bool primLods[8];
     static HWND hObjDialog;
 
@@ -57,13 +63,15 @@ class Obj {
 
     void loadObjMesh();
 
+    void handleBuildBlendAndObjFromSceneClicked();
+
     static void copyObjFile(const std::string &from, const std::string &to);
 
     void saveObjMesh(char *objToCopy, char *newFileName);
 
     void buildObjFromNavp(bool alsoLoadIntoUi);
 
-    void buildObj();
+    void buildObjFromScene();
 
     void finalizeObjBuild();
 
@@ -81,13 +89,15 @@ class Obj {
 
     void handleSaveObjClicked();
 
-    bool canLoad() const;
+    [[nodiscard]] bool canLoad() const;
 
     static bool canBuildObjFromNavp();
 
-    bool canBuildObjFromScene() const;
+    [[nodiscard]] bool canBuildObjFromScene() const;
+
+    [[nodiscard]] bool canBuildBlendFromScene() const;
 
-    bool canBuildBlendFromScene() const;
+    [[nodiscard]] bool canBuildBlendAndObjFromScene() const;
 
     void handleBuildObjFromSceneClicked();
 

src/CMakeLists.txt

@@ -113,6 +113,7 @@ set(RUNTIME_FILE_DEPENDENCIES
         "${NavKit_SOURCE_DIR}/src/resource/DroidSans.ttf"
         "${NavKit_SOURCE_DIR}/src/resource/NavKit.ini"
         "${NavKit_SOURCE_DIR}/src/resource/Glacier2Obj.py"
+        "${NavKit_SOURCE_DIR}/src/resource/res.blend"
         "${NavKit_SOURCE_DIR}/bin/glacier2Obj.exe"
 )
 set(RUNTIME_FILE_DEPENDENCIES ${RUNTIME_FILE_DEPENDENCIES} PARENT_SCOPE)

src/NavKit.rc

@@ -32,7 +32,7 @@ BEGIN
         MENUITEM "&NavKit Settings",                         IDM_SETTINGS_NAVKIT
         MENUITEM "&Scene Settings",                          IDM_SETTINGS_SCENE
         MENUITEM "&Recast Settings",                         IDM_SETTINGS_RECAST
-        MENUITEM "&Obj Settings",                            IDM_SETTINGS_OBJ
+        MENUITEM "&Scene Mesh Settings",                     IDM_SETTINGS_OBJ
         MENUITEM "&Airg Settings",                           IDM_SETTINGS_AIRG
     END
     POPUP "&View"
@@ -77,6 +77,7 @@ BEGIN
         MENUITEM "Build &Airg from Navp",                    IDM_BUILD_AIRG
         MENUITEM SEPARATOR
         MENUITEM "Build Blend from &Scene"                   IDM_BUILD_BLEND_FROM_SCENE
+        MENUITEM "Build Blend and Obj from &Scene"           IDM_BUILD_BLEND_AND_OBJ_FROM_SCENE
     END
 
     POPUP "&Help"
@@ -251,9 +252,9 @@ BEGIN
     PUSHBUTTON      "Reset Defaults",IDC_BUTTON_RESET_DEFAULTS,188,490,65,14
 END
 
-IDD_OBJ_SETTINGS DIALOGEX 0, 0, 260, 150
+IDD_OBJ_SETTINGS DIALOGEX 0, 0, 260, 285
 STYLE DS_SETFONT | DS_FIXEDSYS | WS_POPUP | WS_CAPTION | WS_SYSMENU
-CAPTION "Obj Settings"
+CAPTION "Scene Mesh Settings"
 FONT 8, "MS Shell Dlg", 400, 0, 0x1
 BEGIN
     GROUPBOX        "Mesh Type for Build",IDC_STATIC,7,7,246,35
@@ -269,5 +270,16 @@ BEGIN
     AUTOCHECKBOX    "LOD 6", IDC_CHECK_PRIM_LOD_6, 84, 80, 50, 8
     AUTOCHECKBOX    "LOD 7", IDC_CHECK_PRIM_LOD_7, 84, 95, 50, 8
     AUTOCHECKBOX    "LOD 8", IDC_CHECK_PRIM_LOD_8, 84, 110, 50, 8
-    PUSHBUTTON      "Reset Defaults",IDC_BUTTON_RESET_DEFAULTS,188,130,65,14
+
+    GROUPBOX        "Build Type for Blender File",IDC_STATIC,7,135,246,35
+    CONTROL         "Copy",IDC_RADIO_BUILD_TYPE_COPY,"Button",BS_AUTORADIOBUTTON | WS_GROUP | WS_TABSTOP,14,150,40,10
+    CONTROL         "Instance",IDC_RADIO_BUILD_TYPE_INSTANCE,"Button",BS_AUTORADIOBUTTON,64,150,40,10
+
+    GROUPBOX        "Skip Aloc / Prim Extraction from RPKG files",IDC_STATIC,7,180,246,35
+    AUTOCHECKBOX    "Skip Extraction",IDC_CHECK_SKIP_RPKG_EXTRACT,14,195,80,10
+
+    GROUPBOX        "Show Blender Debug logs",IDC_STATIC,7,225,246,35
+    AUTOCHECKBOX    "Show Debug Logs",IDC_CHECK_SHOW_BLENDER_DEBUG_LOGS,14,240,80,10
+
+    PUSHBUTTON      "Reset Defaults",IDC_BUTTON_RESET_DEFAULTS,188,265,65,14
 END

src/module/Menu.cpp

@@ -105,6 +105,7 @@ void Menu::updateMenuState() {
     setMenuItemEnabled(IDM_BUILD_OBJ_FROM_SCENE, obj.canBuildObjFromScene());
     setMenuItemEnabled(IDM_BUILD_OBJ_FROM_NAVP, obj.canBuildObjFromNavp());
     setMenuItemEnabled(IDM_BUILD_BLEND_FROM_SCENE, obj.canBuildBlendFromScene());
+    setMenuItemEnabled(IDM_BUILD_BLEND_AND_OBJ_FROM_SCENE, obj.canBuildBlendAndObjFromScene());
 
     setMenuItemEnabled(IDM_EXTRACT_SCENE, sceneExtract.canExtractFromGame());
     setMenuItemEnabled(IDM_EXTRACT_SCENE_AND_BUILD_OBJ, sceneExtract.canExtractFromGameAndBuildObj());
@@ -250,6 +251,9 @@ int Menu::handleMenuClicked(const SDL_SysWMmsg *wmMsg) {
                 case IDM_BUILD_BLEND_FROM_SCENE:
                     obj.handleBuildBlendFromSceneClicked();
                     break;
+                case IDM_BUILD_BLEND_AND_OBJ_FROM_SCENE:
+                    obj.handleBuildBlendAndObjFromSceneClicked();
+                    break;
                 case IDM_BUILD_OBJ_FROM_SCENE:
                     obj.handleBuildObjFromSceneClicked();
                     break;