@xeokit/xeokit-sdk 2.2.4 → 2.2.5-beta-2

package/types/viewer/scene/sectionPlane/SectionPlane.d.ts

@@ -0,0 +1,93 @@
+import { Component } from "../Component";
+
+export declare type SectionPlaneConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** Indicates whether or not this SectionPlane is active. */
+  active?: boolean;
+  /** World-space position of the SectionPlane. */
+  pos?: number[];
+  /** Vector perpendicular to the plane surface, indicating the SectionPlane plane orientation. */
+  dir?: number[];
+};
+
+/**
+ *  An arbitrarily-aligned World-space clipping plane.
+ */
+export class SectionPlane extends Component {
+  /**
+   * @constructor
+   * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this SectionPlane as well.
+   * @param {SectionPlaneConfiguration} [cfg]  SectionPlane configuration
+   */
+  constructor(owner?: Component, cfg?: SectionPlaneConfiguration);
+
+  /**
+   * Sets if this SectionPlane is active or not.
+   *
+   * Default value is ````true````.
+   *
+   * @param {Boolean} value Set ````true```` to activate else ````false```` to deactivate.
+   */
+  set active(arg: boolean);
+
+  /**
+   * Gets if this SectionPlane is active or not.
+   *
+   * Default value is ````true````.
+   *
+   * @returns {Boolean} Returns ````true```` if active.
+   */
+  get active(): boolean;
+
+  /**
+   * Sets the World-space position of this SectionPlane's plane.
+   *
+   * Default value is ````[0, 0, 0]````.
+   *
+   * @param {Number[]} value New position.
+   */
+  set pos(arg: number[]);
+
+  /**
+   * Gets the World-space position of this SectionPlane's plane.
+   *
+   * Default value is ````[0, 0, 0]````.
+   *
+   * @returns {Number[]} Current position.
+   */
+  get pos(): number[];
+
+  /**
+   * Sets the direction of this SectionPlane's plane.
+   *
+   * Default value is ````[0, 0, -1]````.
+   *
+   * @param {Number[]} value New direction.
+   */
+  set dir(arg: number[]);
+
+  /**
+   * Gets the direction of this SectionPlane's plane.
+   *
+   * Default value is ````[0, 0, -1]````.
+   *
+   * @returns {Number[]} value Current direction.
+   */
+  get dir(): number[];
+
+  /**
+   * Gets this SectionPlane's distance to the origin of the World-space coordinate system.
+   *
+   * This is the dot product of {@link SectionPlane#pos} and {@link SectionPlane#dir} and is automatically re-calculated
+   * each time either of two properties are updated.
+   *
+   * @returns {Number}
+   */
+  get dist(): number;
+
+  /**
+   * Inverts the direction of {@link SectionPlane#dir}.
+   */
+  flipDir(): void;
+}

package/types/viewer/scene/sectionPlane/index.d.ts

@@ -0,0 +1 @@
+export * from "./SectionPlane";

package/types/viewer/scene/viewport/Viewport.d.ts

@@ -0,0 +1,23 @@
+import { Component } from "../Component";
+
+export declare class Viewport extends Component {
+  /**
+   * Sets the canvas-space boundary of this Viewport, indicated as ````[min, max, width, height]````.
+   */
+  set boundary(arg: number[]);
+
+  /**
+   * Gets the canvas-space boundary of this Viewport, indicated as ````[min, max, width, height]````.
+   */
+  get boundary(): number[];
+
+  /**
+   * Sets if {@link Viewport#boundary} automatically synchronizes with {@link Canvas#boundary}.
+   */
+  set autoBoundary(arg: boolean);
+
+  /**
+   * Gets if {@link Viewport#boundary} automatically synchronizes with {@link Canvas#boundary}.
+   */
+  get autoBoundary(): boolean;
+}

package/types/viewer/scene/webgl/PickResult.d.ts

@@ -0,0 +1,103 @@
+import { Entity } from "../Entity";
+
+/**
+ * Pick result returned by {@link Scene#pick}.
+ */
+export declare class PickResult {
+  /**
+   * Picked entity.
+   * Null when no entity was picked.
+   * @type {Entity|*}
+   */
+  entity: Entity | null;
+
+  /**
+   * Type of primitive that was picked - usually "triangle".
+   * Null when no primitive was picked.
+   * @type {String}
+   */
+  primitive: string;
+
+  /**
+   * Index of primitive that was picked.
+   * -1 when no entity was picked.
+   * @type {number}
+   */
+  primIndex: number;
+
+  /**
+   * True when the picked surface position is full precision.
+   * When false, the picked surface position should be regarded as approximate.
+   * Full-precision surface picking is performed with the {@link Scene#pick} method's ````pickSurfacePrecision```` option.
+   * @type {Boolean}
+   */
+  pickSurfacePrecision: boolean;
+
+  /**
+   * Canvas coordinates when picking with a 2D pointer.
+   * @property canvasPos
+   * @type {Number[]}
+   */
+  get canvasPos(): number[];
+
+  /**
+   * World-space 3D ray origin when raypicked.
+   * @type {Number[]}
+   */
+  get origin(): number[];
+
+  /**
+   * World-space 3D ray direction when raypicked.
+   * @type {Number[]}
+   */
+  get direction(): number[];
+
+  /**
+   * Picked triangle's vertex indices.
+   * Only defined when an entity and triangle was picked.
+   * @type {Int32Array}
+   */
+  get indices(): Int32Array;
+
+  /**
+   * Picked Local-space point on surface.
+   * Only defined when an entity and a point on its surface was picked.
+   * @type {Number[]}
+   */
+  get localPos(): number[];
+
+  /**
+   * Picked World-space point on surface.
+   * Only defined when an entity and a point on its surface was picked.
+   * @type {Number[]}
+   */
+  get worldPos(): number[];
+
+  /**
+   * Picked View-space point on surface.
+   * Only defined when an entity and a point on its surface was picked.
+   * @type {Number[]}
+   */
+  get viewPos(): number[];
+
+  /**
+   * Barycentric coordinate within picked triangle.
+   * Only defined when an entity and a point on its surface was picked.
+   * @type {Number[]}
+   */
+  get bary(): number[];
+
+  /**
+   * Normal vector at picked position on surface.
+   * Only defined when an entity and a point on its surface was picked.
+   * @type {Number[]}
+   */
+  get worldNormal(): number[];
+
+  /**
+   * UV coordinates at picked position on surface.
+   * Only defined when an entity and a point on its surface was picked.
+   * @type {Number[]}
+   */
+  get uv(): number[];
+}