Merge pull request #760 from rpatters1/RGP/add-full-artic-reset

more complete articulation reset

Author: rpatters1

src/articulation_reset_auto_positioning.lua

@@ -1,8 +1,8 @@
 function plugindef()
     finaleplugin.Author = "Robert Patterson"
     finaleplugin.Copyright = "CC0 https://creativecommons.org/publicdomain/zero/1.0/"
-    finaleplugin.Version = "1.0.1"
-    finaleplugin.Date = "February 28, 2020"
+    finaleplugin.Version = "1.1"
+    finaleplugin.Date = "July 29, 2024"
     finaleplugin.CategoryTags = "Articulation"
     finaleplugin.MinFinaleVersionRaw = 0x1a000000
     finaleplugin.MinJWLuaVersion = 0.58
@@ -13,9 +13,12 @@ Due to complications arising from how Finale stored articulation positions befor
 Due to issues around maintaining the context for automatic stacking, it must be run under RGP Lua. JW Lua does not have the necessary
 logic to manage the stacking context.
     ]]
-    return "Reset Automatic Articulation Positions", "Reset Automatic Articulation Positions", "Resets the position of automatically positioned articulations while ignoring those with manual positioning."
+    return "Reset Automatic Articulation Positions", "Reset Automatic Articulation Positions",
+        "Resets the position of automatically positioned articulations while ignoring those with manual positioning."
 end
 
+local articulation = require("library/articulation")
+
 -- Before Finale 26, the automatic positioning of articulations was calculated by Finale and stored as the default offset
 -- values of the assignment. Starting with Finale 26, the automatic positioning of articulations is inherent in the
 -- coded behavior of Finale. The assignment only contains offsets from the default position. Therefore, resetting
@@ -26,22 +29,24 @@ end
 function articulation_reset_auto_positioning()
     for note_entry in eachentry(finenv.Region()) do
         local articulations = note_entry:CreateArticulations()
-        for articulation in each(articulations) do
+        for artic_assign in each(articulations) do
             local articulation_def = finale.FCArticulationDef()
-            if articulation_def:Load(articulation.ID) then
+            if articulation_def:Load(artic_assign.ID) then
                 local do_save = false
                 if articulation_def.CenterHorizontally then
-                    articulation.HorizontalPos = 0
+                    artic_assign.HorizontalPos = 0
                     do_save = true
                 end
                 if finale.ARTPOS_MANUAL_POSITIONING ~= articulation_def.AutoPosSide then
-                    local save_horzpos = articulation.HorizontalPos
-                    articulation:ResetPos(articulation_def) -- use ResetPos to fix up Finale's internal stacking flags
-                    articulation.HorizontalPos = save_horzpos
+                    local save_horzpos = artic_assign.HorizontalPos
+                    local save_flip = artic_assign.PlacementMode
+                    articulation.reset_to_default(artic_assign, articulation_def) -- use reset_to_default to fix up Finale's internal stacking flags
+                    artic_assign.HorizontalPos = save_horzpos
+                    artic_assign.PlacementMode = save_flip
                     do_save = true
                 end
                 if do_save then
-                    articulation:Save()
+                    artic_assign:Save()
                 end
             end
         end

src/articulation_reset_positioning.lua

@@ -1,8 +1,8 @@
 function plugindef()
     finaleplugin.Author = "Robert Patterson"
     finaleplugin.Copyright = "CC0 https://creativecommons.org/publicdomain/zero/1.0/"
-    finaleplugin.Version = "1.0.1"
-    finaleplugin.Date = "February 28, 2020"
+    finaleplugin.Version = "1.1"
+    finaleplugin.Date = "July 29, 2024"
     finaleplugin.CategoryTags = "Articulation"
     finaleplugin.MinFinaleVersionRaw = 0x1a000000
     finaleplugin.MinJWLuaVersion = 0.58
@@ -16,6 +16,8 @@ logic to manage the stacking context.
     return "Reset Articulation Positions", "Reset Articulation Positions", "Resets the position of all selected articulations."
 end
 
+local articulation = require("library/articulation")
+
 -- Before Finale 26, the automatic positioning of articulations was calculated by Finale and stored as the default offset
 -- values of the assignment. Starting with Finale 26, the automatic positioning of articulations is inherent in the
 -- coded behavior of Finale. The assignment only contains offsets from the default position. Therefore, resetting
@@ -27,10 +29,9 @@ end
 function articulation_reset_positioning()
     for note_entry in eachentry(finenv.Region()) do
         local articulations = note_entry:CreateArticulations()
-        for articulation in each(articulations) do
-            local artic_def = articulation:CreateArticulationDef()
-            articulation:ResetPos(artic_def)
-            articulation:Save()
+        for artic_assign in each(articulations) do
+            articulation.reset_to_default(artic_assign)
+            artic_assign:Save()
         end
     end
 end

src/library/articulation.lua

@@ -71,4 +71,22 @@ function articulation.calc_main_character_dimensions(artic_def)
     return text_mets:CalcWidthEVPUs(), text_mets:CalcHeightEVPUs()
 end
 
+--[[
+% reset_to_default
+
+Implements all calls necessary to reset the articulation to default positioning. These settings achieve
+the same result as hitting the Clear key for the Articulation in the Finale UI.
+
+@artic (FCArticulation)
+@artic_def (FCArticulationDef) optional definition for this articulation (calculated if not supplied)
+]]
+
+function articulation.reset_to_default(artic, artic_def)
+    artic_def = artic_def or artic:CreateArticulationDef()
+    artic.StackingMode = finale.ARTICSTACKING_USEDEFINITION
+    artic.PlacementMode = finale.ARTICPLACEMENT_AUTOMATIC
+    artic:ResetPos(artic_def)
+end
+
+
 return articulation