babylonjs-accessibility 6.4.0 → 6.5.0

package/babylon.accessibility.d.ts

@@ -44,12 +44,14 @@ declare module BABYLON.Accessibility {
 
     interface IHTMLTwinHostComponentProps {
         scene: BABYLON.Scene;
+        options?: IHTMLTwinRendererOptions;
     }
     interface IHTMLTwinHostComponentState {
         a11yTreeItems: HTMLTwinItem[];
     }
     export class HTMLTwinHostComponent extends React.Component<IHTMLTwinHostComponentProps, IHTMLTwinHostComponentState> {
         private _observersMap;
+        private _options;
         constructor(props: IHTMLTwinHostComponentProps);
         componentDidUpdate(prevProps: Readonly<IHTMLTwinHostComponentProps>, prevState: Readonly<IHTMLTwinHostComponentState>, snapshot?: any): void;
         /**
@@ -160,8 +162,28 @@ declare module BABYLON.Accessibility {
     }
 
 
+    /**
+     * Options for the HTMLTwinRenderer.
+     */
+    export interface IHTMLTwinRendererOptions {
+        /**
+         * If this is true, all GUI controls will be added to the twin tree, regardless if they have
+         * a defined accessibility tag or not. If it's false, only controls with an accessibility tag
+         * will be added. True by default.
+         */
+        addAllControls: boolean;
+    }
+    /**
+     * This class is the main entry point for the HTML twin renderer. To render a twin for a scene,
+     * simply call HTMLTwinRenderer.Render(scene).
+     */
     export class HTMLTwinRenderer {
-        static Render(scene: BABYLON.Scene): void;
+        /**
+         * Render the HTML twin for the given scene.
+         * @param scene the scene to render the twin for
+         * @param options options for the renderer
+         */
+        static Render(scene: BABYLON.Scene, options?: IHTMLTwinRendererOptions): void;
     }