Implement/use GraphNode#remove (#5469)

* Implement/use `GraphNode#remove`

* Add unit test

Author: kungfooman

src/framework/components/sprite/component.js

@@ -596,11 +596,8 @@ class SpriteComponent extends Component {
         this._hideModel();
         this._model = null;
 
-        if (this._node) {
-            if (this._node.parent)
-                this._node.parent.removeChild(this._node);
-            this._node = null;
-        }
+        this._node?.remove();
+        this._node = null;
 
         if (this._meshInstance) {
             // make sure we decrease the ref counts materials and meshes

src/scene/graph-node.js

@@ -490,7 +490,7 @@ class GraphNode extends EventHandler {
      */
     destroy() {
         // Detach from parent
-        this._parent?.removeChild(this);
+        this.remove();
 
         // Recursively destroy all children
         const children = this._children;
@@ -955,18 +955,21 @@ class GraphNode extends EventHandler {
         return this._worldScaleSign;
     }
 
+    /**
+     * Remove graph node from current parent.
+     */
+    remove() {
+        this._parent?.removeChild(this);
+    }
+
     /**
      * Remove graph node from current parent and add as child to new parent.
      *
      * @param {GraphNode} parent - New parent to attach graph node to.
      * @param {number} [index] - The child index where the child node should be placed.
      */
     reparent(parent, index) {
-        const current = this._parent;
-
-        if (current)
-            current.removeChild(this);
-
+        this.remove();
         if (parent) {
             if (index >= 0) {
                 parent.insertChild(this, index);
@@ -1294,9 +1297,7 @@ class GraphNode extends EventHandler {
     _prepareInsertChild(node) {
 
         // remove it from the existing parent
-        if (node._parent) {
-            node._parent.removeChild(node);
-        }
+        node.remove();
 
         Debug.assert(node !== this, `GraphNode ${node?.name} cannot be a child of itself`);
         Debug.assert(!this.isDescendantOf(node), `GraphNode ${node?.name} cannot add an ancestor as a child`);

test/scene/graph-node.test.mjs

@@ -634,6 +634,19 @@ describe('GraphNode', function () {
 
     });
 
+    describe('#remove', function () {
+
+        it('removes the node from its parent, unparenting it', function () {
+            const node = new GraphNode();
+            const child = new GraphNode();
+            node.addChild(child);
+            child.remove();
+            expect(node.children).to.be.an('array').with.lengthOf(0);
+            expect(child.parent).to.equal(null);
+        });
+
+    });
+
     describe('#removeChild()', function () {
 
         it('removes a child node', function () {