Update pan/orbit state icon (#11092)

mmisol · web-flow · commit 00024030b538 · 2020-09-02T17:32:10.000-04:00
Fixes issues related to the state of the pan icon not reflecting the
actual current state.

There were two problems preventing this from updating.

Some actions did not seem to trigger a property change on IsPlanning
and IsOrbiting at the BackgroundPreviewViewModel. There are properties
with the same name in the local view model that get updated more
consistently.

Some actions were triggering property change events in the wrong place.
These were moved to the right place.

While there were no reported issues with IsOrbiting, this property
should behave in the same way, so the same changes were applied.
diff --git a/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs b/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs
@@ -881,6 +881,7 @@ private void ModelWorkspaceCleared(WorkspaceModel workspace)
 
             // Reset workspace state
             CurrentSpaceViewModel.CancelActiveState();
+            BackgroundPreviewViewModel.RefreshState();
         }
 
         internal void ForceRunExprCmd(object parameters)
@@ -2441,12 +2442,7 @@ internal bool CanImportLibrary(object parameter)
         public void Escape(object parameter)
         {
             CurrentSpaceViewModel.CancelActiveState();
-
-            // Since panning and orbiting modes are exclusive from one another,
-            // turning one on may turn the other off. This is the reason we must
-            // raise property change for both at the same time to update visual.
-            RaisePropertyChanged("IsPanning");
-            RaisePropertyChanged("IsOrbiting");
+            BackgroundPreviewViewModel.RefreshState();
         }
 
         internal bool CanEscape(object parameter)
diff --git a/src/DynamoCoreWpf/ViewModels/Core/StateMachine.cs b/src/DynamoCoreWpf/ViewModels/Core/StateMachine.cs
@@ -575,8 +575,18 @@ private void SetCurrentState(State newState)
                         break;
                 }
 
+                var previousState = this.currentState;
                 owningWorkspace.CurrentCursor = CursorLibrary.GetCursor(cursorToUse);
                 this.currentState = newState; // update state
+
+                if (previousState == State.PanMode || newState == State.PanMode)
+                {
+                    owningWorkspace.RaisePropertyChanged(nameof(IsPanning));
+                }
+                if (previousState == State.OrbitMode || newState == State.OrbitMode)
+                {
+                    owningWorkspace.RaisePropertyChanged(nameof(IsOrbiting));
+                }
             }
 
             #endregion
diff --git a/src/DynamoCoreWpf/ViewModels/Watch3D/DefaultWatch3DViewModel.cs b/src/DynamoCoreWpf/ViewModels/Watch3D/DefaultWatch3DViewModel.cs
@@ -731,7 +731,11 @@ internal void CancelNavigationState()
         internal void TogglePan(object parameter)
         {
             CurrentSpaceViewModel.RequestTogglePanMode();
+            RefreshState();
+        }
 
+        internal void RefreshState()
+        {
             // Since panning and orbiting modes are exclusive from one another,
             // turning one on may turn the other off. This is the reason we must
             // raise property change for both at the same time to update visual.
@@ -748,13 +752,7 @@ private static bool CanTogglePan(object parameter)
         private void ToggleOrbit(object parameter)
         {
             CurrentSpaceViewModel.RequestToggleOrbitMode();
-
-            // Since panning and orbiting modes are exclusive from one another,
-            // turning one on may turn the other off. This is the reason we must
-            // raise property change for both at the same time to update visual.
-            RaisePropertyChanged("IsPanning");
-            RaisePropertyChanged("IsOrbiting");
-            RaisePropertyChanged("LeftClickCommand");
+            RefreshState();
         }
 
         private static bool CanToggleOrbit(object parameter)
@@ -799,6 +797,7 @@ protected virtual void ZoomToFit(object parameter)
 
         protected virtual void Dispose(bool disposing)
         {
+            // Nothing to do here.
         }
 
         public void Dispose()
diff --git a/src/DynamoCoreWpf/Views/Core/WorkspaceView.xaml b/src/DynamoCoreWpf/Views/Core/WorkspaceView.xaml
@@ -308,9 +308,8 @@
                              RelativeSource="{RelativeSource FindAncestor, AncestorType={x:Type controls:DynamoView}}" />
                 </ui:ImageCheckBox.Command>
                 <ui:ImageCheckBox.IsChecked>
-                    <Binding Path="DataContext.BackgroundPreviewViewModel.IsPanning"
-                             Mode="OneWay"
-                             RelativeSource="{RelativeSource FindAncestor, AncestorType={x:Type controls:DynamoView}}" />
+                    <Binding Path="IsPanning"
+                             Mode="OneWay" />
                 </ui:ImageCheckBox.IsChecked>
             </ui:ImageCheckBox>
 
@@ -325,9 +324,8 @@
                              RelativeSource="{RelativeSource FindAncestor, AncestorType={x:Type controls:DynamoView}}" />
                 </ui:ImageCheckBox.Command>
                 <ui:ImageCheckBox.IsChecked>
-                    <Binding Path="DataContext.BackgroundPreviewViewModel.IsOrbiting"
-                             Mode="OneWay"
-                             RelativeSource="{RelativeSource FindAncestor, AncestorType={x:Type controls:DynamoView}}" />
+                    <Binding Path="IsOrbiting"
+                             Mode="OneWay" />
                 </ui:ImageCheckBox.IsChecked>
                 <ui:ImageCheckBox.Visibility>
                     <Binding Path="DataContext.BackgroundPreviewViewModel.CanNavigateBackground"

Original file line number	Diff line number	Diff line change
`@@ -881,6 +881,7 @@ private void ModelWorkspaceCleared(WorkspaceModel workspace)`
`881`	`881`
`882`	`882`	`// Reset workspace state`
`883`	`883`	`CurrentSpaceViewModel.CancelActiveState();`
	`884`	`+ BackgroundPreviewViewModel.RefreshState();`
`884`	`885`	`}`
`885`	`886`
`886`	`887`	`internal void ForceRunExprCmd(object parameters)`
`@@ -2441,12 +2442,7 @@ internal bool CanImportLibrary(object parameter)`
`2441`	`2442`	`public void Escape(object parameter)`
`2442`	`2443`	`{`
`2443`	`2444`	`CurrentSpaceViewModel.CancelActiveState();`
`2444`		`-`
`2445`		`- // Since panning and orbiting modes are exclusive from one another,`
`2446`		`- // turning one on may turn the other off. This is the reason we must`
`2447`		`- // raise property change for both at the same time to update visual.`
`2448`		`- RaisePropertyChanged("IsPanning");`
`2449`		`- RaisePropertyChanged("IsOrbiting");`
	`2445`	`+ BackgroundPreviewViewModel.RefreshState();`
`2450`	`2446`	`}`
`2451`	`2447`
`2452`	`2448`	`internal bool CanEscape(object parameter)`
Original file line number	Diff line number	Diff line change
`@@ -731,7 +731,11 @@ internal void CancelNavigationState()`
`731`	`731`	`internal void TogglePan(object parameter)`
`732`	`732`	`{`
`733`	`733`	`CurrentSpaceViewModel.RequestTogglePanMode();`
	`734`	`+ RefreshState();`
	`735`	`+ }`
`734`	`736`
	`737`	`+ internal void RefreshState()`
	`738`	`+ {`
`735`	`739`	`// Since panning and orbiting modes are exclusive from one another,`
`736`	`740`	`// turning one on may turn the other off. This is the reason we must`
`737`	`741`	`// raise property change for both at the same time to update visual.`
`@@ -748,13 +752,7 @@ private static bool CanTogglePan(object parameter)`
`748`	`752`	`private void ToggleOrbit(object parameter)`
`749`	`753`	`{`
`750`	`754`	`CurrentSpaceViewModel.RequestToggleOrbitMode();`
`751`		`-`
`752`		`- // Since panning and orbiting modes are exclusive from one another,`
`753`		`- // turning one on may turn the other off. This is the reason we must`
`754`		`- // raise property change for both at the same time to update visual.`
`755`		`- RaisePropertyChanged("IsPanning");`
`756`		`- RaisePropertyChanged("IsOrbiting");`
`757`		`- RaisePropertyChanged("LeftClickCommand");`
	`755`	`+ RefreshState();`
`758`	`756`	`}`
`759`	`757`
`760`	`758`	`private static bool CanToggleOrbit(object parameter)`
`@@ -799,6 +797,7 @@ protected virtual void ZoomToFit(object parameter)`
`799`	`797`
`800`	`798`	`protected virtual void Dispose(bool disposing)`
`801`	`799`	`{`
	`800`	`+ // Nothing to do here.`
`802`	`801`	`}`
`803`	`802`
`804`	`803`	`public void Dispose()`