Merge pull request #378 from pro3d-space/features/updateSbmOnLocateSurfaces

Issue #244 On locate surfaces, update SurfaceModel in sequenced bookmarks

Author: haraldsteinlechner

.config/dotnet-tools.json

@@ -21,7 +21,7 @@
       ]
     },
     "fantomas": {
-      "version": "6.1.1",
+      "version": "6.2.3",
       "commands": [
         "fantomas"
       ]

src/PRo3D.Core/PRo3D.Core.fsproj

@@ -60,6 +60,7 @@
     <Compile Include="Drawing\PackedRendering.fs" />
     <Compile Include="Drawing\Drawing-App.fs" />
     <Compile Include="SequencedBookmarks\SequencedBookmarks-Model.fs" />
+    <Compile Include="SequencedBookmarks\SequencedBookmark.fs" />
     <Compile Include="SequencedBookmarks\BookmarkUtils.fs" />
     <Compile Include="SequencedBookmarks\BookmarkAnimations.fs" />
     <Compile Include="SequencedBookmarks\SequencedBookmarksApp.fs" />

src/PRo3D.Core/SequencedBookmarks/BookmarkUtils.fs

@@ -20,6 +20,10 @@ open Aether
 open Aether.Operators
 
 module BookmarkUtils =
+    /// Returns a path to a folder with the same name as the scene file,
+    /// which lies inside the same folder as the scene file.
+    /// This path is used to store sequenced bookmarks as individual files
+    /// when saving the scene.
     let basePathFromScenePath (scenePath : string) =
         Path.combine [Path.GetDirectoryName scenePath; 
                         Path.GetFileNameWithoutExtension scenePath]
@@ -171,8 +175,12 @@ module BookmarkUtils =
     let updatePath (basePath : string) (bm : SequencedBookmark) =
         match bm with
         | SequencedBookmark.LoadedBookmark loaded ->
-            Log.line "Updating sequenced bookmark base path from %s to %s"
-                (string loaded.basePath) basePath
+            match loaded.basePath with
+            | Some oldBasePath ->
+                if not (oldBasePath = basePath) then
+                    Log.line "[BookmarkUtils] Updating sequenced bookmark base path from %s to %s"
+                             (string oldBasePath) basePath
+            | None -> ()
             SequencedBookmark.LoadedBookmark {loaded with basePath = Some basePath}
         | SequencedBookmarks.NotYetLoaded notLoaded ->
             let newPath = Path.combine [basePath;Path.GetFileName notLoaded.path]
@@ -189,13 +197,42 @@ module BookmarkUtils =
             HashMap.map (fun g bm -> updatePath basePath bm) m.bookmarks
         {m with bookmarks = bookmarks}
 
+    /// Checks the given folder sceneBasePath for 
+    /// sequenced bookmark files, and deletes all files that do
+    /// not have a corresponding bookmark in bookmarks.
+    /// Should be used when saving a scene to clean up saved bookmarks
+    /// that were deleted in the viewer.
+    let cleanUpOldBookmarks (sceneBasePath  : string) 
+                            (bookmarks      : SequencedBookmarks) =    
+        let files = Directory.GetFiles sceneBasePath
+        for filePath in files do
+            let bmGuid = 
+                SequencedBookmark.guidFromFilename filePath           
+            let guidExists =
+                bmGuid
+                |> Option.map (fun guid ->
+                    HashMap.containsKey guid bookmarks.bookmarks) 
+            match guidExists with
+            | Some true ->
+                ()
+            | _ ->
+                Log.line "[BookmarkUtils] Cleaning up old bookmarks %s" 
+                            filePath
+                try 
+                    File.Delete filePath
+                with e ->
+                    Log.line "[BookmarkUtils] Could not clean up old bookmark %s" filePath
+
     /// updates the paths of all bookmarks and
     /// saves bookmarks to file system
     let saveSequencedBookmarks (basePath:string) 
-                               (bookmarks : SequencedBookmarks) =      
+                               (bookmarks : SequencedBookmarks) =    
+        let bookmarks = loadAll bookmarks                               
         let bookmarks = updatePaths basePath bookmarks
         if not (Directory.Exists basePath) then
             Directory.CreateDirectory basePath |> ignore
+        else // if the folder exists, clean up and delete all old bookmarks
+            cleanUpOldBookmarks basePath bookmarks
 
         for guid, bm in bookmarks.bookmarks do
             match bm with

src/PRo3D.Core/SequencedBookmarks/SequencedBookmark.fs

@@ -0,0 +1,48 @@
+namespace PRo3D.Core
+
+open Aardvark.Base
+open Aardvark.UI
+open System
+open System.IO
+open PRo3D.Core.SequencedBookmarks
+
+open Aether
+open Aether.Operators
+
+module SequencedBookmark =
+    let filenameIsSequencedBookmark (filename : string) =
+        let nameNoPath = Path.GetFileName filename 
+        let startsWithPrefix = 
+            String.startsWith 
+                SequencedBookmarkDefaults.filenamePrefix 
+                nameNoPath
+        let ending = 
+            SequencedBookmarkDefaults.filenamePostfix 
+                + SequencedBookmarkDefaults.filenameExtension
+        let containsPostfix = 
+            String.contains ending nameNoPath
+        startsWithPrefix && containsPostfix
+
+    /// Extracts the guid from the filename of a sequenced bookmark.
+    let guidFromFilename (filename : string) =
+        let isProperName = filenameIsSequencedBookmark filename
+        if isProperName then
+            let nameNoPathNoExt = Path.GetFileNameWithoutExtension filename
+            let guidString =
+                nameNoPathNoExt 
+                |> String.replace SequencedBookmarkDefaults.filenamePrefix ""
+                |> String.replace SequencedBookmarkDefaults.filenamePostfix ""
+            let (success, guid) = System.Guid.TryParse guidString
+            if success 
+            then Some guid
+            else None
+        else None
+
+    let update (m : SequencedBookmarkModel) (msg : SequencedBookmarkAction) =
+        match msg with
+        | SetName name ->
+            {m with bookmark = {m.bookmark with name = name}}
+        | SetDelay msg ->
+            {m with delay = Numeric.update m.delay msg}
+        | SetDuration msg ->
+            {m with duration = Numeric.update m.duration msg}

src/PRo3D.Core/SequencedBookmarks/SequencedBookmarks-Model.fs

@@ -13,6 +13,7 @@ open Chiron
 open System.Text.Json
 open Aether
 open Aether.Operators
+open System.Text.RegularExpressions
 
 /// used to set whether all recorded frames should be used
 /// for batch rendering, or half
@@ -194,6 +195,11 @@ type SceneState =
             (fun (self : SceneState) -> self.stateConfig), 
             (fun (value) (self : SceneState) -> { self with stateConfig = value })
         )
+    static member surfaces_ =
+        (
+            (fun (self : SceneState) -> self.stateSurfaces), 
+            (fun (value) (self : SceneState) -> { self with stateSurfaces = value })
+        )
     static member frustum_ =
         SceneState.stateConfig_
             >-> SceneStateViewConfig.frustumModel_ 
@@ -381,6 +387,8 @@ type SequencedBookmarkModel = {
         SequencedBookmarkModel._sceneState >?> SceneState.focalLength_
     static member _stateConfig =
         SequencedBookmarkModel._sceneState >?> SceneState.stateConfig_
+    static member _surfaces =
+        SequencedBookmarkModel._sceneState >?> SceneState.surfaces_
     static member _bookmark =
         (
             (fun (self : SequencedBookmarkModel) -> self.bookmark), 
@@ -394,24 +402,12 @@ type SequencedBookmarkModel = {
         this.bookmark.cameraView
     member this.name =
         this.bookmark.name
-    member this.path =
-        match this.basePath with
-        | Some basePath ->
-            Path.combine 
-                [
-                    basePath
-                    this.filename
-                ]
-        | None ->
-            //Log.warn "[SequencedBookmarks] Bookmark has no basePath." //debugging
-            this.filename
-
-    member this.filename =
-        sprintf "%s_%s.pro3d.sbm" "SBookmark" (this.key |> string)
-
-
 
 module SequencedBookmarkDefaults =
+    let filenamePrefix = "SBookmark_"
+    let filenamePostfix = ".pro3d"
+    let filenameExtension = ".sbm"
+
     let initSmoothing value =
         {
             value   = value
@@ -494,6 +490,18 @@ module SequencedBookmarkModel =
         }
 
 type SequencedBookmarkModel with
+    member this.filename =
+        sprintf "%s%s%s%s" 
+            SequencedBookmarkDefaults.filenamePrefix
+            (this.key |> string) 
+            SequencedBookmarkDefaults.filenamePostfix
+            SequencedBookmarkDefaults.filenameExtension
+    member this.path =
+        match this.basePath with
+        | Some basePath ->
+            Path.combine [basePath;this.filename]
+        | None ->
+            this.filename
     static member FromJson( _ : SequencedBookmarkModel) =
         json {
             let! v = Json.read "version"
@@ -596,7 +604,7 @@ module SequencedBookmark =
                         |> Json.deserialize
                 Some loadedBookmark
             with e ->
-                Log.error "Error Loading Bookmark %s" m.path
+                Log.error "[SequencedBookmarks] Error Loading Bookmark %s" m.path
                 Log.error "%s" e.Message
                 None
         | SequencedBookmark.LoadedBookmark m ->

src/PRo3D.Core/SequencedBookmarks/SequencedBookmarksApp.fs

@@ -20,17 +20,6 @@ open PRo3D.Core.BookmarkAnimations
 open Aether
 open Aether.Operators
 
-module SequencedBookmark =
-
-    let update (m : SequencedBookmarkModel) (msg : SequencedBookmarkAction) =
-        match msg with
-        | SetName name ->
-            {m with bookmark = {m.bookmark with name = name}}
-        | SetDelay msg ->
-            {m with delay = Numeric.update m.delay msg}
-        | SetDuration msg ->
-            {m with duration = Numeric.update m.duration msg}
-
 module AnimationSettings =
     let update (m : AnimationSettings) (msg : AnimationSettingsAction)  =
         match msg with
@@ -55,14 +44,36 @@ module AnimationSettings =
            let smoothingFactor = Numeric.update m.smoothingFactor msg
            {m with smoothingFactor = smoothingFactor}
 
-
-
 module SequencedBookmarksApp = 
     let mutable (snapshotProcess : option<System.Diagnostics.Process>) = None
 
     let outputPath (m : SequencedBookmarks) = 
         Path.combine [m.outputPath;"batchRendering.json"]
 
+    let applytoAllBookmarks (f : (SequencedBookmarkModel -> SequencedBookmarkModel))
+                            (m : SequencedBookmarks) =
+        let bookmarks = 
+            m.bookmarks 
+            |> HashMap.map (fun id bm ->
+                match bm with
+                | SequencedBookmark.LoadedBookmark loadedBm ->
+                    let bm = f loadedBm
+                    SequencedBookmark.LoadedBookmark bm
+                | SequencedBookmark.NotYetLoaded notLoadedBm ->
+                    match SequencedBookmark.tryLoad bm with
+                    | Some bm -> 
+                        let bm = f bm
+                        SequencedBookmark.LoadedBookmark bm
+                    | None ->
+                        bm)
+        {m with bookmarks = bookmarks}
+
+    let withSurfaceModel (surfaceModel : SurfaceModel)
+                         (m : SequencedBookmarks) =
+        let f bm = 
+            Optic.set SequencedBookmarkModel._surfaces surfaceModel.surfaces bm
+        applytoAllBookmarks f m
+
     let update 
         (m                : SequencedBookmarks) 
         (act              : SequencedBookmarksAction) 

src/PRo3D.Core/Surface/SurfaceApp.fs

@@ -769,9 +769,16 @@ module SurfaceApp =
                         | false -> None
                     )
                     |> List.choose( fun np -> np) 
-                match newPath.IsEmpty with
-                | true -> s
-                | false -> { s with importPath = newPath.Head } 
+                match newPath with
+                | [] -> 
+                    Log.line "[SurfaceApp] No correct path found in %s" (selectedPaths |> String.concat ";")
+                    s
+                | pathsHead::pathsTail -> 
+                    let names = Files.getOPCNames pathsHead   
+                    { s with importPath = pathsHead
+                             opcPaths   = names |> Files.expandNamesToPaths pathsHead
+                             
+                    } 
             )
 
         let flat' = 

src/PRo3D.Viewer/Scene.fs

@@ -85,11 +85,9 @@ module SceneLoader =
             let sequencedBookmarks = 
                 let basePath = PRo3D.Core.BookmarkUtils.basePathFromScenePath p
                 BookmarkUtils.updatePaths basePath m.sequencedBookmarks
-            { m with surfacesModel = { m.surfacesModel with surfaces = sm }
+            { m with surfacesModel      = { m.surfacesModel with surfaces = sm }
                      sequencedBookmarks = sequencedBookmarks
             }
-
-            
         | None -> m        
 
     let private readLine (filePath:string) =

src/PRo3D.Viewer/Viewer/Viewer.fs

@@ -556,16 +556,30 @@ module ViewerApp =
 
             let model = { m with scene = { m.scene with surfacesModel = s}; animations = animation}
 
-            let surfaceModel = 
+            let model =
                 match msg with
                 | SurfaceAppAction.ChangeImportDirectories _ 
                 | SurfaceAppAction.ChangeOBJImportDirectories _ ->
-                    model.scene.surfacesModel 
-                    |> SceneLoader.prepareSurfaceModel runtime signature model.scene.scenePath
+                    let surfacesModel = 
+                        model.scene.surfacesModel 
+                        |> SceneLoader.prepareSurfaceModel 
+                            runtime signature model.scene.scenePath
+                    let model =
+                        Optic.set _surfacesModel surfacesModel model
+                    let sequencedBookmarks = 
+                        match m.scene.sequencedBookmarks.bookmarks.IsEmpty with
+                        | true ->
+                            m.scene.sequencedBookmarks
+                        | false ->                            
+                            SequencedBookmarksApp.withSurfaceModel 
+                                surfacesModel model.scene.sequencedBookmarks
+                    let model =
+                        Optic.set _sequencedBookmarks sequencedBookmarks model
+                    model
                 | _ -> 
-                    model.scene.surfacesModel
-
-            { model with scene = { model.scene with surfacesModel = surfaceModel} }
+                    model
+            model
+            
         | AnnotationMessage msg,_,_ ->                
             match m.drawing.annotations.singleSelectLeaf with
             | Some selected ->