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

package/types/viewer/scene/marker/Marker.d.ts

@@ -0,0 +1,136 @@
+import { Component } from "../Component";
+import { Entity } from "../Entity";
+
+export declare type MarkerConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** Entity to associate this Marker with. When the Marker has an Entity, then {@link Marker.visible} will always be ````false```` if {@link Entity.visible} is false. */
+  entity?: Entity
+  /** Indicates whether or not this Marker is hidden (ie. {@link Marker.visible} is ````false```` whenever occluded by {@link Entity}s in the {@link Scene}. */
+  occludable?: boolean;
+  /** World-space 3D Marker position. */
+  worldPos?: number[];
+};
+
+/**
+ * @desc Tracks the World, View and Canvas coordinates, and visibility, of a position within a {@link Scene}.
+ */
+export declare class Marker extends Component {
+  /**
+   * @constructor
+   * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this Marker as well.
+   * @param {MarkerConfiguration} [cfg]  Marker configuration
+   */
+  constructor(owner?: Component, cfg?: MarkerConfiguration);
+  
+  /**
+   * Sets the {@link Entity} this Marker is associated with.
+   *
+   * An Entity is optional. When the Marker has an Entity, then {@link Marker.visible} will always be ````false````
+   * if {@link Entity.visible} is false.
+   *
+   * @type {Entity}
+   */
+  set entity(arg: Entity);
+  
+  /**
+   * Gets the {@link Entity} this Marker is associated with.
+   *
+   * @type {Entity}
+   */
+  get entity(): Entity;
+
+  /**
+   * Sets the World-space 3D position of this Marker.
+   *
+   * Fires a "worldPos" event with new World position.
+   *
+   * @type {Number[]}
+   */
+  set worldPos(arg: number[]);
+
+  /**
+   * Gets the World-space 3D position of this Marker.
+   *
+   * @type {Number[]}
+   */
+  get worldPos(): number[];
+
+  /**
+   * Sets whether occlusion testing is performed for this Marker.
+   *
+   * When this is ````true````, then {@link Marker.visible} will be ````false```` whenever the Marker is occluded by an {@link Entity} in the 3D view.
+   *
+   * The {@link Scene} periodically occlusion-tests all Markers on every 20th "tick" (which represents a rendered frame). We
+   * can adjust that frequency via property {@link Scene.ticksPerOcclusionTest}.
+   *
+   * @type {Boolean}
+   */
+  set occludable(arg: boolean);
+
+  /**
+   * Gets whether occlusion testing is performed for this Marker.
+   *
+   * When this is ````true````, then {@link Marker.visible} will be ````false```` whenever the Marker is occluded by an {@link Entity} in the 3D view.
+   *
+   * @type {Boolean}
+   */
+  get occludable(): boolean;
+
+  /**
+   * Gets the RTC center of this Marker.
+   *
+   * This is automatically calculated from {@link Marker.worldPos}.
+   *
+   * @type {Number[]}
+   */
+  get origin(): number[];
+
+  /**
+   * Gets the RTC position of this Marker.
+   *
+   * This is automatically calculated from {@link Marker.worldPos}.
+   *
+   * @type {Number[]}
+   */
+  get rtcPos(): number[];
+
+  /**
+   * View-space 3D coordinates of this Marker.
+   *
+   * This property is read-only and is automatically calculated from {@link Marker.worldPos} and the current {@link Camera} position.
+   *
+   * The Marker fires a "viewPos" event whenever this property changes.
+   *
+   * @type {Number[]}
+   */
+  get viewPos(): number[];
+
+  /**
+   * Canvas-space 2D coordinates of this Marker.
+   *
+   * This property is read-only and is automatically calculated from {@link Marker.worldPos} and the current {@link Camera} position and projection.
+   *
+   * The Marker fires a "canvasPos" event whenever this property changes.
+   *
+   * @type {Number[]}
+   */
+  get canvasPos(): number[];
+
+  /**
+   * Indicates if this Marker is currently visible.
+   *
+   * This is read-only and is automatically calculated.
+   *
+   * The Marker is **invisible** whenever:
+   *
+   * * {@link Marker.canvasPos} is currently outside the canvas,
+   * * {@link Marker.entity} is set to an {@link Entity} that has {@link Entity.visible} ````false````, or
+   * * or {@link Marker.occludable} is ````true```` and the Marker is currently occluded by an Entity in the 3D view.
+   *
+   * The Marker fires a "visible" event whenever this property changes.
+   *
+   * @type {Boolean}
+   */
+  get visible(): boolean;
+}

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

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

package/types/viewer/scene/materials/EdgeMaterial.d.ts

@@ -0,0 +1,83 @@
+import { Material } from "./Material";
+import { Component } from "../Component";
+
+export declare type EdgeMaterialConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** RGB edge color. */
+  edgeColor?: number[];
+  /** Edge transparency. */
+  edgeAlpha?: number;
+  /** Edge width in pixels. */
+  edgeWidth?: number;
+  /** Selects a preset EdgeMaterial configuration */
+  preset?:  string;
+};
+
+/**
+ * Configures the appearance of {@link Entity}s when their edges are emphasised.
+ */
+export declare class EdgeMaterial extends Material {
+  /**
+   * @constructor
+   * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+   * @param {EdgeMaterialConfiguration} [cfg] The EdgeMaterial configuration
+   */
+  constructor(owner: Component, cfg?: EdgeMaterialConfiguration);
+
+  /**
+   * Gets available EdgeMaterial presets.
+   */
+  get presets(): any;
+
+  /**
+   * Selects a preset EdgeMaterial configuration.
+   * @type {String}
+   */
+  set preset(arg: string);
+
+  /**
+   * The current preset EdgeMaterial configuration.
+   */
+  get preset(): string;
+
+  /**
+   * Sets RGB edge color.
+   */
+  set edgeColor(arg: number[]);
+
+  /**
+   * Gets RGB edge color.
+   */
+  get edgeColor(): number[];
+
+  /**
+   * Sets edge transparency.
+   */
+  set edgeAlpha(arg: number);
+
+  /**
+   * Gets edge transparency.
+   */
+  get edgeAlpha(): number;
+
+  /**
+   * Sets edge width.
+   */
+  set edgeWidth(arg: number);
+
+  /**
+   * Gets edge width.
+   */
+  get edgeWidth(): number;
+
+  /**
+   * Sets if edges are visible.
+   */
+  set edges(arg: boolean);
+
+  /**
+   * Gets if edges are visible.
+   */
+  get edges(): boolean;
+}

package/types/viewer/scene/materials/EmphasisMaterial.d.ts

@@ -0,0 +1,241 @@
+import { Material } from "./Material";
+import { Component } from "../Component";
+
+export declare type EmphasisMaterialConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** Indicates if xray surfaces are filled with color. */
+  fill?: boolean;
+  /** EmphasisMaterial fill color. */
+  fillColor?: number[];
+  /** Transparency of filled xray faces. A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.*/
+  fillAlpha?: number;
+  /** Indicates if xray edges are visible. */
+  edges?: boolean;
+  /** RGB color of xray edges. */
+  edgeColor?: number[];
+  /** Transparency of xray edges. A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque. */
+  edgeAlpha?: number;
+  /** Width of xray edges, in pixels. */
+  edgeWidth?: number;
+  /** Selects a preset EmphasisMaterial configuration - see {@link EmphasisMaterial.presets}. */
+  preset?: string;
+  /** Whether to render geometry backfaces when emphasising. */
+  backfaces?: boolean;
+  /** Whether to make the emphasized object appear to float on top of other objects, as if it were "glowing through" them. */
+  glowThrough?: boolean;
+};
+
+/**
+ * Configures the appearance of {@link Entity}s when they are xrayed, highlighted or selected.
+ */
+export declare class EmphasisMaterial extends Material {
+  /**
+   * @constructor
+   * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+   * @param {EmphasisMaterialConfiguration} [cfg] The EmphasisMaterial configuration
+   */
+  constructor(owner: Component, cfg?: EmphasisMaterialConfiguration);
+
+  /**
+   * Gets available EmphasisMaterial presets.
+   *
+   * @type {Object}
+   */
+  get presets(): any;
+
+  /**
+   * Selects a preset EmphasisMaterial configuration.
+   *
+   * Default value is "default".
+   *
+   * @type {String}
+   */
+  set preset(arg: string);
+
+  /**
+   * Gets the current preset EmphasisMaterial configuration.
+   *
+   * Default value is "default".
+   *
+   * @type {String}
+   */
+  get preset(): string;
+
+  /**
+   * Sets if surfaces are filled with color.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  set fill(arg: boolean);
+
+  /**
+   * Gets if surfaces are filled with color.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  get fill(): boolean;
+
+  /**
+   * Sets the RGB color of filled faces.
+   *
+   * Default is ````[0.4, 0.4, 0.4]````.
+   *
+   * @type {Number[]}
+   */
+  set fillColor(arg: number[]);
+
+  /**
+   * Gets the RGB color of filled faces.
+   *
+   * Default is ````[0.4, 0.4, 0.4]````.
+   *
+   * @type {Number[]}
+   */
+  get fillColor(): number[];
+
+  /**
+   * Sets the transparency of filled faces.
+   *
+   * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+   *
+   * Default is ````0.2````.
+   *
+   * @type {Number}
+   */
+  set fillAlpha(arg: number);
+
+  /**
+   * Gets the transparency of filled faces.
+   *
+   * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+   *
+   * Default is ````0.2````.
+   *
+   * @type {Number}
+   */
+
+  get fillAlpha(): number;
+
+  /**
+   * Sets if edges are visible.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  set edges(arg: boolean);
+
+  /**
+   * Gets if edges are visible.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  get edges(): boolean;
+
+  /**
+   * Sets the RGB color of edges.
+   *
+   * Default is ```` [0.2, 0.2, 0.2]````.
+   *
+   * @type {Number[]}
+   */
+  set edgeColor(arg: number[]);
+
+  /**
+   * Gets the RGB color of edges.
+   *
+   * Default is ```` [0.2, 0.2, 0.2]````.
+   *
+   * @type {Number[]}
+   */
+  get edgeColor(): number[];
+
+  /**
+   * Sets the transparency of edges.
+   *
+   * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+   *
+   * Default is ````0.2````.
+   *
+   * @type {Number}
+   */
+  set edgeAlpha(arg: number);
+
+  /**
+   * Gets the transparency of edges.
+   *
+   * A value of ````0.0```` indicates fully transparent, ````1.0```` is fully opaque.
+   *
+   * Default is ````0.2````.
+   *
+   * @type {Number}
+   */
+  get edgeAlpha(): number;
+
+  /**
+   * Sets edge width.
+   *
+   * This is not supported by WebGL implementations based on DirectX [2019].
+   *
+   * Default value is ````1.0```` pixels.
+   *
+   * @type {Number}
+   */
+  set edgeWidth(arg: number);
+
+  /**
+   * Gets edge width.
+   *
+   * This is not supported by WebGL implementations based on DirectX [2019].
+   *
+   * Default value is ````1.0```` pixels.
+   *
+   * @type {Number}
+   */
+  get edgeWidth(): number;
+
+  /**
+   * Sets whether to render backfaces when {@link EmphasisMaterial.fill} is ````true````.
+   *
+   * Default is ````false````.
+   *
+   * @type {Boolean}
+   */
+  set backfaces(arg: boolean);
+
+  /**
+   * Gets whether to render backfaces when {@link EmphasisMaterial.fill} is ````true````.
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  get backfaces(): boolean;
+
+  /**
+   * Sets whether to render emphasized objects over the top of other objects, as if they were "glowing through".
+   *
+   * Default is ````true````.
+   *
+   * Note: updating this property will not affect the appearance of objects that are already emphasized.
+   *
+   * @type {Boolean}
+   */
+  set glowThrough(arg: boolean);
+
+  /**
+   * Sets whether to render emphasized objects over the top of other objects, as if they were "glowing through".
+   *
+   * Default is ````true````.
+   *
+   * @type {Boolean}
+   */
+  get glowThrough(): boolean;
+}

package/types/viewer/scene/materials/Fresnel.d.ts

@@ -0,0 +1,148 @@
+/**
+ * @desc Configures Fresnel effects for {@link PhongMaterial}s.
+ *
+ * Fresnels are attached to {@link PhongMaterial}s, which are attached to {@link Mesh}es.
+ *
+ * ## Usage
+ *
+ * In the example below we'll create a {@link Mesh} with a {@link PhongMaterial} that applies a Fresnel to its alpha channel to give a glasss-like effect.
+ *
+ * [[Run this example](http://xeokit.github.io/xeokit-sdk/examples/#materials_Fresnel)]
+ *
+ * ````javascript
+ * import {Viewer, Mesh, buildTorusGeometry,
+ *      ReadableGeometry, PhongMaterial, Texture, Fresnel} from "xeokit-sdk.es.js";
+ *
+ * const viewer = new Viewer({
+ *       canvasId: "myCanvas",
+ *       transparent: true
+ * });
+ *
+ * viewer.scene.camera.eye = [0, 0, 5];
+ * viewer.scene.camera.look = [0, 0, 0];
+ * viewer.scene.camera.up = [0, 1, 0];
+ *
+ * new Mesh(viewer.scene, {
+ *      geometry: new ReadableGeometry(viewer.scene, buildTorusGeometry({
+ *          center: [0, 0, 0],
+ *          radius: 1.5,
+ *          tube: 0.5,
+ *          radialSegments: 32,
+ *          tubeSegments: 24,
+ *          arc: Math.PI * 2.0
+ *      }),
+ *      material: new PhongMaterial(viewer.scene, {
+ *          alpha: 0.9,
+ *          alphaMode: "blend",
+ *          ambient: [0.0, 0.0, 0.0],
+ *          shininess: 30,
+ *          diffuseMap: new Texture(viewer.scene, {
+ *              src: "textures/diffuse/uvGrid2.jpg"
+ *          }),
+ *          alphaFresnel: new Fresnel(viewer.scene, {
+v               edgeBias: 0.2,
+ *              centerBias: 0.8,
+ *              edgeColor: [1.0, 1.0, 1.0],
+ *              centerColor: [0.0, 0.0, 0.0],
+ *              power: 2
+ *          })
+ *      })
+ * });
+ * ````
+ */
+export declare class Fresnel extends Component {
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this Fresnel as well.
+     * @param {*} [cfg] Configs
+     * @param {String} [cfg.id] Optional ID, unique among all components in the parent scene, generated automatically when omitted.
+     * @param {Number[]} [cfg.edgeColor=[ 0.0, 0.0, 0.0 ]]  Color used on edges.
+     * @param {Number[]} [cfg.centerColor=[ 1.0, 1.0, 1.0 ]]  Color used on center.
+     * @param {Number} [cfg.edgeBias=0]  Bias at the edge.
+     * @param {Number} [cfg.centerBias=1]  Bias at the center.
+     * @param {Number} [cfg.power=0]  The power.
+     */
+    constructor(owner: Component, cfg?: any);
+    _state: any;
+    /**
+     * Sets the Fresnel's edge color.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @type {Number[]}
+     */
+    set edgeColor(arg: number[]);
+    /**
+     * Gets the Fresnel's edge color.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @type {Number[]}
+     */
+    get edgeColor(): number[];
+    /**
+     * Sets the Fresnel's center color.
+     *
+     * Default value is ````[1.0, 1.0, 1.0]````.
+     *
+     * @type {Number[]}
+     */
+    set centerColor(arg: number[]);
+    /**
+     * Gets the Fresnel's center color.
+     *
+     * Default value is ````[1.0, 1.0, 1.0]````.
+     *
+     * @type {Number[]}
+     */
+    get centerColor(): number[];
+    /**
+     * Sets the Fresnel's edge bias.
+     *
+     * Default value is ````0````.
+     *
+     * @type {Number}
+     */
+    set edgeBias(arg: number);
+    /**
+     * Gets the Fresnel's edge bias.
+     *
+     * Default value is ````0````.
+     *
+     * @type {Number}
+     */
+    get edgeBias(): number;
+    /**
+     * Sets the Fresnel's center bias.
+     *
+     * Default value is ````1````.
+     *
+     * @type {Number}
+     */
+    set centerBias(arg: number);
+    /**
+     * Gets the Fresnel's center bias.
+     *
+     * Default value is ````1````.
+     *
+     * @type {Number}
+     */
+    get centerBias(): number;
+    /**
+     * Sets the Fresnel's power.
+     *
+     * Default value is ````1````.
+     *
+     * @type {Number}
+     */
+    set power(arg: number);
+    /**
+     * Gets the Fresnel's power.
+     *
+     * Default value is ````1````.
+     *
+     * @type {Number}
+     */
+    get power(): number;
+}
+import { Component } from "../Component";

package/types/viewer/scene/materials/LinesMaterial.d.ts

@@ -0,0 +1,71 @@
+import { Material } from "./Material";
+import { Component } from "../Component";
+
+export declare type LinesMaterialConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** Line width in pixels. */
+  lineWidth?: number;
+  /** Selects a preset LinesMaterial configuration - see {@link LinesMaterial.presets}. */
+  preset?: string;
+};
+
+/**
+ * Configures the shape of "lines" geometry primitives.
+ */
+export declare class LinesMaterial extends Material {
+  /**
+   * @constructor
+   * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+   * @param {LinesMaterialConfiguration} [cfg] The LinesMaterial configuration
+   */
+  constructor(owner: Component, cfg?: LinesMaterialConfiguration);
+  /**
+   * Gets available LinesMaterial presets.
+   *
+   * @type {Object}
+   */
+  get presets(): any;
+
+  /**
+   * Selects a preset LinesMaterial configuration.
+   *
+   * Default value is ````"default"````.
+   *
+   * @type {String}
+   */
+  set preset(arg: string);
+
+  /**
+   * The current preset LinesMaterial configuration.
+   *
+   * Default value is ````"default"````.
+   *
+   * @type {String}
+   */
+  get preset(): string;
+
+  /**
+   * Sets line width.
+   *
+   * Default value is ````1```` pixels.
+   *
+   * @type {Number}
+   */
+  set lineWidth(arg: number);
+
+  /**
+   * Gets the line width.
+   *
+   * Default value is ````1```` pixels.
+   *
+   * @type {Number}
+   */
+  get lineWidth(): number;
+
+  /**
+   * @private
+   * @return {string}
+   */
+  private get hash();
+}

package/types/viewer/scene/materials/Material.d.ts

@@ -0,0 +1,3 @@
+import { Component } from "../Component";
+export abstract class Material extends Component {
+}