@itwin/frontend-devtools 4.0.0-dev.24 → 4.0.0-dev.28

package/lib/esm/tools/RealityModelTools.d.ts

@@ -1,117 +1,117 @@
-/** @packageDocumentation
- * @module Tools
- */
-import { RgbColorProps } from "@itwin/core-common";
-import { Tool } from "@itwin/core-frontend";
-/** This tool attaches a specified reality model.
- * @beta
- */
-export declare class AttachRealityModelTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    /** This method runs the tool, attaching a specified reality model.
-     * @param data a [[ContextRealityModelProps]] JSON representation
-     */
-    run(data: string): Promise<boolean>;
-    /** Executes this tool's run method with args[0] containing `data`.
-     * @see [[run]]
-     */
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** This tool saves a reality model's JSON representation to the system clipboard.
- * @beta */
-export declare class SaveRealityModelTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    /** This method runs the tool, saving a reality model's JSON representation to the system clipboard.
-     * @param name the name of the reality model to copy; if undefined, copy the last found reality model
-     */
-    run(name: string | undefined): Promise<boolean>;
-    /** Executes this tool's run method with args[0] containing `name`.
-     * @see [[run]]
-     */
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Set reality model appearance override for transparency in display style.
- * @beta
- */
-export declare class SetRealityModelTransparencyTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(transparency: number, index: number): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Set reality model appearance override for locatable in display style.
- * @beta
- */
-export declare class SetRealityModelLocateTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(locate: boolean, index: number): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Set reality model appearance override for emphasized in display style.
- * @beta
- */
-export declare class SetRealityModelEmphasizedTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(emphasized: true | undefined, index: number): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Detach reality model from display style.
- * @beta
- */
-export declare class DetachRealityModelTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(index: number): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Set reality model appearance override for color in display style.
- * @beta
- */
-export declare class SetRealityModelColorTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(rgb: RgbColorProps, index: number): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Clear reality model appearance override in display style.
- * @beta
- */
-export declare class ClearRealityModelAppearanceOverrides extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(index: number): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Attach a cesium asset from the Ion ID and key.
- * @beta
- */
-export declare class AttachCesiumAssetTool extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(assetId: number, requestKey: string): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
-/** Turn on/off display of OpenStreetMap buildings
- * @beta
- */
-export declare class ToggleOSMBuildingDisplay extends Tool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    run(onOff?: boolean, transparency?: number): Promise<boolean>;
-    parseAndRun(...args: string[]): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module Tools
+ */
+import { RgbColorProps } from "@itwin/core-common";
+import { Tool } from "@itwin/core-frontend";
+/** This tool attaches a specified reality model.
+ * @beta
+ */
+export declare class AttachRealityModelTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, attaching a specified reality model.
+     * @param data a [[ContextRealityModelProps]] JSON representation
+     */
+    run(data: string): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing `data`.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** This tool saves a reality model's JSON representation to the system clipboard.
+ * @beta */
+export declare class SaveRealityModelTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    /** This method runs the tool, saving a reality model's JSON representation to the system clipboard.
+     * @param name the name of the reality model to copy; if undefined, copy the last found reality model
+     */
+    run(name: string | undefined): Promise<boolean>;
+    /** Executes this tool's run method with args[0] containing `name`.
+     * @see [[run]]
+     */
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for transparency in display style.
+ * @beta
+ */
+export declare class SetRealityModelTransparencyTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(transparency: number, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for locatable in display style.
+ * @beta
+ */
+export declare class SetRealityModelLocateTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(locate: boolean, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for emphasized in display style.
+ * @beta
+ */
+export declare class SetRealityModelEmphasizedTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(emphasized: true | undefined, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Detach reality model from display style.
+ * @beta
+ */
+export declare class DetachRealityModelTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set reality model appearance override for color in display style.
+ * @beta
+ */
+export declare class SetRealityModelColorTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(rgb: RgbColorProps, index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Clear reality model appearance override in display style.
+ * @beta
+ */
+export declare class ClearRealityModelAppearanceOverrides extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(index: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Attach a cesium asset from the Ion ID and key.
+ * @beta
+ */
+export declare class AttachCesiumAssetTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(assetId: number, requestKey: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Turn on/off display of OpenStreetMap buildings
+ * @beta
+ */
+export declare class ToggleOSMBuildingDisplay extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(onOff?: boolean, transparency?: number): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
 //# sourceMappingURL=RealityModelTools.d.ts.map