KHR_node_visibility

packages/dev/loaders/src/glTF/2.0/Extensions/KHR_node_visibility.ts

@@ -0,0 +1,68 @@
+import type { AbstractMesh } from "core/Meshes/abstractMesh";
+import type { GLTFLoader } from "../glTFLoader";
+import type { IGLTFLoaderExtension } from "../glTFLoaderExtension";
+import { registerGLTFExtension, unregisterGLTFExtension } from "../glTFLoaderExtensionRegistry";
+
+const NAME = "KHR_node_visibility";
+
+declare module "../../glTFFileLoader" {
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    export interface GLTFLoaderExtensionOptions {
+        /**
+         * Defines options for the KHR_node_visibility extension.
+         */
+        // NOTE: Don't use NAME here as it will break the UMD type declarations.
+        ["KHR_node_visibility"]: {};
+    }
+}
+
+/**
+ * Loader extension for KHR_node_visibility
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export class KHR_node_visibility implements IGLTFLoaderExtension {
+    /**
+     * The name of this extension.
+     */
+    public readonly name = NAME;
+    /**
+     * Defines whether this extension is enabled.
+     */
+    public enabled: boolean;
+
+    private _loader: GLTFLoader;
+
+    /**
+     * @internal
+     */
+    constructor(loader: GLTFLoader) {
+        this._loader = loader;
+        this.enabled = loader.isExtensionUsed(NAME);
+    }
+
+    public async onReady(): Promise<void> {
+        this._loader.gltf.nodes?.forEach((node) => {
+            node._primitiveBabylonMeshes?.forEach((mesh) => {
+                mesh.inheritVisibility = true;
+            });
+            // When the JSON Pointer is used we need to change both the transform node and the primitive meshes to the new value.
+            if (node.extensions?.KHR_node_visibility) {
+                if (node.extensions?.KHR_node_visibility.visible === false) {
+                    if (node._babylonTransformNode) {
+                        (node._babylonTransformNode as AbstractMesh).isVisible = false;
+                    }
+                    node._primitiveBabylonMeshes?.forEach((mesh) => {
+                        mesh.isVisible = false;
+                    });
+                }
+            }
+        });
+    }
+
+    public dispose() {
+        (this._loader as any) = null;
+    }
+}
+
+unregisterGLTFExtension(NAME);
+registerGLTFExtension(NAME, true, (loader) => new KHR_node_visibility(loader));

packages/dev/loaders/src/glTF/2.0/Extensions/index.ts

@@ -29,4 +29,5 @@ export * from "./MSFT_lod";
 export * from "./MSFT_minecraftMesh";
 export * from "./MSFT_sRGBFactors";
 export * from "./KHR_interactivity";
+export * from "./KHR_node_visibility";
 export * from "./ExtrasAsMetadata";

packages/tools/tests/test/visualization/config.json

@@ -960,6 +960,11 @@
             "playgroundId": "#WGZLGJ#3009",
             "referenceImage": "gltfTextureLinearInterpolation.png"
         },
+        {
+            "title": "GLTF Node visibility test",
+            "playgroundId": "#80DN99#3",
+            "referenceImage": "gltfNodeVisibility.png"
+        },
         {
             "title": "Asset Containers",
             "playgroundId": "#P3U079#19",