@snaptrude/plugin-core 0.9.16 → 0.9.18-networks-20261016.1

package/src/api/design/visibility.ts

@@ -1,143 +1,143 @@
-import * as z from "zod"
-import { PluginApiReturn } from "../../types"
-import { ComponentHandle } from "../../handles"
-import { PluginDesignChangeResult } from "./lock"
-
-/**
- * `snaptrude.design.visibility.*` — hide, isolate, and reveal scene entities.
- *
- * Visibility is a per-component user flag (the same one the "Hide" / "Isolate" /
- * "Show All" toolbar and right-click actions toggle). Every method here commits
- * an undoable command and echoes the affected entities as
- * {@linkcode PluginDesignChangeResult}.
- *
- * Accessed via `snaptrude.design.visibility`.
- */
-export abstract class PluginDesignVisibilityApi {
-  constructor() {}
-
-  /**
-   * Hide entities from the viewport — the same as the "Hide" action. Undoable.
-   * Hosted door/window/void children ride along with their wall. Already-hidden
-   * entities stay hidden.
-   *
-   * @param components Entities to hide
-   * @returns The affected entities (echoing the input handles)
-   *
-   * @examplePrompt Hide the selected walls
-   * @examplePrompt Conceal these masses so I can see behind them
-   * @examplePrompt Hide every column on this floor
-   * @examplePrompt Make this furniture disappear from view
-   *
-   * # Example
-   * ```ts
-   * const walls = await snaptrude.design.query.listWalls({ storeys: [1] })
-   * const { affected } = await snaptrude.design.visibility.hide(walls)
-   * ```
-   */
-  public abstract hide(
-    components: ComponentHandle[],
-  ): PluginApiReturn<PluginDesignChangeResult>
-
-  /**
-   * Reveal specific hidden components — the inverse of
-   * {@linkcode PluginDesignVisibilityApi.hide}. Use
-   * {@linkcode PluginDesignVisibilityApi.showAll} to reveal everything.
-   *
-   * @param components - The components to reveal.
-   * @returns A {@linkcode PluginDesignChangeResult} echoing the components shown.
-   *
-   * @examplePrompt Show these walls again
-   * @examplePrompt Unhide the selected furniture
-   *
-   * # Example
-   * ```ts
-   * await snaptrude.design.visibility.show([wall])
-   * ```
-   */
-  public abstract show(
-    components: ComponentHandle[],
-  ): PluginApiReturn<PluginDesignChangeResult>
-
-  /**
-   * Isolate entities — hide everything else so only the given entities remain
-   * visible (the "Isolate" / solo action). Undoable. Reverse it with
-   * {@linkcode PluginDesignVisibilityApi.showAll}.
-   *
-   * @param components Entities to keep visible; everything else is hidden
-   * @returns The isolated entities (echoing the input handles)
-   *
-   * @examplePrompt Isolate the selected room so I can focus on it
-   * @examplePrompt Show only these walls and hide the rest
-   * @examplePrompt Solo this mass
-   * @examplePrompt Hide everything except the staircase
-   *
-   * # Example
-   * ```ts
-   * const [room] = await snaptrude.design.selection.get()
-   * await snaptrude.design.visibility.isolate([room])
-   * ```
-   */
-  public abstract isolate(
-    components: ComponentHandle[],
-  ): PluginApiReturn<PluginDesignChangeResult>
-
-  /**
-   * Reveal everything hidden on the active story — the "Show All" action, which
-   * also exits an isolate. Undoable.
-   *
-   * @returns The entities that were made visible
-   *
-   * @examplePrompt Show everything again
-   * @examplePrompt Unhide all the hidden objects
-   * @examplePrompt Exit isolate mode
-   * @examplePrompt Reveal everything I hid earlier
-   *
-   * # Example
-   * ```ts
-   * const { affected } = await snaptrude.design.visibility.showAll()
-   * console.log(`Revealed ${affected.length} entities`)
-   * ```
-   */
-  public abstract showAll(): PluginApiReturn<PluginDesignChangeResult>
-}
-
-/**
- * Arguments for {@linkcode PluginDesignVisibilityApi.hide}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `components` | {@linkcode ComponentHandle}`[]` | Entities to hide |
- */
-export const PluginDesignVisibilityHideArgs = z.object({
-  components: z.array(ComponentHandle),
-})
-export type PluginDesignVisibilityHideArgs = z.infer<typeof PluginDesignVisibilityHideArgs>
-
-/**
- * Arguments for {@linkcode PluginDesignVisibilityApi.show}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `components` | {@linkcode ComponentHandle}`[]` | Entities to reveal |
- */
-export const PluginDesignVisibilityShowArgs = z.object({
-  components: z.array(ComponentHandle),
-})
-export type PluginDesignVisibilityShowArgs = z.infer<
-  typeof PluginDesignVisibilityShowArgs
->
-
-/**
- * Arguments for {@linkcode PluginDesignVisibilityApi.isolate}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `components` | {@linkcode ComponentHandle}`[]` | Entities to keep visible |
- */
-export const PluginDesignVisibilityIsolateArgs = z.object({
-  components: z.array(ComponentHandle),
-})
-export type PluginDesignVisibilityIsolateArgs = z.infer<
-  typeof PluginDesignVisibilityIsolateArgs
->
+import * as z from "zod"
+import { PluginApiReturn } from "../../types"
+import { ComponentHandle } from "../../handles"
+import { PluginDesignChangeResult } from "./lock"
+
+/**
+ * `snaptrude.design.visibility.*` — hide, isolate, and reveal scene entities.
+ *
+ * Visibility is a per-component user flag (the same one the "Hide" / "Isolate" /
+ * "Show All" toolbar and right-click actions toggle). Every method here commits
+ * an undoable command and echoes the affected entities as
+ * {@linkcode PluginDesignChangeResult}.
+ *
+ * Accessed via `snaptrude.design.visibility`.
+ */
+export abstract class PluginDesignVisibilityApi {
+  constructor() {}
+
+  /**
+   * Hide entities from the viewport — the same as the "Hide" action. Undoable.
+   * Hosted door/window/void children ride along with their wall. Already-hidden
+   * entities stay hidden.
+   *
+   * @param components Entities to hide
+   * @returns The affected entities (echoing the input handles)
+   *
+   * @examplePrompt Hide the selected walls
+   * @examplePrompt Conceal these masses so I can see behind them
+   * @examplePrompt Hide every column on this floor
+   * @examplePrompt Make this furniture disappear from view
+   *
+   * # Example
+   * ```ts
+   * const walls = await snaptrude.design.query.listWalls({ storeys: [1] })
+   * const { affected } = await snaptrude.design.visibility.hide(walls)
+   * ```
+   */
+  public abstract hide(
+    components: ComponentHandle[],
+  ): PluginApiReturn<PluginDesignChangeResult>
+
+  /**
+   * Reveal specific hidden components — the inverse of
+   * {@linkcode PluginDesignVisibilityApi.hide}. Use
+   * {@linkcode PluginDesignVisibilityApi.showAll} to reveal everything.
+   *
+   * @param components - The components to reveal.
+   * @returns A {@linkcode PluginDesignChangeResult} echoing the components shown.
+   *
+   * @examplePrompt Show these walls again
+   * @examplePrompt Unhide the selected furniture
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.design.visibility.show([wall])
+   * ```
+   */
+  public abstract show(
+    components: ComponentHandle[],
+  ): PluginApiReturn<PluginDesignChangeResult>
+
+  /**
+   * Isolate entities — hide everything else so only the given entities remain
+   * visible (the "Isolate" / solo action). Undoable. Reverse it with
+   * {@linkcode PluginDesignVisibilityApi.showAll}.
+   *
+   * @param components Entities to keep visible; everything else is hidden
+   * @returns The isolated entities (echoing the input handles)
+   *
+   * @examplePrompt Isolate the selected room so I can focus on it
+   * @examplePrompt Show only these walls and hide the rest
+   * @examplePrompt Solo this mass
+   * @examplePrompt Hide everything except the staircase
+   *
+   * # Example
+   * ```ts
+   * const [room] = await snaptrude.design.selection.get()
+   * await snaptrude.design.visibility.isolate([room])
+   * ```
+   */
+  public abstract isolate(
+    components: ComponentHandle[],
+  ): PluginApiReturn<PluginDesignChangeResult>
+
+  /**
+   * Reveal everything hidden on the active story — the "Show All" action, which
+   * also exits an isolate. Undoable.
+   *
+   * @returns The entities that were made visible
+   *
+   * @examplePrompt Show everything again
+   * @examplePrompt Unhide all the hidden objects
+   * @examplePrompt Exit isolate mode
+   * @examplePrompt Reveal everything I hid earlier
+   *
+   * # Example
+   * ```ts
+   * const { affected } = await snaptrude.design.visibility.showAll()
+   * console.log(`Revealed ${affected.length} entities`)
+   * ```
+   */
+  public abstract showAll(): PluginApiReturn<PluginDesignChangeResult>
+}
+
+/**
+ * Arguments for {@linkcode PluginDesignVisibilityApi.hide}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to hide |
+ */
+export const PluginDesignVisibilityHideArgs = z.object({
+  components: z.array(ComponentHandle),
+})
+export type PluginDesignVisibilityHideArgs = z.infer<typeof PluginDesignVisibilityHideArgs>
+
+/**
+ * Arguments for {@linkcode PluginDesignVisibilityApi.show}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to reveal |
+ */
+export const PluginDesignVisibilityShowArgs = z.object({
+  components: z.array(ComponentHandle),
+})
+export type PluginDesignVisibilityShowArgs = z.infer<
+  typeof PluginDesignVisibilityShowArgs
+>
+
+/**
+ * Arguments for {@linkcode PluginDesignVisibilityApi.isolate}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to keep visible |
+ */
+export const PluginDesignVisibilityIsolateArgs = z.object({
+  components: z.array(ComponentHandle),
+})
+export type PluginDesignVisibilityIsolateArgs = z.infer<
+  typeof PluginDesignVisibilityIsolateArgs
+>