@vertexvis/viewer 0.13.2-canary.9 → 0.14.0

package/dist/types/components/viewer/viewer.d.ts

@@ -14,6 +14,7 @@ import { Scene } from '../../lib/scenes/scene';
 import { ViewerStream } from '../../lib/stream/stream';
 import { StencilBufferManager, Viewport } from '../../lib/types';
 import { Frame } from '../../lib/types/frame';
+import { FrameCameraType } from '../../lib/types/frameCamera';
 interface ConnectedStatus {
   jwt: string;
   status: 'connected';
@@ -73,7 +74,7 @@ export declare class Viewer {
    * 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;
   /**
    * Enables or disables the default keyboard shortcut interactions provided by
    * the viewer. Enabled by default, requires `cameraControls` being enabled.
@@ -112,6 +113,12 @@ export declare class Viewer {
    * **Note:** This feature is experimental, and may cause slower frame rates.
    */
   experimentalGhostingOpacity: number;
+  /**
+   * 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;
   /**
    * Specifies if and how to render feature lines.
    */
@@ -220,6 +227,10 @@ export declare class Viewer {
    * Emits an event when the user hs finished an interaction.
    */
   interactionFinished: EventEmitter<void>;
+  /**
+   * Emits an event when the camera type changes.
+   */
+  cameraTypeChanged: EventEmitter<FrameCameraType>;
   /**
    * Used for internals or testing.
    *
@@ -386,6 +397,7 @@ export declare class Viewer {
    * @ignore
    */
   protected handleExperimentalGhostingOpacityChanged(): void;
+  protected handleNoDefaultLightsChanged(): void;
   /**
    * @ignore
    */

package/dist/types/components/viewer-dom-element/viewer-dom-element.d.ts

@@ -1,4 +1,4 @@
-import { h } from '../../stencil-public-runtime';
+import { EventEmitter, h } from '../../stencil-public-runtime';
 import { Euler, Matrix4, Quaternion, Vector3 } from '@vertexvis/geometry';
 import { HTMLDomRendererPositionableElement } from '../../interfaces';
 /**
@@ -53,7 +53,7 @@ export declare class ViewerDomElement implements HTMLDomRendererPositionableElem
    */
   protected handleQuaternionChange(): void;
   /**
-   * The local rotation of this element, as a JSON string. JSON
+   * 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}`.
    */
@@ -80,6 +80,10 @@ export declare class ViewerDomElement implements HTMLDomRendererPositionableElem
    * @ignore
    */
   protected handleScaleJsonChanged(): void;
+  /**
+   * @ignore
+   */
+  protected handleMatrixChanged(newMatrix: Matrix4.Matrix4, oldMatrix: Matrix4.Matrix4): void;
   /**
    * The local matrix of this element.
    */
@@ -116,6 +120,10 @@ export declare class ViewerDomElement implements HTMLDomRendererPositionableElem
    * Disables interaction events from children.
    */
   interactionsOff: boolean;
+  /**
+   * An event that is emitted when any property on the dom group changes
+   */
+  propertyChange: EventEmitter<void>;
   /**
    * @ignore
    */

package/dist/types/components/viewer-dom-group/viewer-dom-group.d.ts

@@ -1,4 +1,4 @@
-import { h } from '../../stencil-public-runtime';
+import { EventEmitter, h } from '../../stencil-public-runtime';
 import { Euler, Matrix4, Quaternion, Vector3 } from '@vertexvis/geometry';
 import { HTMLDomRendererPositionableElement } from '../../interfaces';
 export declare class ViewerDomGroup implements HTMLDomRendererPositionableElement {
@@ -20,6 +20,10 @@ export declare class ViewerDomGroup implements HTMLDomRendererPositionableElemen
    * @ignore
    */
   protected handlePositionJsonChanged(): void;
+  /**
+   * An event that is emitted when any property on the dom group changes
+   */
+  propertyChange: EventEmitter<void>;
   /**
    * The local rotation of this element in Euler angles.
    */
@@ -74,6 +78,10 @@ export declare class ViewerDomGroup implements HTMLDomRendererPositionableElemen
    * @ignore
    */
   protected handleScaleJsonChanged(): void;
+  /**
+   * @ignore
+   */
+  protected handleMatrixChanged(newMatrix: Matrix4.Matrix4, oldMatrix: Matrix4.Matrix4): void;
   /**
    * The local matrix of this element.
    */

package/dist/types/components/viewer-icon/viewer-icon.d.ts

@@ -2,7 +2,7 @@ import { h } from '../../stencil-public-runtime';
 /**
  * The names of the icons that the `<vertex-viewer-icon>` element can display.
  */
-export declare type ViewerIconName = 'fit-all' | 'eye-open' | 'eye-half' | 'eye-half-dotted' | 'chevron-right' | 'chevron-down' | 'search' | 'close-circle';
+export declare type ViewerIconName = 'fit-all' | 'eye-open' | 'eye-half' | 'eye-half-dotted' | 'chevron-right' | 'chevron-down' | 'search' | 'close-circle' | 'pin-fill';
 /**
  * The predefined sizes for icons.
  */

package/dist/types/components/viewer-pin-group/pin-renderer.d.ts

@@ -0,0 +1,8 @@
+import { FunctionalComponent } from '../../stencil-public-runtime';
+import { Pin } from '../../lib/pins/model';
+interface PinRendererProps {
+  pin?: Pin;
+  selected: boolean;
+}
+export declare const PinRenderer: FunctionalComponent<PinRendererProps>;
+export {};

package/dist/types/components/viewer-pin-group/utils.d.ts

@@ -0,0 +1,2 @@
+import { Dimensions, Point } from '@vertexvis/geometry';
+export declare function getClosestCenterToPoint(boxPoint: Point.Point, pointToMeasure: Point.Point, dimensions: Dimensions.Dimensions): Point.Point;

package/dist/types/components/viewer-pin-group/viewer-pin-group.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="react" />
+import { Matrix4 } from '@vertexvis/geometry';
+import { PinController } from '../../lib/pins/controller';
+import { Pin } from '../../lib/pins/model';
+import { PinModel } from '../../lib/pins/model';
+export declare class ViewerPinGroup {
+  /**
+   * The pin to draw for the group
+   */
+  pin?: Pin;
+  /**
+   * The local matrix of this element.
+   */
+  matrix: Matrix4.Matrix4;
+  /**
+   * Projection view matrix used for computing the position of the pin line
+   */
+  projectionViewMatrix: Matrix4.Matrix4;
+  /**
+   * The dimensions of the canvas for the pins
+   */
+  elementBounds?: DOMRect;
+  /**
+   * The model that contains the entities and outcomes from performing pin operations
+   */
+  pinModel: PinModel;
+  /**
+   * The controller that drives behavior for pin operations
+   */
+  pinController?: PinController;
+  /**
+   * Whether or not the pin is "selected"
+   */
+  selected: boolean;
+  private invalidateStateCounter;
+  private leafNodesRendered;
+  private labelEl;
+  private resizeObserver?;
+  protected componentDidLoad(): void;
+  protected disconnectedCallback(): void;
+  protected render(): JSX.Element;
+  private invalidateState;
+  private setLabelObserver;
+  private computePinPoints;
+  private computeDefaultPinPoints;
+  private computeTextPinPoints;
+  private handleAnchorPointerDown;
+  private getFromWorldPosition;
+}

package/dist/types/components/viewer-pin-label/utils.d.ts

@@ -0,0 +1 @@
+export declare function getComputedStyle(el: HTMLElement): CSSStyleDeclaration;

package/dist/types/components/viewer-pin-label/viewer-pin-label.d.ts

@@ -0,0 +1,77 @@
+/// <reference types="react" />
+import { EventEmitter } from '../../stencil-public-runtime';
+import { PinController } from '../../lib/pins/controller';
+import { TextPin } from '../../lib/pins/model';
+export declare class VertexPinLabel {
+  /**
+   * The pin to draw for the group
+   */
+  pin?: TextPin;
+  /**
+   * The dimensions of the canvas for the pins
+   */
+  elementBounds?: DOMRect;
+  /**
+   * The current text value of the component. Value is updated on user
+   * interaction.
+   */
+  value: string;
+  /**
+   * The controller that drives behavior for pin operations
+   */
+  pinController?: PinController;
+  /**
+   * @internal
+   */
+  labelChanged: EventEmitter<void>;
+  /**
+   * Emitted whenever the label is focused, with the ID of the
+   * associated pin (or undefined if no pin is provided).
+   */
+  labelFocused: EventEmitter<string | undefined>;
+  /**
+   * Emitted whenever the label is blurred, with the ID of the
+   * associated pin (or undefined if no pin is provided).
+   */
+  labelBlurred: EventEmitter<string | undefined>;
+  private hostEl;
+  private focused;
+  private computedScreenPosition?;
+  private textareaRows;
+  private contentElBounds?;
+  private relativePointerDownPosition?;
+  private pinPointerDownPosition?;
+  private inputEl?;
+  private contentEl?;
+  private resizeObserver?;
+  private contentResizeObserver?;
+  constructor();
+  /**
+   * Gives focus to the the component's internal text input.
+   */
+  setFocus(): Promise<void>;
+  protected watchFocusChange(): void;
+  protected watchPinChange(): void;
+  protected watchElementBoundsChange(): void;
+  protected componentWillLoad(): void;
+  protected componentDidLoad(): void;
+  protected disconnectedCallback(): void;
+  protected componentDidRender(): void;
+  protected render(): JSX.Element;
+  private hiddenContent;
+  private computeMinWidth;
+  private computeMaxWidth;
+  private computeMaxHeight;
+  private computeRemainingWidth;
+  private computeRemainingHeight;
+  private getPinText;
+  private computeScreenPosition;
+  private computeContentSize;
+  private handleInputKeyDown;
+  private handlePointerDown;
+  private handlePointerMove;
+  private handlePointerUp;
+  private handleTextBlur;
+  private submit;
+  private handleTextInput;
+}

package/dist/types/components/viewer-pin-label-line/viewer-pin-label-line.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { Point } from '@vertexvis/geometry';
+export declare class VertexPinLabelLine {
+  pinPoint: Point.Point | undefined;
+  labelPoint: Point.Point | undefined;
+  protected render(): JSX.Element;
+}

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

@@ -0,0 +1,68 @@
+/// <reference types="react" />
+import { PinController } from '../../lib/pins/controller';
+import { Pin, PinModel, ViewerPinToolMode, ViewerPinToolType } from '../../lib/pins/model';
+export declare class ViewerPinTool {
+  /**
+   * 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[];
+  private selectedPinId?;
+  /**
+   * 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;
+  /**
+   * The type of pin.
+   *
+   * This property will automatically be set.
+   */
+  tool: ViewerPinToolType;
+  /**
+   * The mode of the pin tool
+   */
+  mode: ViewerPinToolMode;
+  private hostEl;
+  private elementBounds?;
+  private projectionViewMatrix?;
+  private registeredInteractionHandler?;
+  private onEntitiesChangedHandler?;
+  private resizeObserver?;
+  /**
+   * @ignore
+   */
+  protected watchModeChange(): void;
+  /**
+   * @ignore
+   */
+  protected watchTypeChange(): void;
+  /**
+   * @ignore
+   */
+  protected connectedCallback(): void;
+  /**
+   * @ignore
+   */
+  protected componentWillLoad(): void;
+  protected componentDidLoad(): void;
+  /**
+   * @ignore
+   */
+  protected disconnectedCallback(): void;
+  /**
+   * @ignore
+   */
+  protected handleViewerChanged(newViewer?: HTMLVertexViewerElement, oldViewer?: HTMLVertexViewerElement): void;
+  private handleSetProjectionMatrix;
+  protected render(): JSX.Element;
+  private setupController;
+  private clearInteractionHandler;
+  private setupInteractionHandler;
+  private clearModelListeners;
+  private updateViewport;
+}

package/dist/types/components/viewer-transform-widget/__mocks__/widget.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="jest" />
+export declare class TransformWidget {
+  boundsContainsPoint: jest.Mock<any, any>;
+  onHoveredChanged: jest.Mock<any, any>;
+  updateTransform: jest.Mock<any, any>;
+  updateFrame: jest.Mock<any, any>;
+  updateCursor: jest.Mock<any, any>;
+  updateColors: jest.Mock<any, any>;
+  updateDimensions: jest.Mock<any, any>;
+  constructor(...args: unknown[]);
+}

package/dist/types/components/viewer-transform-widget/util.d.ts

@@ -0,0 +1,5 @@
+import { Matrix4, Point, Vector3 } from '@vertexvis/geometry';
+import { Frame, Viewport } from '../../lib/types';
+export declare function convertPointToCanvas(point: Point.Point, bounds?: DOMRect): Point.Point | undefined;
+export declare function convertCanvasPointToWorld(point?: Point.Point, frame?: Frame, viewport?: Viewport, transform?: Matrix4.Matrix4): Vector3.Vector3 | undefined;
+export declare function computeUpdatedTransform(current: Matrix4.Matrix4, previous: Vector3.Vector3, next: Vector3.Vector3, viewVector: Vector3.Vector3, angle: number, identifier: string): Matrix4.Matrix4;

package/dist/types/components/viewer-transform-widget/viewer-transform-widget.d.ts

@@ -0,0 +1,81 @@
+import { EventEmitter, h } from '../../stencil-public-runtime';
+import { Matrix4, Vector3 } from '@vertexvis/geometry';
+import { TransformController } from '../../lib/transforms/controller';
+import { Drawable } from '../../lib/transforms/drawable';
+export declare class ViewerTransformWidget {
+  /**
+   * An event that is emitted when the position of the widget changes.
+   */
+  positionChanged: EventEmitter<Vector3.Vector3 | undefined>;
+  /**
+   * An event that is emitted when the interaction has ended
+   */
+  interactionEnded: EventEmitter<Matrix4.Matrix4 | undefined>;
+  /**
+   * An event that is emitted an interaction with the widget has started
+   */
+  interactionStarted: EventEmitter<void>;
+  /**
+   * The viewer to connect to transforms. If nested within a <vertex-viewer>,
+   * this property will be populated automatically.
+   */
+  viewer?: HTMLVertexViewerElement;
+  /**
+   * 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 controller that is responsible for performing transforms.
+   */
+  controller?: TransformController;
+  /**
+   * @internal
+   * @ignore
+   *
+   * Visible for testing.
+   */
+  hovered?: Drawable;
+  private hostEl;
+  private startingTransform?;
+  private currentTransform?;
+  private xArrowColor;
+  private yArrowColor;
+  private zArrowColor;
+  private hoveredColor;
+  private disabledColor;
+  private widget?;
+  private dragging?;
+  private lastAngle;
+  private lastWorldPosition?;
+  private canvasBounds?;
+  private canvasResizeObserver?;
+  private canvasRef?;
+  private hoveredChangeDisposable?;
+  protected componentDidLoad(): void;
+  protected disconnectedCallback(): void;
+  /**
+   * @ignore
+   */
+  protected handleViewerChanged(newViewer?: HTMLVertexViewerElement, oldViewer?: HTMLVertexViewerElement): void;
+  /**
+   * @ignore
+   */
+  protected handlePositionChanged(newPosition?: Vector3.Vector3, oldPosition?: Vector3.Vector3): void;
+  render(): h.JSX.IntrinsicElements;
+  private handleHoveredDrawableChanged;
+  private handleViewerFrameDrawn;
+  private handleViewerDimensionsChange;
+  private handleResize;
+  private handlePointerMove;
+  private handleBeginDrag;
+  private handleDrag;
+  private handleEndTransform;
+  private updatePropsFromViewer;
+  private transform;
+  private setupTransformWidget;
+  private updateCanvasBounds;
+  private getTransform;
+  private getCanvasBounds;
+  private getTransformWidget;
+}

package/dist/types/components/viewer-transform-widget/widget.d.ts

@@ -0,0 +1,74 @@
+import { Matrix4 } from '@vertexvis/geometry';
+import { Point } from '@vertexvis/geometry';
+import { Color, Disposable, Listener } from '@vertexvis/utils';
+import { Drawable } from '../../lib/transforms/drawable';
+import { Frame } from '../../lib/types';
+export interface DrawableElementColors {
+  xArrow?: Color.Color | string;
+  yArrow?: Color.Color | string;
+  zArrow?: Color.Color | string;
+  hovered?: Color.Color | string;
+  outline?: Color.Color | string;
+}
+export declare const DEFAULT_PERSPECTIVE_MESH_SCALAR = 0.005;
+export declare const DEFAULT_ORTHOGRAPHIC_MESH_SCALAR = 0.00625;
+export declare class TransformWidget implements Disposable {
+  private canvasElement;
+  private reglCommand?;
+  private viewport;
+  private cursor?;
+  private xAxis?;
+  private yAxis?;
+  private zAxis?;
+  private xArrow?;
+  private yArrow?;
+  private zArrow?;
+  private xRotation?;
+  private xyRotationLine?;
+  private xzRotationLine?;
+  private yRotation?;
+  private yxRotationLine?;
+  private yzRotationLine?;
+  private zRotation?;
+  private zxRotationLine?;
+  private zyRotationLine?;
+  private axisLines;
+  private rotationLines;
+  private translationMeshes;
+  private rotationMeshes;
+  private drawableElements;
+  private hoveredElement?;
+  private frame?;
+  private transform?;
+  private bounds?;
+  private reglFrameDisposable?;
+  private hoveredChanged;
+  private xArrowFillColor?;
+  private yArrowFillColor?;
+  private zArrowFillColor?;
+  private hoveredArrowFillColor?;
+  private outlineColor?;
+  constructor(canvasElement: HTMLCanvasElement, colors?: DrawableElementColors);
+  dispose(): void;
+  /**
+   * @internal - visible for testing
+   */
+  getDrawableElements(): Drawable[];
+  boundsContainsPoint(point: Point.Point): boolean;
+  updateFrame(frame: Frame, updateElements?: boolean): void;
+  updateCursor(cursor?: Point.Point): void;
+  updateTransform(transform?: Matrix4.Matrix4): void;
+  updateColors(colors: DrawableElementColors): void;
+  updateDimensions(canvasElement: HTMLCanvasElement): void;
+  onHoveredChanged(listener: Listener<Drawable | undefined>): Disposable;
+  private draw;
+  private clear;
+  private updateHovered;
+  private clearHovered;
+  private sortMeshes;
+  private createOrUpdateElements;
+  private createElements;
+  private createRotationLines;
+  private updateElements;
+  private computeTriangleSize;
+}