Delete Object Keyboard Shortcut (#388)

* #46 Define function to `handleRemoveObject` * #46 Bring `handleRemoveObject` in commands * `Ctrl` + `X` keybinding to remove object * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add handling if no object is selected * `[Delete]` Keybinding & Enable it on ObjectTree too * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
jupytercad · Jul 30, 2024 · fb39912 · fb39912
1 parent 0e44856
commit fb39912
Show file tree

Hide file tree

Showing 4 changed files with 119 additions and 41 deletions.
diff --git a/packages/base/src/commands.ts b/packages/base/src/commands.ts
@@ -9,6 +9,7 @@ import {
   ISelection,
   Parts
 } from '@jupytercad/schema';
+import { CommandRegistry } from '@lumino/commands';
 import { JupyterFrontEnd } from '@jupyterlab/application';
 import { showErrorMessage, WidgetTracker } from '@jupyterlab/apputils';
 import { ITranslator } from '@jupyterlab/translation';
@@ -33,9 +34,11 @@ import {
   chamferIcon,
   filletIcon
 } from './tools';
+import keybindings from './keybindings.json';
 import { JupyterCadPanel, JupyterCadWidget } from './widget';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { PathExt } from '@jupyterlab/coreutils';
+import { handleRemoveObject } from './panelview';
 
 export function newName(type: string, model: IJupyterCadModel): string {
   const sharedModel = model.sharedModel;
@@ -638,6 +641,22 @@ const EXPORT_FORM = {
   }
 };
 
+function loadKeybindings(commands: CommandRegistry, keybindings: any[]) {
+  keybindings.forEach(binding => {
+    commands.addKeyBinding({
+      command: binding.command,
+      keys: binding.keys,
+      selector: binding.selector
+    });
+  });
+}
+
+function getSelectedObjectId(widget: JupyterCadWidget): string {
+  const selected =
+    widget.context.model.sharedModel.awareness.getLocalState()?.selected;
+  return selected ? Object.keys(selected.value)[0] : '';
+}
+
 /**
  * Add the FreeCAD commands to the application's command registry.
  */
@@ -714,6 +733,31 @@ export function addCommands(
     }
   });
 
+  commands.addCommand(CommandIDs.removeObject, {
+    label: trans.__('Remove Object'),
+    isEnabled: () => {
+      const current = tracker.currentWidget;
+      return current ? current.context.model.sharedModel.editable : false;
+    },
+    execute: () => {
+      const current = tracker.currentWidget;
+      if (!current) {
+        return;
+      }
+
+      const objectId = getSelectedObjectId(current);
+      if (!objectId) {
+        console.warn('No object is selected.');
+        return;
+      }
+      const sharedModel = current.context.model.sharedModel;
+
+      handleRemoveObject(objectId, sharedModel, () =>
+        sharedModel.awareness.setLocalStateField('selected', {})
+      );
+    }
+  });
+
   commands.addCommand(CommandIDs.newBox, {
     label: trans.__('New Box'),
     isEnabled: () => {
@@ -953,6 +997,7 @@ export function addCommands(
       await dialog.launch();
     }
   });
+  loadKeybindings(commands, keybindings);
 }
 
 /**
@@ -964,6 +1009,8 @@ export namespace CommandIDs {
 
   export const newSketch = 'jupytercad:sketch';
 
+  export const removeObject = 'jupytercad:removeObject';
+
   export const newBox = 'jupytercad:newBox';
   export const newCylinder = 'jupytercad:newCylinder';
   export const newSphere = 'jupytercad:newSphere';

diff --git a/packages/base/src/keybindings.json b/packages/base/src/keybindings.json
@@ -0,0 +1,12 @@
+[
+  {
+    "command": "jupytercad:removeObject",
+    "keys": ["Delete"],
+    "selector": ".jp-jupytercad-panel"
+  },
+  {
+    "command": "jupytercad:removeObject",
+    "keys": ["Delete"],
+    "selector": ".jpcad-treeview-wrapper"
+  }
+]
diff --git a/packages/base/src/panelview/objecttree.tsx b/packages/base/src/panelview/objecttree.tsx
@@ -97,6 +97,47 @@ interface IProps {
   cpModel: IControlPanelModel;
 }
 
+export const handleRemoveObject = (
+  objectId: string,
+  sharedModel: any,
+  syncSelected: () => void
+): void => {
+  if (!sharedModel) {
+    return;
+  }
+
+  const dependants = sharedModel.getDependants(objectId);
+
+  let body: React.JSX.Element;
+  if (dependants.length) {
+    body = (
+      <div>
+        {'Removing this object will also result in removing:'}
+        <ul>
+          {dependants.map(dependant => (
+            <li key={dependant}>{dependant}</li>
+          ))}
+        </ul>
+      </div>
+    );
+  } else {
+    body = <div>Are you sure?</div>;
+  }
+
+  showDialog({
+    title: `Removing ${objectId}`,
+    body,
+    buttons: [Dialog.okButton(), Dialog.cancelButton()]
+  }).then(({ button: { accept } }) => {
+    if (accept) {
+      const toRemove = dependants.concat([objectId]);
+      sharedModel.removeObjects(toRemove);
+    }
+  });
+
+  syncSelected();
+};
+
 class ObjectTreeReact extends React.Component<IProps, IStates> {
   constructor(props: IProps) {
     super(props);
@@ -265,6 +306,17 @@ class ObjectTreeReact extends React.Component<IProps, IStates> {
     this.setState(old => ({ ...old, options: sender.options }));
   };
 
+  private _handleRemoveObject = (objectId: string): void => {
+    const sharedModel = this.props.cpModel.jcadModel?.sharedModel;
+    if (!sharedModel) {
+      return;
+    }
+
+    handleRemoveObject(objectId, sharedModel, () => {
+      this.props.cpModel.jcadModel?.syncSelected({});
+    });
+  };
+
   render(): React.ReactNode {
     const { selectedNodes, openNodes, options } = this.state;
     const data = this.stateToTree();
@@ -278,7 +330,7 @@ class ObjectTreeReact extends React.Component<IProps, IStates> {
     }
 
     return (
-      <div className="jpcad-treeview-wrapper">
+      <div className="jpcad-treeview-wrapper" tabIndex={0}>
         <ReactTree
           multiSelect={true}
           nodes={data}
@@ -394,45 +446,7 @@ class ObjectTreeReact extends React.Component<IProps, IStates> {
                         className={'jp-ToolbarButtonComponent'}
                         onClick={() => {
                           const objectId = opts.node.parentId as string;
-                          const sharedModel =
-                            this.props.cpModel.jcadModel?.sharedModel;
-                          if (!sharedModel) {
-                            return;
-                          }
-
-                          const dependants =
-                            sharedModel.getDependants(objectId);
-
-                          let body: React.JSX.Element;
-                          if (dependants.length) {
-                            body = (
-                              <div>
-                                {
-                                  'Removing this object will also result in removing:'
-                                }
-                                <ul>
-                                  {dependants.map(dependant => (
-                                    <li>{dependant}</li>
-                                  ))}
-                                </ul>
-                              </div>
-                            );
-                          } else {
-                            body = <div>Are you sure?</div>;
-                          }
-
-                          showDialog({
-                            title: `Removing ${objectId}`,
-                            body,
-                            buttons: [Dialog.okButton(), Dialog.cancelButton()]
-                          }).then(({ button: { accept } }) => {
-                            if (accept) {
-                              const toRemove = dependants.concat([objectId]);
-                              sharedModel.removeObjects(toRemove);
-                            }
-                          });
-
-                          this.props.cpModel.jcadModel?.syncSelected({});
+                          this._handleRemoveObject(objectId);
                         }}
                         icon={closeIcon}
                       />

diff --git a/packages/base/tsconfig.json b/packages/base/tsconfig.json
@@ -4,5 +4,10 @@
     "outDir": "lib",
     "rootDir": "src"
   },
-  "include": ["src/**/*", "src/schema/*.json", "src/_interface/*.json"]
+  "include": [
+    "src/**/*",
+    "src/schema/*.json",
+    "src/_interface/*.json",
+    "src/*.json"
+  ]
 }