@vertexvis/viewer 0.13.2-canary.9 → 0.14.0

package/dist/types/components.d.ts

@@ -16,6 +16,7 @@ import { Node } from "@vertexvis/scene-tree-protos/scenetree/protos/domain_pb";
 import { SceneTreeTableCellEventDetails } from "./components/scene-tree-table-cell/scene-tree-table-cell";
 import { RowDataProvider as RowDataProvider1 } from "./components/scene-tree/scene-tree";
 import { DomScrollToOptions } from "./components/scene-tree-table-layout/lib/dom";
+import { FrameCameraType } from "./lib/types/frameCamera";
 import { FeatureHighlightOptions, FeatureLineOptions, FrameType } from "./interfaces";
 import { ColorMaterial } from "./lib/scenes/colorMaterial";
 import { Frame, FrameCameraBase } from "./lib/types/frame";
@@ -47,8 +48,12 @@ import { Anchor } from "./components/viewer-measurement-distance/utils";
 import { PointToPointHitProvider } from "./components/viewer-measurement-distance/interactions";
 import { ViewerMeasurementToolType } from "./components/viewer-measurement-tool/viewer-measurement-tool";
 import { ViewerMeasurementToolType as ViewerMeasurementToolType1 } from "./components/viewer-measurement-tool/viewer-measurement-tool";
+import { Pin, PinModel, TextPin, ViewerPinToolMode, ViewerPinToolType } from "./lib/pins/model";
+import { PinController } from "./lib/pins/controller";
 import { ViewerToolbarDirection, ViewerToolbarPlacement as ViewerToolbarPlacement1 } from "./components/viewer-toolbar/viewer-toolbar";
 import { ViewerToolbarGroupDirection as ViewerToolbarGroupDirection1 } from "./components/viewer-toolbar-group/viewer-toolbar-group";
+import { TransformController } from "./lib/transforms/controller";
+import { Drawable } from "./lib/transforms/drawable";
 export namespace Components {
     interface VertexSceneTree {
         /**
@@ -95,10 +100,6 @@ export namespace Components {
           * @returns A promise that completes when the request has completed. Note, items are displayed asynchronously. So the displayed items may not reflect the result of this filter when the promise completes.
          */
         "filterItems": (term: string, options?: FilterTreeOptions) => Promise<void>;
-        /**
-          * Temporary flag to indicate whether metadata should be used when filtering as opposed to just the name of the item.
-         */
-        "filterOnMetadata": boolean;
         /**
           * Returns the row data from the given vertical client position.
           * @param clientY The vertical client position.
@@ -130,6 +131,14 @@ export namespace Components {
           * A list of part metadata keys that will be made available to each row. This metadata can be used for data binding inside the scene tree's template.
          */
         "metadataKeys": MetadataKey[];
+        /**
+          * Indicates whether the metadata search should use an exact match.
+         */
+        "metadataSearchExactMatch": boolean;
+        /**
+          * A list of the metadata keys that a scene tree search should be performed on.
+         */
+        "metadataSearchKeys": MetadataKey[];
         /**
           * The number of offscreen rows above and below the viewport to render. Having a higher number reduces the chance of the browser not displaying a row while scrolling.
          */
@@ -152,6 +161,12 @@ export namespace Components {
           * @returns A promise that resolves when the operation is finished.
          */
         "scrollToItem": (itemId: string, options?: ScrollToOptions) => Promise<void>;
+        /**
+          * Performs an async request that will select the filtered items in the tree that match the given term.
+          * @param term The filter term.
+          * @returns A promise that completes when the request has completed.
+         */
+        "selectFilteredItems": (term: string) => Promise<void>;
         /**
           * Performs an API call that will select the item associated to the given row or row index.  This method supports a `recurseParent` option that allows for recursively selecting the next unselected parent node. This behavior is considered stateful. Each call to `selectItem` will track the ancestry of the passed in `rowArg`. If calling `selectItem` with a row not belonging to the ancestry of a previous selection, then this method will perform a standard selection.
           * @param row The row, row index or node to select.
@@ -214,6 +229,7 @@ export namespace Components {
           * A flag that disables the default interactions of this component. If disabled, you can use the event handlers to be notified when certain operations are performed by the user.
          */
         "interactionsDisabled": boolean;
+        "isScrolling"?: boolean;
         /**
           * The node data that is associated to the row that this cell belongs to. Contains information related to if the node is expanded, visible, etc.
          */
@@ -308,7 +324,7 @@ export namespace Components {
         /**
           * The type of camera model to represent the scene with. Can be either `perspective` or `orthographic`, and defaults to `perspective`.
          */
-        "cameraType": 'perspective' | 'orthographic';
+        "cameraType": FrameCameraType;
         /**
           * The Client ID associated with your Vertex Application.
          */
@@ -376,6 +392,10 @@ export namespace Components {
           * @param urn The URN of the resource to load.
          */
         "load": (urn: string) => Promise<void>;
+        /**
+          * Specifies whether to use the default lights for the scene. When false, default lights are used. When true, no default lights are used, and the lights must be specified separately.
+         */
+        "noDefaultLights": boolean;
         /**
           * Registers and initializes an interaction handler with the viewer. Returns a `Disposable` that should be used to deregister the interaction handler.  `InteractionHandler`s are used to build custom mouse and touch interactions for the viewer. Use `<vertex-viewer camera-controls="false" />` to disable the default camera controls provided by the viewer.
           * @example ``` class CustomInteractionHandler extends InteractionHandler {   private element: HTMLElement;   private api: InteractionApi;    public dispose(): void {     this.element.removeEventListener('click', this.handleElementClick);   }    public initialize(element: HTMLElement, api: InteractionApi): void {     this.api = api;     this.element = element;     this.element.addEventListener('click', this.handleElementClick);   }    private handleElementClick = (event: MouseEvent) => {     api.tap({ x: event.clientX, y: event.clientY });   } }  const viewer = document.querySelector("vertex-viewer"); viewer.registerInteractionHandler(new CustomInteractionHandler); ```
@@ -484,7 +504,7 @@ export namespace Components {
          */
         "quaternion": Quaternion.Quaternion;
         /**
-          * The local rotation of this element, as a JSON string. JSON representation can either be `[x, y, z, w]` or `{"x": 0, "y": 0, "z": 0, "w": 1}`.
+          * The local quaternion rotation of this element, as a JSON string. JSON representation can either be `[x, y, z, w]` or `{"x": 0, "y": 0, "z": 0, "w": 1}`.
          */
         "quaternionJson": string;
         /**
@@ -1020,6 +1040,85 @@ export namespace Components {
          */
         "viewer"?: HTMLVertexViewerElement;
     }
+    interface VertexViewerPinGroup {
+        /**
+          * The dimensions of the canvas for the pins
+         */
+        "elementBounds"?: DOMRect;
+        /**
+          * The local matrix of this element.
+         */
+        "matrix": Matrix4.Matrix4;
+        /**
+          * The pin to draw for the group
+         */
+        "pin"?: Pin;
+        /**
+          * The controller that drives behavior for pin operations
+         */
+        "pinController"?: PinController;
+        /**
+          * The model that contains the entities and outcomes from performing pin operations
+         */
+        "pinModel": PinModel;
+        /**
+          * Projection view matrix used for computing the position of the pin line
+         */
+        "projectionViewMatrix": Matrix4.Matrix4;
+        /**
+          * Whether or not the pin is "selected"
+         */
+        "selected": boolean;
+    }
+    interface VertexViewerPinLabel {
+        /**
+          * The dimensions of the canvas for the pins
+         */
+        "elementBounds"?: DOMRect;
+        /**
+          * The pin to draw for the group
+         */
+        "pin"?: TextPin;
+        /**
+          * The controller that drives behavior for pin operations
+         */
+        "pinController"?: PinController;
+        /**
+          * Gives focus to the the component's internal text input.
+         */
+        "setFocus": () => Promise<void>;
+        /**
+          * The current text value of the component. Value is updated on user interaction.
+         */
+        "value": string;
+    }
+    interface VertexViewerPinLabelLine {
+        "labelPoint": Point.Point | undefined;
+        "pinPoint": Point.Point | undefined;
+    }
+    interface VertexViewerPinTool {
+        /**
+          * The mode of the pin tool
+         */
+        "mode": ViewerPinToolMode;
+        /**
+          * The controller that is responsible for drawing pins and updating the model
+         */
+        "pinController"?: PinController;
+        /**
+          * The model that contains the entities and outcomes from performing pin annotations
+         */
+        "pinModel": PinModel;
+        "pins": Pin[];
+        /**
+          * The type of pin.  This property will automatically be set.
+         */
+        "tool": ViewerPinToolType;
+        /**
+          * The viewer that this component is bound to. This is automatically assigned if added to the light-dom of a parent viewer element.
+         */
+        "viewer"?: HTMLVertexViewerElement;
+    }
     interface VertexViewerToolbar {
         "direction": ViewerToolbarDirection;
         /**
@@ -1030,6 +1129,24 @@ export namespace Components {
     interface VertexViewerToolbarGroup {
         "direction": ViewerToolbarGroupDirection;
     }
+    interface VertexViewerTransformWidget {
+        /**
+          * The controller that is responsible for performing transforms.
+         */
+        "controller"?: TransformController;
+        /**
+          * @ignore Visible for testing.
+         */
+        "hovered"?: Drawable;
+        /**
+          * The starting position of this transform widget. This position will be updated as transforms occur. Setting this value to `undefined` will remove the widget.
+         */
+        "position"?: Vector3.Vector3;
+        /**
+          * The viewer to connect to transforms. If nested within a <vertex-viewer>, this property will be populated automatically.
+         */
+        "viewer"?: HTMLVertexViewerElement;
+    }
     interface VertexViewerViewCube {
         /**
           * The duration of the animation, in milliseconds, when a user performs a standard view interaction. Set to 0 to disable animations.
@@ -1250,6 +1367,30 @@ declare global {
         prototype: HTMLVertexViewerMeasurementsElement;
         new (): HTMLVertexViewerMeasurementsElement;
     };
+    interface HTMLVertexViewerPinGroupElement extends Components.VertexViewerPinGroup, HTMLStencilElement {
+    }
+    var HTMLVertexViewerPinGroupElement: {
+        prototype: HTMLVertexViewerPinGroupElement;
+        new (): HTMLVertexViewerPinGroupElement;
+    };
+    interface HTMLVertexViewerPinLabelElement extends Components.VertexViewerPinLabel, HTMLStencilElement {
+    }
+    var HTMLVertexViewerPinLabelElement: {
+        prototype: HTMLVertexViewerPinLabelElement;
+        new (): HTMLVertexViewerPinLabelElement;
+    };
+    interface HTMLVertexViewerPinLabelLineElement extends Components.VertexViewerPinLabelLine, HTMLStencilElement {
+    }
+    var HTMLVertexViewerPinLabelLineElement: {
+        prototype: HTMLVertexViewerPinLabelLineElement;
+        new (): HTMLVertexViewerPinLabelLineElement;
+    };
+    interface HTMLVertexViewerPinToolElement extends Components.VertexViewerPinTool, HTMLStencilElement {
+    }
+    var HTMLVertexViewerPinToolElement: {
+        prototype: HTMLVertexViewerPinToolElement;
+        new (): HTMLVertexViewerPinToolElement;
+    };
     interface HTMLVertexViewerToolbarElement extends Components.VertexViewerToolbar, HTMLStencilElement {
     }
     var HTMLVertexViewerToolbarElement: {
@@ -1262,6 +1403,12 @@ declare global {
         prototype: HTMLVertexViewerToolbarGroupElement;
         new (): HTMLVertexViewerToolbarGroupElement;
     };
+    interface HTMLVertexViewerTransformWidgetElement extends Components.VertexViewerTransformWidget, HTMLStencilElement {
+    }
+    var HTMLVertexViewerTransformWidgetElement: {
+        prototype: HTMLVertexViewerTransformWidgetElement;
+        new (): HTMLVertexViewerTransformWidgetElement;
+    };
     interface HTMLVertexViewerViewCubeElement extends Components.VertexViewerViewCube, HTMLStencilElement {
     }
     var HTMLVertexViewerViewCubeElement: {
@@ -1298,8 +1445,13 @@ declare global {
         "vertex-viewer-measurement-precise": HTMLVertexViewerMeasurementPreciseElement;
         "vertex-viewer-measurement-tool": HTMLVertexViewerMeasurementToolElement;
         "vertex-viewer-measurements": HTMLVertexViewerMeasurementsElement;
+        "vertex-viewer-pin-group": HTMLVertexViewerPinGroupElement;
+        "vertex-viewer-pin-label": HTMLVertexViewerPinLabelElement;
+        "vertex-viewer-pin-label-line": HTMLVertexViewerPinLabelLineElement;
+        "vertex-viewer-pin-tool": HTMLVertexViewerPinToolElement;
         "vertex-viewer-toolbar": HTMLVertexViewerToolbarElement;
         "vertex-viewer-toolbar-group": HTMLVertexViewerToolbarGroupElement;
+        "vertex-viewer-transform-widget": HTMLVertexViewerTransformWidgetElement;
         "vertex-viewer-view-cube": HTMLVertexViewerViewCubeElement;
     }
 }
@@ -1314,14 +1466,18 @@ declare namespace LocalJSX {
          */
         "configEnv"?: Environment;
         "controller"?: SceneTreeController;
-        /**
-          * Temporary flag to indicate whether metadata should be used when filtering as opposed to just the name of the item.
-         */
-        "filterOnMetadata"?: boolean;
         /**
           * A list of part metadata keys that will be made available to each row. This metadata can be used for data binding inside the scene tree's template.
          */
         "metadataKeys"?: MetadataKey[];
+        /**
+          * Indicates whether the metadata search should use an exact match.
+         */
+        "metadataSearchExactMatch"?: boolean;
+        /**
+          * A list of the metadata keys that a scene tree search should be performed on.
+         */
+        "metadataSearchKeys"?: MetadataKey[];
         "onConnectionError"?: (event: CustomEvent<SceneTreeErrorDetails>) => void;
         /**
           * The number of offscreen rows above and below the viewport to render. Having a higher number reduces the chance of the browser not displaying a row while scrolling.
@@ -1454,7 +1610,7 @@ declare namespace LocalJSX {
         /**
           * The type of camera model to represent the scene with. Can be either `perspective` or `orthographic`, and defaults to `perspective`.
          */
-        "cameraType"?: 'perspective' | 'orthographic';
+        "cameraType"?: FrameCameraType;
         /**
           * The Client ID associated with your Vertex Application.
          */
@@ -1497,6 +1653,14 @@ declare namespace LocalJSX {
           * Enables or disables the default keyboard shortcut interactions provided by the viewer. Enabled by default, requires `cameraControls` being enabled.
          */
         "keyboardControls"?: boolean;
+        /**
+          * Specifies whether to use the default lights for the scene. When false, default lights are used. When true, no default lights are used, and the lights must be specified separately.
+         */
+        "noDefaultLights"?: boolean;
+        /**
+          * Emits an event when the camera type changes.
+         */
+        "onCameraTypeChanged"?: (event: CustomEvent<FrameCameraType>) => void;
         /**
           * Emits an event when the connection status changes for the viewer
          */
@@ -1614,6 +1778,10 @@ declare namespace LocalJSX {
           * Disables occlusion testing for this element. Defaults to enabled. When enabled, the elements position will be tested against the current depth buffer. If the position is occluded, then the `occluded` attribute will be set.
          */
         "occlusionOff"?: boolean;
+        /**
+          * An event that is emitted when any property on the dom group changes
+         */
+        "onPropertyChange"?: (event: CustomEvent<void>) => void;
         /**
           * The local 3D position of where this element is located.
          */
@@ -1627,7 +1795,7 @@ declare namespace LocalJSX {
          */
         "quaternion"?: Quaternion.Quaternion;
         /**
-          * The local rotation of this element, as a JSON string. JSON representation can either be `[x, y, z, w]` or `{"x": 0, "y": 0, "z": 0, "w": 1}`.
+          * The local quaternion rotation of this element, as a JSON string. JSON representation can either be `[x, y, z, w]` or `{"x": 0, "y": 0, "z": 0, "w": 1}`.
          */
         "quaternionJson"?: string;
         /**
@@ -1652,6 +1820,10 @@ declare namespace LocalJSX {
           * The local matrix of this element.
          */
         "matrix"?: Matrix4.Matrix4;
+        /**
+          * An event that is emitted when any property on the dom group changes
+         */
+        "onPropertyChange"?: (event: CustomEvent<void>) => void;
         /**
           * The local 3D position of where this element is located.
          */
@@ -2175,6 +2347,89 @@ declare namespace LocalJSX {
          */
         "viewer"?: HTMLVertexViewerElement;
     }
+    interface VertexViewerPinGroup {
+        /**
+          * The dimensions of the canvas for the pins
+         */
+        "elementBounds"?: DOMRect;
+        /**
+          * The local matrix of this element.
+         */
+        "matrix"?: Matrix4.Matrix4;
+        /**
+          * The pin to draw for the group
+         */
+        "pin"?: Pin;
+        /**
+          * The controller that drives behavior for pin operations
+         */
+        "pinController"?: PinController;
+        /**
+          * The model that contains the entities and outcomes from performing pin operations
+         */
+        "pinModel"?: PinModel;
+        /**
+          * Projection view matrix used for computing the position of the pin line
+         */
+        "projectionViewMatrix"?: Matrix4.Matrix4;
+        /**
+          * Whether or not the pin is "selected"
+         */
+        "selected"?: boolean;
+    }
+    interface VertexViewerPinLabel {
+        /**
+          * The dimensions of the canvas for the pins
+         */
+        "elementBounds"?: DOMRect;
+        /**
+          * Emitted whenever the label is blurred, with the ID of the associated pin (or undefined if no pin is provided).
+         */
+        "onLabelBlurred"?: (event: CustomEvent<string | undefined>) => void;
+        /**
+          * Emitted whenever the label is focused, with the ID of the associated pin (or undefined if no pin is provided).
+         */
+        "onLabelFocused"?: (event: CustomEvent<string | undefined>) => void;
+        /**
+          * The pin to draw for the group
+         */
+        "pin"?: TextPin;
+        /**
+          * The controller that drives behavior for pin operations
+         */
+        "pinController"?: PinController;
+        /**
+          * The current text value of the component. Value is updated on user interaction.
+         */
+        "value"?: string;
+    }
+    interface VertexViewerPinLabelLine {
+        "labelPoint"?: Point.Point | undefined;
+        "pinPoint"?: Point.Point | undefined;
+    }
+    interface VertexViewerPinTool {
+        /**
+          * The mode of the pin tool
+         */
+        "mode"?: ViewerPinToolMode;
+        /**
+          * The controller that is responsible for drawing pins and updating the model
+         */
+        "pinController"?: PinController;
+        /**
+          * The model that contains the entities and outcomes from performing pin annotations
+         */
+        "pinModel"?: PinModel;
+        "pins"?: Pin[];
+        /**
+          * The type of pin.  This property will automatically be set.
+         */
+        "tool"?: ViewerPinToolType;
+        /**
+          * The viewer that this component is bound to. This is automatically assigned if added to the light-dom of a parent viewer element.
+         */
+        "viewer"?: HTMLVertexViewerElement;
+    }
     interface VertexViewerToolbar {
         "direction"?: ViewerToolbarDirection;
         /**
@@ -2185,6 +2440,32 @@ declare namespace LocalJSX {
     interface VertexViewerToolbarGroup {
         "direction"?: ViewerToolbarGroupDirection;
     }
+    interface VertexViewerTransformWidget {
+        /**
+          * The controller that is responsible for performing transforms.
+         */
+        "controller"?: TransformController;
+        /**
+          * An event that is emitted when the interaction has ended
+         */
+        "onInteractionEnded"?: (event: CustomEvent<Matrix4.Matrix4 | undefined>) => void;
+        /**
+          * An event that is emitted an interaction with the widget has started
+         */
+        "onInteractionStarted"?: (event: CustomEvent<void>) => void;
+        /**
+          * An event that is emitted when the position of the widget changes.
+         */
+        "onPositionChanged"?: (event: CustomEvent<Vector3.Vector3 | undefined>) => void;
+        /**
+          * The starting position of this transform widget. This position will be updated as transforms occur. Setting this value to `undefined` will remove the widget.
+         */
+        "position"?: Vector3.Vector3;
+        /**
+          * The viewer to connect to transforms. If nested within a <vertex-viewer>, this property will be populated automatically.
+         */
+        "viewer"?: HTMLVertexViewerElement;
+    }
     interface VertexViewerViewCube {
         /**
           * The duration of the animation, in milliseconds, when a user performs a standard view interaction. Set to 0 to disable animations.
@@ -2257,8 +2538,13 @@ declare namespace LocalJSX {
         "vertex-viewer-measurement-precise": VertexViewerMeasurementPrecise;
         "vertex-viewer-measurement-tool": VertexViewerMeasurementTool;
         "vertex-viewer-measurements": VertexViewerMeasurements;
+        "vertex-viewer-pin-group": VertexViewerPinGroup;
+        "vertex-viewer-pin-label": VertexViewerPinLabel;
+        "vertex-viewer-pin-label-line": VertexViewerPinLabelLine;
+        "vertex-viewer-pin-tool": VertexViewerPinTool;
         "vertex-viewer-toolbar": VertexViewerToolbar;
         "vertex-viewer-toolbar-group": VertexViewerToolbarGroup;
+        "vertex-viewer-transform-widget": VertexViewerTransformWidget;
         "vertex-viewer-view-cube": VertexViewerViewCube;
     }
 }
@@ -2295,8 +2581,13 @@ declare module "@stencil/core" {
             "vertex-viewer-measurement-precise": LocalJSX.VertexViewerMeasurementPrecise & JSXBase.HTMLAttributes<HTMLVertexViewerMeasurementPreciseElement>;
             "vertex-viewer-measurement-tool": LocalJSX.VertexViewerMeasurementTool & JSXBase.HTMLAttributes<HTMLVertexViewerMeasurementToolElement>;
             "vertex-viewer-measurements": LocalJSX.VertexViewerMeasurements & JSXBase.HTMLAttributes<HTMLVertexViewerMeasurementsElement>;
+            "vertex-viewer-pin-group": LocalJSX.VertexViewerPinGroup & JSXBase.HTMLAttributes<HTMLVertexViewerPinGroupElement>;
+            "vertex-viewer-pin-label": LocalJSX.VertexViewerPinLabel & JSXBase.HTMLAttributes<HTMLVertexViewerPinLabelElement>;
+            "vertex-viewer-pin-label-line": LocalJSX.VertexViewerPinLabelLine & JSXBase.HTMLAttributes<HTMLVertexViewerPinLabelLineElement>;
+            "vertex-viewer-pin-tool": LocalJSX.VertexViewerPinTool & JSXBase.HTMLAttributes<HTMLVertexViewerPinToolElement>;
             "vertex-viewer-toolbar": LocalJSX.VertexViewerToolbar & JSXBase.HTMLAttributes<HTMLVertexViewerToolbarElement>;
             "vertex-viewer-toolbar-group": LocalJSX.VertexViewerToolbarGroup & JSXBase.HTMLAttributes<HTMLVertexViewerToolbarGroupElement>;
+            "vertex-viewer-transform-widget": LocalJSX.VertexViewerTransformWidget & JSXBase.HTMLAttributes<HTMLVertexViewerTransformWidgetElement>;
             "vertex-viewer-view-cube": LocalJSX.VertexViewerViewCube & JSXBase.HTMLAttributes<HTMLVertexViewerViewCubeElement>;
         }
     }

package/dist/types/interfaces.d.ts

@@ -31,6 +31,7 @@ export interface HTMLDomRendererPositionableElement {
 export interface StreamAttributes {
   depthBuffers?: FrameType;
   experimentalGhosting?: number;
+  noDefaultLights?: boolean;
   featureLines?: FeatureLineOptions;
   featureHighlighting?: FeatureHighlightOptions;
   featureMaps?: FrameType;

package/dist/types/lib/cursors.d.ts

@@ -80,3 +80,13 @@ export declare const measurementWithArrowCursor: {
   offsetX: number;
   offsetY: number;
 };
+export declare const pinCursor: {
+  url: string;
+  offsetX: number;
+  offsetY: number;
+};
+export declare const labelPinCursor: {
+  url: string;
+  offsetX: number;
+  offsetY: number;
+};

package/dist/types/lib/interactions/baseInteractionHandler.d.ts

@@ -4,8 +4,8 @@ import { ConfigProvider } from '../config';
 import { InteractionApi } from './interactionApi';
 import { BaseEvent } from './interactionEvent';
 import { InteractionHandler } from './interactionHandler';
-import { PanInteraction, RotateInteraction, RotatePointInteraction, TwistInteraction, ZoomInteraction } from './mouseInteractions';
-export declare type InteractionType = 'rotate' | 'zoom' | 'pan' | 'twist' | 'rotate-point';
+import { PanInteraction, PivotInteraction, RotateInteraction, RotatePointInteraction, TwistInteraction, ZoomInteraction } from './mouseInteractions';
+export declare type InteractionType = 'rotate' | 'zoom' | 'pan' | 'twist' | 'rotate-point' | 'pivot';
 export declare abstract class BaseInteractionHandler implements InteractionHandler {
   protected downEvent: 'mousedown' | 'pointerdown';
   protected upEvent: 'mouseup' | 'pointerup';
@@ -15,6 +15,7 @@ export declare abstract class BaseInteractionHandler implements InteractionHandl
   private zoomInteraction;
   private panInteraction;
   private twistInteraction;
+  private pivotInteraction;
   private getConfig;
   protected interactionApi?: InteractionApi;
   protected element?: HTMLElement;
@@ -30,7 +31,7 @@ export declare abstract class BaseInteractionHandler implements InteractionHandl
   protected disableIndividualInteractions: boolean;
   private computedBodyStyle?;
   private primaryInteractionTypeChange;
-  constructor(downEvent: 'mousedown' | 'pointerdown', upEvent: 'mouseup' | 'pointerup', moveEvent: 'mousemove' | 'pointermove', rotateInteraction: RotateInteraction, rotatePointInteraction: RotatePointInteraction, zoomInteraction: ZoomInteraction, panInteraction: PanInteraction, twistInteraction: TwistInteraction, getConfig: ConfigProvider);
+  constructor(downEvent: 'mousedown' | 'pointerdown', upEvent: 'mouseup' | 'pointerup', moveEvent: 'mousemove' | 'pointermove', rotateInteraction: RotateInteraction, rotatePointInteraction: RotatePointInteraction, zoomInteraction: ZoomInteraction, panInteraction: PanInteraction, twistInteraction: TwistInteraction, pivotInteraction: PivotInteraction, getConfig: ConfigProvider);
   initialize(element: HTMLElement, api: InteractionApi): void;
   dispose(): void;
   onPrimaryInteractionTypeChange(listener: Listener<void>): Disposable;

package/dist/types/lib/interactions/interactionApi.d.ts

@@ -37,7 +37,7 @@ export declare abstract class InteractionApi {
   protected getConfig: InteractionConfigProvider;
   protected getScene: SceneProvider;
   protected getFrame: () => ReceivedFrame | undefined;
-  protected getViewport: () => Viewport;
+  getViewport: () => Viewport;
   private tapEmitter;
   private doubleTapEmitter;
   private longPressEmitter;
@@ -149,6 +149,15 @@ export declare abstract class InteractionApi {
    */
   zoomCamera(delta: number): Promise<void>;
   zoomCameraToPoint(point: Point.Point, delta: number): Promise<void>;
+  /**
+   * Performs a pivot operation of the scene's camera, updating the lookAt
+   * while maintaining the position, and requests a new image for the
+   * updated scene.
+   *
+   * @param degreesLocalX The angle to rotate the lookAt point around the local x-axis
+   * @param degreesLocalY The angle to rotate the lookAt point around the local y-axis
+   */
+  pivotCamera(degreesLocalX: number, degreesLocalY: number): Promise<void>;
   /**
    * Marks the end of an interaction.
    */

package/dist/types/lib/interactions/interactionApiOrthographic.d.ts

@@ -10,6 +10,13 @@ import { TapEventDetails } from './tapEventDetails';
 export declare class InteractionApiOrthographic extends InteractionApi {
   private orthographicZoomData?;
   constructor(stream: StreamApi, cursors: CursorManager, getConfig: InteractionConfigProvider, getScene: SceneProvider, getFrame: () => ReceivedFrame | undefined, getViewport: () => Viewport, tapEmitter: EventEmitter<TapEventDetails>, doubleTapEmitter: EventEmitter<TapEventDetails>, longPressEmitter: EventEmitter<TapEventDetails>, interactionStartedEmitter: EventEmitter<void>, interactionFinishedEmitter: EventEmitter<void>);
+  /**
+   * Returns a 3D point in world space for the given 2D point in viewport space.
+   *
+   * @param point A point in 2D viewport space to transform.
+   * @returns A 3D point in world space.
+   */
+  getWorldPointFromViewport(point: Point.Point): Promise<Vector3.Vector3 | undefined>;
   /**
    * Performs a pan operation of the scene's camera, and requests a new image
    * for the updated scene.

package/dist/types/lib/interactions/mouseInteractionHandler.d.ts

@@ -1,6 +1,6 @@
 import { ConfigProvider } from '../config';
 import { BaseInteractionHandler } from './baseInteractionHandler';
-import { PanInteraction, RotateInteraction, RotatePointInteraction, TwistInteraction, ZoomInteraction } from './mouseInteractions';
+import { PanInteraction, PivotInteraction, RotateInteraction, RotatePointInteraction, TwistInteraction, ZoomInteraction } from './mouseInteractions';
 export declare class MouseInteractionHandler extends BaseInteractionHandler {
-  constructor(getConfig: ConfigProvider, rotateInteraction?: RotateInteraction, rotatePointInteraction?: RotatePointInteraction, zoomInteraction?: ZoomInteraction, panInteraction?: PanInteraction, twistInteraction?: TwistInteraction);
+  constructor(getConfig: ConfigProvider, rotateInteraction?: RotateInteraction, rotatePointInteraction?: RotatePointInteraction, zoomInteraction?: ZoomInteraction, panInteraction?: PanInteraction, twistInteraction?: TwistInteraction, pivotInteraction?: PivotInteraction);
 }

package/dist/types/lib/interactions/mouseInteractions.d.ts

@@ -57,3 +57,9 @@ export declare class TwistInteraction extends MouseInteraction {
   drag(event: MouseEvent, api: InteractionApi): void;
   endDrag(event: MouseEvent, api: InteractionApi): void;
 }
+export declare class PivotInteraction extends MouseInteraction {
+  type: InteractionType;
+  beginDrag(event: MouseEvent, canvasPosition: Point.Point, api: InteractionApi): void;
+  drag(event: MouseEvent, api: InteractionApi): void;
+  endDrag(event: MouseEvent, api: InteractionApi): void;
+}