@vertexvis/viewer 0.10.2-canary.7 → 0.11.0

package/dist/types/components/viewer-markup-freeform.tsx/viewer-markup-freeform.d.ts

@@ -0,0 +1,116 @@
+import { h, EventEmitter } from '../../stencil-public-runtime';
+import { Point, Rectangle } from '@vertexvis/geometry';
+/**
+ * The supported markup modes.
+ *
+ * @see {@link ViewerMarkupFreeformMode.mode} - For more details about modes.
+ */
+export declare type ViewerMarkupFreeformMode = 'edit' | 'create' | '';
+export declare class ViewerMarkupFreeform {
+  /**
+   * The positions of the various points of this freeform markup. Can either be an array of
+   * `Point`s or a JSON string representation in the format of `[[x1, y1], [x2, y2]]` or
+   * `[{"x": 0, "y": 0}, {"x": 0, "y": 0}]`.
+   *
+   * Points are expected to be relative coordinates from `[-0.5, 0.5]`,
+   * e.g. `[0, 0]` corresponds to a point in the center of the viewport.
+   */
+  points?: Point.Point[];
+  /**
+   * The positions of the various points of this freeform markup. Can either be an array of
+   * `Point`s or a JSON string representation in the format of `[[x1, y1], [x2, y2]]` or
+   * `[{"x": 0, "y": 0}, {"x": 0, "y": 0}]`.
+   *
+   * Points are expected to be relative coordinates from `[-0.5, 0.5]`,
+   * e.g. `[0, 0]` corresponds to a point in the center of the viewport.
+   */
+  pointsJson?: string;
+  /**
+   * The bounds of the freeform. Can either be an instance of a `Rectangle` or
+   * a JSON string representation in the format of `[x, y, width, height]` or
+   * `{"x": 0, "y": 0, "width": 10, "height": 10}`.
+   *
+   * Bounds are expected to have relative coordinates, with `[x, y]` from `[-0.5, 0.5]`
+   * and `[width, height]` from `[0, 1]`, e.g. `[0, 0, 0.25, 0.25]`corresponds to a freeform
+   * with a diameter of one fourth the viewport's smallest size in the center of the viewport.
+   */
+  bounds?: Rectangle.Rectangle;
+  /**
+   * The bounds of the freeform. Can either be an instance of a `Rectangle` or
+   * a JSON string representation in the format of `[x, y, width, height]` or
+   * `{"x": 0, "y": 0, "width": 0.1, "height": 0.1}`.
+   *
+   * Bounds are expected to have relative coordinates, with `[x, y]` from `[-0.5, 0.5]`
+   * and `[width, height]` from `[0, 1]`, e.g. `[0, 0, 0.25, 0.25]`corresponds to a freeform
+   * with a diameter of one fourth the viewport's smallest size in the center of the viewport.
+   */
+  boundsJson?: string;
+  /**
+   * A mode that specifies how the markup component should behave. When
+   * unset, the component will not respond to interactions with the handles.
+   * When `edit`, the markup anchors are interactive and the user is able
+   * to reposition them. When `create`, anytime the user clicks on the canvas,
+   * a new markup will be performed.
+   */
+  mode: ViewerMarkupFreeformMode;
+  /**
+   * The viewer to connect to markups.
+   *
+   * This property will automatically be set when a child of a
+   * `<vertex-viewer-markup>` or `<vertex-viewer>` element.
+   */
+  viewer?: HTMLVertexViewerElement;
+  /**
+   * An event that is dispatched anytime the user begins editing the
+   * markup.
+   */
+  editBegin: EventEmitter<void>;
+  /**
+   * An event that is dispatched when the user has finished editing the
+   * markup.
+   */
+  editEnd: EventEmitter<void>;
+  /**
+   * An event that is dispatched when the user cancels editing of the
+   * markup.
+   */
+  editCancel: EventEmitter<void>;
+  private hostEl;
+  private elementBounds?;
+  private resizeStartPosition?;
+  private editAnchor;
+  private resizeBounds?;
+  private resizePoints?;
+  private screenPoints;
+  private min?;
+  private max?;
+  /**
+   * @ignore
+   */
+  protected componentWillLoad(): void;
+  protected componentDidLoad(): void;
+  dispose(): Promise<void>;
+  /**
+   * @ignore
+   */
+  protected handleViewerChanged(newViewer?: HTMLVertexViewerElement, oldViewer?: HTMLVertexViewerElement): void;
+  protected handlePointsJsonChange(): void;
+  protected handleBoundsJsonChange(): void;
+  private updateViewport;
+  private updatePointsFromProps;
+  render(): h.JSX.IntrinsicElements;
+  private addInteractionListeners;
+  private addDrawingInteractionListeners;
+  private addEditingInteractionListeners;
+  private removeInteractionListeners;
+  private removeDrawingInteractionListeners;
+  private removeEditingInteractionListeners;
+  private updateEditAnchor;
+  private updateBounds;
+  private updatePoints;
+  private startMarkup;
+  private endMarkup;
+  private endEdit;
+  private updateMinAndMax;
+  private convertPointsToScreen;
+}

package/dist/types/components/viewer-markup-tool/viewer-markup-tool.d.ts

@@ -3,7 +3,7 @@ import { Markup } from '../../lib/types/markup';
 /**
  * The types of markup that can be performed by this tool.
  */
-export declare type ViewerMarkupToolType = 'arrow' | 'circle';
+export declare type ViewerMarkupToolType = 'arrow' | 'circle' | 'freeform';
 export declare class ViewerMarkupTool {
   /**
    * An HTML template that describes the HTML to use for new arrow
@@ -17,6 +17,12 @@ export declare class ViewerMarkupTool {
    * `<vertex-viewer-markup-circle>`.
    */
   circleTemplateId?: string;
+  /**
+   * An HTML template that describes the HTML to use for new freeform
+   * markup. It's expected that the template contains a
+   * `<vertex-viewer-markup-freeform>`.
+   */
+  freeformTemplateId?: string;
   /**
    * The type of markup.
    *
@@ -69,6 +75,10 @@ export declare class ViewerMarkupTool {
    * @ignore
    */
   protected handleCircleTemplateIdChanged(): void;
+  /**
+   * @ignore
+   */
+  protected handleFreeformTemplateIdChanged(): void;
   /**
    * @ignore
    */
@@ -83,6 +93,8 @@ export declare class ViewerMarkupTool {
   protected render(): h.JSX.IntrinsicElements;
   private createArrowMarkupElement;
   private createCircleMarkupElement;
+  private createFreeformMarkupElement;
+  private createNewMarkupElement;
   private updateMarkupElement;
   private handleMarkupEditBegin;
   private handleMarkupEditEnd;

package/dist/types/components.d.ts

@@ -36,6 +36,7 @@ import { ViewerMarkupToolType } from "./components/viewer-markup-tool/viewer-mar
 import { Markup } from "./lib/types/markup";
 import { ViewerMarkupArrowMode } from "./components/viewer-markup-arrow/viewer-markup-arrow";
 import { ViewerMarkupCircleMode } from "./components/viewer-markup-circle/viewer-markup-circle";
+import { ViewerMarkupFreeformMode } from "./components/viewer-markup-freeform.tsx/viewer-markup-freeform";
 import { ViewerMarkupToolType as ViewerMarkupToolType1 } from "./components/viewer-markup-tool/viewer-markup-tool";
 import { ViewerMeasurementDistanceElementMetrics, ViewerMeasurementDistanceLabelFormatter, ViewerMeasurementDistanceMode } from "./components/viewer-measurement-distance/viewer-measurement-distance";
 import { Anchor } from "./components/viewer-measurement-distance/utils";
@@ -310,8 +311,7 @@ export namespace Components {
         /**
           * The default hex color or material to use when selecting items.
          */
-        "selectionMaterial": | string
-    | ColorMaterial;
+        "selectionMaterial": string | ColorMaterial;
         /**
           * Property used for internals or testing.
           * @private
@@ -494,7 +494,7 @@ export namespace Components {
           * @see {
           * @link ViewerMarkups.circleTemplateId}
          */
-        "addMarkup": (markup: Markup) => Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement>;
+        "addMarkup": (markup: Markup) => Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>;
         /**
           * An HTML template that describes the HTML to use for new arrow markup. It's expected that the template contains a `<vertex-viewer-markup-arrow>`.
          */
@@ -507,6 +507,10 @@ export namespace Components {
           * If `true`, disables adding or editing of markup through user interaction.
          */
         "disabled": boolean;
+        /**
+          * An HTML template that describes the HTML to use for new freeform markup. It's expected that the template contains a `<vertex-viewer-markup-freeform>`.
+         */
+        "freeformTemplateId"?: string;
         /**
           * Returns the markup element associated to the given ID.
           * @param id The ID of the markup element to return.
@@ -514,20 +518,20 @@ export namespace Components {
           * @see {
           * @link ViewerMarkup.getMarkupElements}
          */
-        "getMarkupElement": (id: string) => Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | undefined>;
+        "getMarkupElement": (id: string) => Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement | undefined>;
         /**
           * Returns a list of markup elements that are children of this component.
           * @returns A list of all markups.
           * @see {
           * @link ViewerMarkup.getMarkupElement}
          */
-        "getMarkupElements": () => Promise<Array<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement>>;
+        "getMarkupElements": () => Promise<Array<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>>;
         /**
           * Removes a markup with the given ID, and returns the HTML element associated to the markup. Returns `undefined` if no markup is found.
           * @param id The ID of the markup to remove.
           * @returns The markup element, or undefined.
          */
-        "removeMarkup": (id: string) => Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | undefined>;
+        "removeMarkup": (id: string) => Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement | undefined>;
         /**
           * The ID of the markup that is selected.
          */
@@ -587,6 +591,33 @@ export namespace Components {
          */
         "viewer"?: HTMLVertexViewerElement;
     }
+    interface VertexViewerMarkupFreeform {
+        /**
+          * The bounds of the freeform. Can either be an instance of a `Rectangle` or a JSON string representation in the format of `[x, y, width, height]` or `{"x": 0, "y": 0, "width": 10, "height": 10}`.  Bounds are expected to have relative coordinates, with `[x, y]` from `[-0.5, 0.5]` and `[width, height]` from `[0, 1]`, e.g. `[0, 0, 0.25, 0.25]`corresponds to a freeform with a diameter of one fourth the viewport's smallest size in the center of the viewport.
+         */
+        "bounds"?: Rectangle.Rectangle;
+        /**
+          * The bounds of the freeform. Can either be an instance of a `Rectangle` or a JSON string representation in the format of `[x, y, width, height]` or `{"x": 0, "y": 0, "width": 0.1, "height": 0.1}`.  Bounds are expected to have relative coordinates, with `[x, y]` from `[-0.5, 0.5]` and `[width, height]` from `[0, 1]`, e.g. `[0, 0, 0.25, 0.25]`corresponds to a freeform with a diameter of one fourth the viewport's smallest size in the center of the viewport.
+         */
+        "boundsJson"?: string;
+        "dispose": () => Promise<void>;
+        /**
+          * A mode that specifies how the markup component should behave. When unset, the component will not respond to interactions with the handles. When `edit`, the markup anchors are interactive and the user is able to reposition them. When `create`, anytime the user clicks on the canvas, a new markup will be performed.
+         */
+        "mode": ViewerMarkupFreeformMode;
+        /**
+          * The positions of the various points of this freeform markup. Can either be an array of `Point`s or a JSON string representation in the format of `[[x1, y1], [x2, y2]]` or `[{"x": 0, "y": 0}, {"x": 0, "y": 0}]`.  Points are expected to be relative coordinates from `[-0.5, 0.5]`, e.g. `[0, 0]` corresponds to a point in the center of the viewport.
+         */
+        "points"?: Point.Point[];
+        /**
+          * The positions of the various points of this freeform markup. Can either be an array of `Point`s or a JSON string representation in the format of `[[x1, y1], [x2, y2]]` or `[{"x": 0, "y": 0}, {"x": 0, "y": 0}]`.  Points are expected to be relative coordinates from `[-0.5, 0.5]`, e.g. `[0, 0]` corresponds to a point in the center of the viewport.
+         */
+        "pointsJson"?: string;
+        /**
+          * The viewer to connect to markups.  This property will automatically be set when a child of a `<vertex-viewer-markup>` or `<vertex-viewer>` element.
+         */
+        "viewer"?: HTMLVertexViewerElement;
+    }
     interface VertexViewerMarkupTool {
         /**
           * An HTML template that describes the HTML to use for new arrow markup. It's expected that the template contains a `<vertex-viewer-markup-arrow>`.
@@ -600,6 +631,10 @@ export namespace Components {
           * Disables markups.  This property will automatically be set when a child of a `<vertex-viewer-markup>` element.
          */
         "disabled": boolean;
+        /**
+          * An HTML template that describes the HTML to use for new freeform markup. It's expected that the template contains a `<vertex-viewer-markup-freeform>`.
+         */
+        "freeformTemplateId"?: string;
         /**
           * The type of markup.  This property will automatically be set when a child of a `<vertex-viewer-markup>` element.
          */
@@ -950,6 +985,12 @@ declare global {
         prototype: HTMLVertexViewerMarkupCircleElement;
         new (): HTMLVertexViewerMarkupCircleElement;
     };
+    interface HTMLVertexViewerMarkupFreeformElement extends Components.VertexViewerMarkupFreeform, HTMLStencilElement {
+    }
+    var HTMLVertexViewerMarkupFreeformElement: {
+        prototype: HTMLVertexViewerMarkupFreeformElement;
+        new (): HTMLVertexViewerMarkupFreeformElement;
+    };
     interface HTMLVertexViewerMarkupToolElement extends Components.VertexViewerMarkupTool, HTMLStencilElement {
     }
     var HTMLVertexViewerMarkupToolElement: {
@@ -1015,6 +1056,7 @@ declare global {
         "vertex-viewer-markup": HTMLVertexViewerMarkupElement;
         "vertex-viewer-markup-arrow": HTMLVertexViewerMarkupArrowElement;
         "vertex-viewer-markup-circle": HTMLVertexViewerMarkupCircleElement;
+        "vertex-viewer-markup-freeform": HTMLVertexViewerMarkupFreeformElement;
         "vertex-viewer-markup-tool": HTMLVertexViewerMarkupToolElement;
         "vertex-viewer-measurement-distance": HTMLVertexViewerMeasurementDistanceElement;
         "vertex-viewer-measurement-line": HTMLVertexViewerMeasurementLineElement;
@@ -1183,6 +1225,10 @@ declare namespace LocalJSX {
           * Emits an event whenever the user taps or clicks a location in the viewer and the configured amount of time passes without receiving a mouseup or touchend. The event includes the location of the tap or click.
          */
         "onLongpress"?: (event: CustomEvent<TapEventDetails>) => void;
+        /**
+          * Emits an event when a frame is received with a different scene attribute.
+         */
+        "onSceneChanged"?: (event: CustomEvent<void>) => void;
         /**
           * Emits an event when the scene is ready to be interacted with.
          */
@@ -1207,8 +1253,7 @@ declare namespace LocalJSX {
         /**
           * The default hex color or material to use when selecting items.
          */
-        "selectionMaterial"?: | string
-    | ColorMaterial;
+        "selectionMaterial"?: string | ColorMaterial;
         /**
           * Property used for internals or testing.
           * @private
@@ -1388,14 +1433,22 @@ declare namespace LocalJSX {
           * If `true`, disables adding or editing of markup through user interaction.
          */
         "disabled"?: boolean;
+        /**
+          * An HTML template that describes the HTML to use for new freeform markup. It's expected that the template contains a `<vertex-viewer-markup-freeform>`.
+         */
+        "freeformTemplateId"?: string;
         /**
           * Dispatched when a new markup is added, either through user interaction or programmatically.
          */
-        "onMarkupAdded"?: (event: CustomEvent<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement>) => void;
+        "onMarkupAdded"?: (event: CustomEvent<| HTMLVertexViewerMarkupArrowElement
+    | HTMLVertexViewerMarkupCircleElement
+    | HTMLVertexViewerMarkupFreeformElement>) => void;
         /**
           * Dispatched when a markup is removed, either through user interaction or programmatically.
          */
-        "onMarkupRemoved"?: (event: CustomEvent<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement>) => void;
+        "onMarkupRemoved"?: (event: CustomEvent<| HTMLVertexViewerMarkupArrowElement
+    | HTMLVertexViewerMarkupCircleElement
+    | HTMLVertexViewerMarkupFreeformElement>) => void;
         /**
           * The ID of the markup that is selected.
          */
@@ -1477,6 +1530,44 @@ declare namespace LocalJSX {
          */
         "viewer"?: HTMLVertexViewerElement;
     }
+    interface VertexViewerMarkupFreeform {
+        /**
+          * The bounds of the freeform. Can either be an instance of a `Rectangle` or a JSON string representation in the format of `[x, y, width, height]` or `{"x": 0, "y": 0, "width": 10, "height": 10}`.  Bounds are expected to have relative coordinates, with `[x, y]` from `[-0.5, 0.5]` and `[width, height]` from `[0, 1]`, e.g. `[0, 0, 0.25, 0.25]`corresponds to a freeform with a diameter of one fourth the viewport's smallest size in the center of the viewport.
+         */
+        "bounds"?: Rectangle.Rectangle;
+        /**
+          * The bounds of the freeform. Can either be an instance of a `Rectangle` or a JSON string representation in the format of `[x, y, width, height]` or `{"x": 0, "y": 0, "width": 0.1, "height": 0.1}`.  Bounds are expected to have relative coordinates, with `[x, y]` from `[-0.5, 0.5]` and `[width, height]` from `[0, 1]`, e.g. `[0, 0, 0.25, 0.25]`corresponds to a freeform with a diameter of one fourth the viewport's smallest size in the center of the viewport.
+         */
+        "boundsJson"?: string;
+        /**
+          * A mode that specifies how the markup component should behave. When unset, the component will not respond to interactions with the handles. When `edit`, the markup anchors are interactive and the user is able to reposition them. When `create`, anytime the user clicks on the canvas, a new markup will be performed.
+         */
+        "mode"?: ViewerMarkupFreeformMode;
+        /**
+          * An event that is dispatched anytime the user begins editing the markup.
+         */
+        "onEditBegin"?: (event: CustomEvent<void>) => void;
+        /**
+          * An event that is dispatched when the user cancels editing of the markup.
+         */
+        "onEditCancel"?: (event: CustomEvent<void>) => void;
+        /**
+          * An event that is dispatched when the user has finished editing the markup.
+         */
+        "onEditEnd"?: (event: CustomEvent<void>) => void;
+        /**
+          * The positions of the various points of this freeform markup. Can either be an array of `Point`s or a JSON string representation in the format of `[[x1, y1], [x2, y2]]` or `[{"x": 0, "y": 0}, {"x": 0, "y": 0}]`.  Points are expected to be relative coordinates from `[-0.5, 0.5]`, e.g. `[0, 0]` corresponds to a point in the center of the viewport.
+         */
+        "points"?: Point.Point[];
+        /**
+          * The positions of the various points of this freeform markup. Can either be an array of `Point`s or a JSON string representation in the format of `[[x1, y1], [x2, y2]]` or `[{"x": 0, "y": 0}, {"x": 0, "y": 0}]`.  Points are expected to be relative coordinates from `[-0.5, 0.5]`, e.g. `[0, 0]` corresponds to a point in the center of the viewport.
+         */
+        "pointsJson"?: string;
+        /**
+          * The viewer to connect to markups.  This property will automatically be set when a child of a `<vertex-viewer-markup>` or `<vertex-viewer>` element.
+         */
+        "viewer"?: HTMLVertexViewerElement;
+    }
     interface VertexViewerMarkupTool {
         /**
           * An HTML template that describes the HTML to use for new arrow markup. It's expected that the template contains a `<vertex-viewer-markup-arrow>`.
@@ -1490,6 +1581,10 @@ declare namespace LocalJSX {
           * Disables markups.  This property will automatically be set when a child of a `<vertex-viewer-markup>` element.
          */
         "disabled"?: boolean;
+        /**
+          * An HTML template that describes the HTML to use for new freeform markup. It's expected that the template contains a `<vertex-viewer-markup-freeform>`.
+         */
+        "freeformTemplateId"?: string;
         /**
           * An event that is dispatched when a user begins a new markup.
          */
@@ -1760,6 +1855,7 @@ declare namespace LocalJSX {
         "vertex-viewer-markup": VertexViewerMarkup;
         "vertex-viewer-markup-arrow": VertexViewerMarkupArrow;
         "vertex-viewer-markup-circle": VertexViewerMarkupCircle;
+        "vertex-viewer-markup-freeform": VertexViewerMarkupFreeform;
         "vertex-viewer-markup-tool": VertexViewerMarkupTool;
         "vertex-viewer-measurement-distance": VertexViewerMeasurementDistance;
         "vertex-viewer-measurement-line": VertexViewerMeasurementLine;
@@ -1790,6 +1886,7 @@ declare module "@stencil/core" {
             "vertex-viewer-markup": LocalJSX.VertexViewerMarkup & JSXBase.HTMLAttributes<HTMLVertexViewerMarkupElement>;
             "vertex-viewer-markup-arrow": LocalJSX.VertexViewerMarkupArrow & JSXBase.HTMLAttributes<HTMLVertexViewerMarkupArrowElement>;
             "vertex-viewer-markup-circle": LocalJSX.VertexViewerMarkupCircle & JSXBase.HTMLAttributes<HTMLVertexViewerMarkupCircleElement>;
+            "vertex-viewer-markup-freeform": LocalJSX.VertexViewerMarkupFreeform & JSXBase.HTMLAttributes<HTMLVertexViewerMarkupFreeformElement>;
             "vertex-viewer-markup-tool": LocalJSX.VertexViewerMarkupTool & JSXBase.HTMLAttributes<HTMLVertexViewerMarkupToolElement>;
             "vertex-viewer-measurement-distance": LocalJSX.VertexViewerMeasurementDistance & JSXBase.HTMLAttributes<HTMLVertexViewerMeasurementDistanceElement>;
             "vertex-viewer-measurement-line": LocalJSX.VertexViewerMeasurementLine & JSXBase.HTMLAttributes<HTMLVertexViewerMeasurementLineElement>;

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

@@ -1,17 +1,19 @@
-import { BoundingBox, Dimensions, Point, Ray } from '@vertexvis/geometry';
+import { BoundingBox, Point, Ray } from '@vertexvis/geometry';
 import { EventEmitter } from '../../stencil-public-runtime';
 import { TapEventDetails, TapEventKeys } from './tapEventDetails';
 import { StreamApi } from '@vertexvis/stream-api';
 import { Scene, Camera } from '../scenes';
-import { Interactions, Viewport } from '../types';
+import { DepthBuffer, Interactions, Viewport } from '../types';
 import { ReceivedFrame } from '../..';
 declare type SceneProvider = () => Scene;
 declare type InteractionConfigProvider = () => Interactions.InteractionConfig;
 declare type CameraTransform = (data: {
   camera: Camera;
-  viewport: Dimensions.Dimensions;
+  viewport: Viewport;
   scale: Point.Point;
   boundingBox: BoundingBox.BoundingBox;
+  frame: ReceivedFrame;
+  depthBuffer?: DepthBuffer;
 }) => Camera;
 /**
  * The `InteractionApi` provides methods that API developers can use to modify
@@ -31,6 +33,8 @@ export declare class InteractionApi {
   private currentCamera?;
   private lastAngle;
   private worldRotationPoint?;
+  private panData?;
+  private zoomData?;
   constructor(stream: StreamApi, getConfig: InteractionConfigProvider, getScene: SceneProvider, getFrame: () => ReceivedFrame | undefined, getViewport: () => Viewport, tapEmitter: EventEmitter<TapEventDetails>, doubleTapEmitter: EventEmitter<TapEventDetails>, longPressEmitter: EventEmitter<TapEventDetails>, interactionStartedEmitter: EventEmitter<void>, interactionFinishedEmitter: EventEmitter<void>);
   /**
    * Generates a ray from the given point, in viewport coordinates.
@@ -74,6 +78,17 @@ export declare class InteractionApi {
    */
   twistCamera(delta: number): Promise<void>;
   twistCamera(delta: Point.Point): Promise<void>;
+  /**
+   * Moves the camera's position and look at to the given screen coordinate.
+   *
+   * If the screen coordinate intersects with an object, the camera will track
+   * the hit point so the mouse position is always under the mouse.
+   *
+   * If the screen coordinate doesn't intersect with an object, then ???.
+   *
+   * @param screenPt A point in screen coordinates.
+   */
+  panCameraToScreenPoint(screenPt: Point.Point): Promise<void>;
   /**
    * Performs a pan operation of the scene's camera, and requests a new image
    * for the updated scene.
@@ -81,7 +96,7 @@ export declare class InteractionApi {
    * @param delta A position delta `{x, y}` in the 2D coordinate space of the
    *  viewer.
    */
-  panCamera(delta: Point.Point): Promise<void>;
+  panCameraByDelta(delta: Point.Point): Promise<void>;
   /**
    * Performs a rotate operation of the scene around the camera's look at point,
    * and requests a new image for the updated scene.
@@ -98,7 +113,8 @@ export declare class InteractionApi {
    * @param delta The distance to zoom. Positive values zoom in and negative
    *  values zoom out.
    */
-  zoomCamera(delta: number, ray?: Ray.Ray): Promise<void>;
+  zoomCamera(delta: number): Promise<void>;
+  zoomCameraToPoint(point: Point.Point, delta: number): Promise<void>;
   /**
    * Marks the end of an interaction.
    */
@@ -124,6 +140,6 @@ export declare class InteractionApi {
   pixelThreshold(isTouch?: boolean): number;
   private emitTapEvent;
   private isCoarseInputDevice;
-  private getWorldRotationPoint;
+  private getWorldPoint;
 }
 export {};

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

@@ -1,5 +1,5 @@
 import { InteractionApi } from './interactionApi';
-import { Point, Ray } from '@vertexvis/geometry';
+import { Point } from '@vertexvis/geometry';
 import { InteractionType } from './baseInteractionHandler';
 export declare abstract class MouseInteraction {
   protected currentPosition: Point.Point | undefined;
@@ -7,7 +7,7 @@ export declare abstract class MouseInteraction {
   setPosition(position?: Point.Point): void;
   getPosition(): Point.Point | undefined;
   getType(): InteractionType;
-  beginDrag(event: MouseEvent, canvasPosition: Point.Point, api: InteractionApi, element?: HTMLElement): void;
+  beginDrag(event: MouseEvent, canvasPosition: Point.Point, api: InteractionApi, element: HTMLElement): void;
   drag(event: MouseEvent, api: InteractionApi): void;
   endDrag(event: MouseEvent, api: InteractionApi): void;
   zoom(delta: number, api: InteractionApi): void;
@@ -30,13 +30,13 @@ export declare class ZoomInteraction extends MouseInteraction {
   type: InteractionType;
   private didTransformBegin;
   private interactionTimer;
-  private startRay?;
+  private startPt?;
   constructor(interactionTimeout?: number);
-  beginDrag(event: MouseEvent, canvasPosition: Point.Point, api: InteractionApi, element?: HTMLElement): void;
+  beginDrag(event: MouseEvent, canvasPosition: Point.Point, api: InteractionApi, element: HTMLElement): void;
   drag(event: MouseEvent, api: InteractionApi): void;
   endDrag(event: MouseEvent, api: InteractionApi): void;
   zoom(delta: number, api: InteractionApi): void;
-  zoomOnRay(delta: number, ray: Ray.Ray, api: InteractionApi): void;
+  zoomToPoint(pt: Point.Point, delta: number, api: InteractionApi): void;
   private beginInteraction;
   private endInteraction;
   private resetInteractionTimer;
@@ -46,7 +46,8 @@ export declare class ZoomInteraction extends MouseInteraction {
 }
 export declare class PanInteraction extends MouseInteraction {
   type: InteractionType;
-  beginDrag(event: MouseEvent, canvasPosition: Point.Point, api: InteractionApi): void;
+  private canvasRect?;
+  beginDrag(event: MouseEvent, canvasPosition: Point.Point, api: InteractionApi, element: HTMLElement): void;
   drag(event: MouseEvent, api: InteractionApi): void;
   endDrag(event: MouseEvent, api: InteractionApi): void;
 }

package/dist/types/lib/scenes/camera.d.ts

@@ -1,4 +1,4 @@
-import { Animation, FlyTo, FrameCamera, StandardView } from '../types';
+import { Animation, FlyTo, FrameCamera, FramePerspectiveCamera, StandardView } from '../types';
 import { Vector3, BoundingBox } from '@vertexvis/geometry';
 import { StreamApi } from '@vertexvis/stream-api';
 import { CameraRenderResult } from './cameraRenderResult';
@@ -108,6 +108,10 @@ export declare class Camera implements FrameCamera.FrameCamera {
    * @param camera The values to update the camera to.
    */
   update(camera: Partial<FrameCamera.FrameCamera>): Camera;
+  /**
+   * Returns a `FramePerspectiveCamera` representation.
+   */
+  toFrameCamera(): FramePerspectiveCamera;
   private buildFlyToType;
   private computeClippingPlanes;
   /**

package/dist/types/lib/scenes/scene.d.ts

@@ -62,7 +62,7 @@ export declare class Scene {
   /**
    * Applies the provided scene view state to the scene.
    */
-  applySceneViewState(sceneViewStateId: UUID.UUID): Promise<vertexvis.protobuf.stream.ILoadSceneViewStateResult | undefined>;
+  applySceneViewState(sceneViewStateId: UUID.UUID, opts?: SceneExecutionOptions): Promise<vertexvis.protobuf.stream.ILoadSceneViewStateResult | undefined>;
   /**
    * Returns an executor that accepts a function as a parameter that contains one or many operations to apply
    * to the scene view. The operations will be applied transactionally.

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

@@ -32,12 +32,14 @@ export declare class FrameScene {
   readonly boundingBox: BoundingBox.BoundingBox;
   readonly crossSection: CrossSectioning.CrossSectioning;
   readonly worldOrientation: Orientation;
-  constructor(camera: FramePerspectiveCamera, boundingBox: BoundingBox.BoundingBox, crossSection: CrossSectioning.CrossSectioning, worldOrientation: Orientation);
+  readonly hasChanged: boolean;
+  constructor(camera: FramePerspectiveCamera, boundingBox: BoundingBox.BoundingBox, crossSection: CrossSectioning.CrossSectioning, worldOrientation: Orientation, hasChanged: boolean);
 }
 interface FrameCameraMatrices {
   readonly worldMatrix: Matrix4.Matrix4;
   readonly viewMatrix: Matrix4.Matrix4;
   readonly projectionMatrix: Matrix4.Matrix4;
+  readonly projectionMatrixInverse: Matrix4.Matrix4;
   readonly projectionViewMatrix: Matrix4.Matrix4;
 }
 interface FramePerspectiveCameraLike {
@@ -65,6 +67,7 @@ export declare class FramePerspectiveCamera implements FrameCameraMatrices, Fram
   get worldMatrix(): Matrix4.Matrix4;
   get viewMatrix(): Matrix4.Matrix4;
   get projectionMatrix(): Matrix4.Matrix4;
+  get projectionMatrixInverse(): Matrix4.Matrix4;
   get projectionViewMatrix(): Matrix4.Matrix4;
 }
 export {};

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

@@ -19,4 +19,15 @@ export declare class CircleMarkup {
   readonly id: string;
   constructor(init: CircleMarkupInit);
 }
-export declare type Markup = ArrowMarkup | CircleMarkup;
+export interface FreeformMarkupInit {
+  bounds?: Rectangle.Rectangle;
+  points?: Point.Point[];
+  id?: string;
+}
+export declare class FreeformMarkup {
+  readonly bounds: Rectangle.Rectangle;
+  readonly points: Point.Point[];
+  readonly id: string;
+  constructor(init: FreeformMarkupInit);
+}
+export declare type Markup = ArrowMarkup | CircleMarkup | FreeformMarkup;

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

@@ -88,6 +88,23 @@ export declare class Viewport implements Dimensions.Dimensions {
    * @returns
    */
   transformPointToRay(pt: Point.Point, image: FrameImageLike, camera: FramePerspectiveCamera): Ray.Ray;
+  /**
+   * Maps a screen point to normalized device coordinates (NDC). A screen point
+   * at 0,0 represents the top-left of the viewport.
+   *
+   * @param screenPt A screen point.
+   */
+  transformScreenPointToNdc(screenPt: Point.Point, image: FrameImageLike): Point.Point;
+  /**
+   * Maps a point in screen space to a world point that is coplanar with the
+   * camera's near plane.
+   *
+   * @param screenPt The screen point to transform.
+   * @param image An image of frame.
+   * @param camera The camera used to map a 2D point to 3D point.
+   * @returns A point on the screen in world space.
+   */
+  transformPointToScreenWorld(screenPt: Point.Point, image: FrameImageLike, camera: FramePerspectiveCamera): Vector3.Vector3 | undefined;
   /**
    * Computes a rectangle that is scaled correctly to be drawn within the
    * viewport.

package/dist/viewer/index.esm.js

@@ -1,4 +1,4 @@
 /**!
  * Copyright (c) 2021 Vertex Software LLC. All rights reserved.
  */
-export{c as ColorMaterial,l as LoadableResource,S as Scene,a as SynchronizedClock}from"./p-964642c6.js";export{C as CursorManager,m as measurementCursor}from"./p-f4a492e1.js";export{F as ReceivedFrame,a as ReceivedFrameImage,b as ReceivedFrameScene,c as ReceivedPerspectiveCamera}from"./p-b5c350a7.js";export{A as ArrowMarkup,C as CircleMarkup}from"./p-a717d9ff.js";export{V as Viewport}from"./p-11bdd2c4.js";import"./p-6d4ab5fc.js";import"./p-d912dd24.js";import"./p-112455b1.js";
+export{c as ColorMaterial,l as LoadableResource,S as Scene,a as SynchronizedClock}from"./p-b122ee39.js";export{C as CursorManager,m as measurementCursor}from"./p-9faabd97.js";export{F as ReceivedFrame,a as ReceivedFrameImage,b as ReceivedFrameScene,c as ReceivedPerspectiveCamera}from"./p-21e8510d.js";export{A as ArrowMarkup,C as CircleMarkup,F as FreeformMarkup}from"./p-5389e9d4.js";export{V as Viewport}from"./p-b36b3d1a.js";import"./p-59d075d4.js";import"./p-640cb5f8.js";import"./p-112455b1.js";

package/dist/viewer/p-012fb54f.js

@@ -0,0 +1,4 @@
+/**!
+ * Copyright (c) 2021 Vertex Software LLC. All rights reserved.
+ */
+import{v as t}from"./p-640cb5f8.js";import{a as s}from"./p-59d075d4.js";class i{constructor(i){var r,o,e,l;this.start=null!==(r=i.start)&&void 0!==r?r:t.origin(),this.end=null!==(o=i.end)&&void 0!==o?o:t.origin(),this.invalid=null!==(e=i.invalid)&&void 0!==e&&e,this.id=null!==(l=i.id)&&void 0!==l?l:`measurement--${s.create()}`}getWorldDistance(){return t.distance(this.start,this.end)}getRealDistance(t){return t.translateRealValueToWorld(this.getWorldDistance())}}export{i as D}