@xeokit/xeokit-sdk 2.3.0 → 2.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Web Programming Toolkit for 3D/2D BIM and AEC Graphics",
   "module": "/dist/xeokit-sdk.es.js",
   "main": "/dist/xeokit-sdk.cjs.js",

package/types/plugins/TreeViewPlugin/TreeViewNode.d.ts

@@ -63,4 +63,11 @@ export declare class TreeViewNode {
    * @abstract
    */
   get checked(): boolean;
+
+  /** Whether or not the TreeViewNode is currently xrayed.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+     get xrayed(): boolean;
 }

package/types/viewer/scene/geometry/ReadableGeometry.d.ts

@@ -31,7 +31,7 @@ export declare type ReadableGeometryConfiguration = {
  *
  * ReadableGeometry uses more memory than {@link VBOGeometry}, which only stores its geometry data in GPU memory.
  */
- export declare class ReadableGeometry extends Geometry {
+export declare class ReadableGeometry extends Geometry {
   /**
    * constructor
    * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.

package/types/viewer/scene/geometry/VBOGeometry.d.ts

@@ -0,0 +1,63 @@
+import { Component } from "../Component";
+import { Geometry } from "./Geometry";
+
+export declare type VBOGeometryConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** Optional map of user-defined metadata to attach to this Geometry. */
+  meta?: {[key: string]: any};
+  /** The primitive type. */
+  primitive?: "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
+  /** Positions array. */
+  positions?: number[];
+  /** Vertex normal vectors array. */
+  normals?: number[];
+  /** UVs array. */
+  uv?: number[];
+  /** Vertex colors. */
+  colors?: number[];
+  /** Indices array. */
+  indices?: number[];
+  /** When a {@link Mesh} renders this Geometry as wireframe, this indicates the threshold angle (in degrees) between the face normals of adjacent triangles below which the edge is discarded.*/
+  edgeThreshold?: number;
+};
+
+/**
+ * @desc A {@link Geometry} that keeps its geometry data solely in GPU memory, without retaining it in browser memory.
+ *
+ * VBOGeometry uses less memory than {@link ReadableGeometry}, which keeps its geometry data in both browser and GPU memory.
+ */
+export declare class VBOGeometry extends Geometry {
+  /**
+   * @constructor
+   * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+   * @param {VBOGeometryConfiguration} cfg Configs
+   */
+  constructor(owner: Component, cfg?: VBOGeometryConfiguration);
+
+  /**
+   * Gets the primitive type.
+   */
+  get primitive(): "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
+
+  /**
+   * Gets the local-space axis-aligned 3D boundary (AABB).
+   *
+   * The AABB is represented by a six-element Float64Array containing the min/max extents of the axis-aligned volume, ie. ````[xmin, ymin,zmin,xmax,ymax, zmax]````.
+   */
+  get aabb(): Number[];
+
+  /**
+   * Gets the local-space oriented 3D boundary (OBB).
+   *
+   * The OBB is represented by a 32-element Float64Array containing the eight vertices of the box, where each vertex is a homogeneous coordinate having [x,y,z,w] elements.
+   */
+  get obb(): Number[];
+
+  /**
+   * Approximate number of triangles in this VBOGeometry.
+   *
+   * Will be zero if {@link VBOGeometry#primitive} is not 'triangles', 'triangle-strip' or 'triangle-fan'.
+   */
+  get numTriangles(): Number;
+}

package/types/viewer/scene/geometry/builders/buildBoxGeometry.d.ts

@@ -0,0 +1,22 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildBoxGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* 3D point indicating the center position. */
+  center?: number[];
+  /* Half-size on the X-axis. */
+  xSize?: number;
+  /* Half-size on the Y-axis. */
+  ySize?: number;
+  /* Half-size on the Z-axis. */
+  zSize?: number;
+};
+
+/**
+ * @desc Creates box-shaped {@link Geometry}.
+ *
+ * @param {buildBoxGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildBoxGeometry(cfg: buildBoxGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/buildBoxLinesGeometry.d.ts

@@ -0,0 +1,22 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildBoxLinesGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* 3D point indicating the center position. */
+  center?: number[];
+  /* Half-size on the X-axis. */
+  xSize?: number;
+  /* Half-size on the Y-axis. */
+  ySize?: number;
+  /* Half-size on the Z-axis.*/
+  zSize?: number;
+};
+
+/**
+ * @desc Creates a box-shaped lines {@link Geometry}.
+ *
+ * @param {buildBoxLinesGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildBoxLinesGeometry(cfg: buildBoxLinesGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/buildCylinderGeometry.d.ts

@@ -0,0 +1,28 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildCylinderGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* 3D point indicating the center position. */
+  center?: number[];
+  /* Radius of top. */
+  radiusTop?: number;
+  /*  Radius of bottom. */
+  radiusBottom?: number;
+  /* Height. */
+  height?: number;
+  /* Number of horizontal segments. */
+  radialSegments?: number;
+  /* Number of vertical segments. */
+  heightSegments?: number;
+  /* Whether or not the cylinder has solid caps on the ends. */
+  openEnded?: boolean;
+};
+
+/**
+ * @desc Creates a cylinder-shaped {@link Geometry}.
+ *
+ * @param {buildCylinderGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildCylinderGeometry(cfg: buildCylinderGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/buildGridGeometry.d.ts

@@ -0,0 +1,18 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildGridGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* Dimension on the X and Z-axis. */
+  size?: number;
+  /* Number of divisions on X and Z axis.. */
+  divisions?: number;
+};
+
+/**
+ * @desc Creates a grid-shaped {@link Geometry}.
+ *
+ * @param {buildGridGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildGridGeometry(cfg: buildGridGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/buildPlaneGeometry.d.ts

@@ -0,0 +1,22 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildPlaneGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* Dimension on the X-axis. */
+  xSize?: number;
+  /* Dimension on the Z-axis. */
+  zSize?: number;
+  /* Number of segments on the X-axis. */
+  xSegments?: number;
+  /* Number of segments on the Z-axis. */
+  zSegments?: number;
+};
+
+/**
+ * @desc Creates a plane-shaped {@link Geometry}.
+ *
+ * @param {buildPlaneGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildPlaneGeometry(cfg: buildPlaneGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/buildSphereGeometry.d.ts

@@ -0,0 +1,22 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildSphereGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* 3D point indicating the center position. */
+  center?: number[]; 
+  /* Radius. */
+  radius?: number;
+  /* Number of latitudinal bands. */
+  heightSegments?: number;
+  /* Number of longitudinal bands. */
+  widthSegments?: number;
+};
+
+/**
+ * @desc Creates a sphere-shaped {@link Geometry}.
+ *
+ * @param {buildSphereGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildSphereGeometry(cfg: buildSphereGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/buildTorusGeometry.d.ts

@@ -0,0 +1,26 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildTorusGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* 3D point indicating the center position. */
+  center?: number[]; 
+  /* The overall radius. */
+  radius?: number;
+  /* The tube radius. */
+  tube?: number;
+  /* The number of radial segments. */
+  radialSegments?: number;
+  /* The number of tubular segments. */
+  tubeSegments?: number;
+  /* The length of the arc in radians, where Math.PI*2 is a closed torus. */
+  arc?: number;
+};
+
+/**
+ * @desc Creates a torus-shaped {@link Geometry}.
+ *
+ * @param {buildTorusGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildTorusGeometry(cfg: buildTorusGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/buildVectorTextGeometry.d.ts

@@ -0,0 +1,22 @@
+import { Geometry } from "../Geometry";
+
+export declare type buildVectorTextGeometryConfiguration = {
+  /* Optional ID for the {@link Geometry}, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /* 3D point indicating the center position. */
+  center?: number[];
+  /* 3D point indicating the top left corner. */
+  origin?: number[];
+  /* Size of each character. */
+  size?: number;
+  /* The text. */
+  text?: string;
+};
+
+/**
+ * @desc Creates wireframe vector text {@link Geometry}.
+ *
+ * @param {buildVectorTextGeometryConfiguration} [cfg] Configs
+ * @returns {Object} Configuration for a {@link Geometry} subtype.
+ */
+export function buildVectorTextGeometry(cfg: buildVectorTextGeometryConfiguration): Geometry;

package/types/viewer/scene/geometry/builders/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./buildBoxGeometry";
+export * from "./buildBoxLinesGeometry";
+export * from "./buildCylinderGeometry";
+export * from "./buildGridGeometry";
+export * from "./buildPlaneGeometry";
+export * from "./buildSphereGeometry";
+export * from "./buildTorusGeometry";
+export * from "./buildVectorTextGeometry";

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

@@ -1 +1,3 @@
 export * from "./ReadableGeometry";
+export * from "./VBOGeometry";
+export * from "./builders";

package/types/viewer/scene/scene/Scene.d.ts

@@ -63,7 +63,7 @@ export declare class Scene extends Component {
    * @param callback Called fired on the event
    * @param scope  Scope for the callback
    */
-   on(event: "objectVisibility", callback: (entity: VBOSceneModel | Mesh | Node) => void, scope?: any): string;
+   on(event: "objectVisibility" | "objectXRayed" | "objectHighlighted" | "objectSelected", callback: (entity: VBOSceneModel | Mesh | Node) => void, scope?: any): string;
 
    /**
    * Fired on each game loop iteration.