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

package/types/viewer/scene/camera/CameraFlightAnimation.d.ts

@@ -5,7 +5,7 @@ import { Component } from "../Component";
  */
 export declare class CameraFlightAnimation extends Component {
   /**
-   * Sets the flight duration, in seconds, when calling {@link CameraFlightAnimation#flyTo}.
+   * Sets the flight duration, in seconds, when calling {@link CameraFlightAnimation.flyTo}.
    *
    * Stops any flight currently in progress.
    *
@@ -16,7 +16,7 @@ export declare class CameraFlightAnimation extends Component {
   set duration(arg: number);
 
   /**
-   * Gets the flight duration, in seconds, when calling {@link CameraFlightAnimation#flyTo}.
+   * Gets the flight duration, in seconds, when calling {@link CameraFlightAnimation.flyTo}.
    *
    * default value is ````0.5````.
    *
@@ -26,7 +26,7 @@ export declare class CameraFlightAnimation extends Component {
 
   /**
    * Sets if, when CameraFlightAnimation is flying to a boundary, it will always adjust the distance between the
-   * {@link Camera#eye} and {@link Camera#look} so as to ensure that the target boundary is always filling the view volume.
+   * {@link Camera.eye} and {@link Camera.look} so as to ensure that the target boundary is always filling the view volume.
    *
    * When false, the eye will remain at its current distance from the look position.
    *
@@ -38,7 +38,7 @@ export declare class CameraFlightAnimation extends Component {
 
   /**
    * Gets if, when CameraFlightAnimation is flying to a boundary, it will always adjust the distance between the
-   * {@link Camera#eye} and {@link Camera#look} so as to ensure that the target boundary is always filling the view volume.
+   * {@link Camera.eye} and {@link Camera.look} so as to ensure that the target boundary is always filling the view volume.
    *
    * When false, the eye will remain at its current distance from the look position.
    *
@@ -49,8 +49,8 @@ export declare class CameraFlightAnimation extends Component {
   get fit(): boolean;
 
   /**
-   * Sets how much of the perspective field-of-view, in degrees, that a target {@link Entity#aabb} should
-   * fill the canvas when calling {@link CameraFlightAnimation#flyTo} or {@link CameraFlightAnimation#jumpTo}.
+   * Sets how much of the perspective field-of-view, in degrees, that a target {@link Entity.aabb} should
+   * fill the canvas when calling {@link CameraFlightAnimation.flyTo} or {@link CameraFlightAnimation.jumpTo}.
    *
    * Default value is ````45````.
    *
@@ -59,8 +59,8 @@ export declare class CameraFlightAnimation extends Component {
   set fitFOV(arg: number);
 
   /**
-   * Gets how much of the perspective field-of-view, in degrees, that a target {@link Entity#aabb} should
-   * fill the canvas when calling {@link CameraFlightAnimation#flyTo} or {@link CameraFlightAnimation#jumpTo}.
+   * Gets how much of the perspective field-of-view, in degrees, that a target {@link Entity.aabb} should
+   * fill the canvas when calling {@link CameraFlightAnimation.flyTo} or {@link CameraFlightAnimation.jumpTo}.
    *
    * Default value is ````45````.
    *
@@ -70,7 +70,7 @@ export declare class CameraFlightAnimation extends Component {
 
   /**
    * Sets if this CameraFlightAnimation to point the {@link Camera}
-   * in the direction that it is travelling when flying to a target after calling {@link CameraFlightAnimation#flyTo}.
+   * in the direction that it is travelling when flying to a target after calling {@link CameraFlightAnimation.flyTo}.
    *
    * Default value is ````true````.
    *
@@ -80,7 +80,7 @@ export declare class CameraFlightAnimation extends Component {
 
   /**
    * Gets if this CameraFlightAnimation points the {@link Camera}
-   * in the direction that it is travelling when flying to a target after calling {@link CameraFlightAnimation#flyTo}.
+   * in the direction that it is travelling when flying to a target after calling {@link CameraFlightAnimation.flyTo}.
    *
    * Default value is ````true````.
    *
@@ -96,19 +96,19 @@ export declare class CameraFlightAnimation extends Component {
    *
    * @param {Object|Component} [params=Scene] Either a parameters object or a {@link Component} subtype that has
    * an AABB. Defaults to the {@link Scene}, which causes the {@link Camera} to fit the Scene in view.
-   * @param {Number} [params.arc=0] Factor in range ````[0..1]```` indicating how much the {@link Camera#eye} position
-   * will swing away from its {@link Camera#look} position as it flies to the target.
+   * @param {Number} [params.arc=0] Factor in range ````[0..1]```` indicating how much the {@link Camera.eye} position
+   * will swing away from its {@link Camera.look} position as it flies to the target.
    * @param {Number|String|Component} [params.component] ID or instance of a component to fly to. Defaults to the entire {@link Scene}.
    * @param {Number[]} [params.aabb] World-space axis-aligned bounding box (AABB) target to fly to.
    * @param {Number[]} [params.eye] Position to fly the eye position to.
    * @param {Number[]} [params.look] Position to fly the look position to.
    * @param {Number[]} [params.up] Position to fly the up vector to.
    * @param {String} [params.projection] Projection type to transition into as we fly. Can be any of the values of {@link Camera.projection}.
-   * @param {Boolean} [params.fit=true] Whether to fit the target to the view volume. Overrides {@link CameraFlightAnimation#fit}.
+   * @param {Boolean} [params.fit=true] Whether to fit the target to the view volume. Overrides {@link CameraFlightAnimation.fit}.
    * @param {Number} [params.fitFOV] How much of field-of-view, in degrees, that a target {@link Entity} or its AABB should
-   * fill the canvas on arrival. Overrides {@link CameraFlightAnimation#fitFOV}.
-   * @param {Number} [params.duration] Flight duration in seconds.  Overrides {@link CameraFlightAnimation#duration}.
-   * @param {Number} [params.orthoScale] Animate the Camera's orthographic scale to this target value. See {@link Ortho#scale}.
+   * fill the canvas on arrival. Overrides {@link CameraFlightAnimation.fitFOV}.
+   * @param {Number} [params.duration] Flight duration in seconds.  Overrides {@link CameraFlightAnimation.duration}.
+   * @param {Number} [params.orthoScale] Animate the Camera's orthographic scale to this target value. See {@link Ortho.scale}.
    * @param {Function} [callback] Callback fired on arrival.
    * @param {Object} [scope] Optional scope for callback.
    */
@@ -133,15 +133,15 @@ export declare class CameraFlightAnimation extends Component {
    * * When the target is an explicit {@link Camera} position, given as ````eye````, ````look```` and ````up```` vectors, then this CameraFlightAnimation will jump the {@link Camera} to that target.
    *
    * @param {*|Component} params  Either a parameters object or a {@link Component} subtype that has a World-space AABB.
-   * @param {Number} [params.arc=0]  Factor in range [0..1] indicating how much the {@link Camera#eye} will swing away from its {@link Camera#look} as it flies to the target.
+   * @param {Number} [params.arc=0]  Factor in range [0..1] indicating how much the {@link Camera.eye} will swing away from its {@link Camera.look} as it flies to the target.
    * @param {Number|String|Component} [params.component] ID or instance of a component to fly to.
    * @param {Number[]} [params.aabb]  World-space axis-aligned bounding box (AABB) target to fly to.
    * @param {Number[]} [params.eye] Position to fly the eye position to.
    * @param {Number[]} [params.look]  Position to fly the look position to.
    * @param {Number[]} [params.up] Position to fly the up vector to.
    * @param {String} [params.projection] Projection type to transition into. Can be any of the values of {@link Camera.projection}.
-   * @param {Number} [params.fitFOV] How much of field-of-view, in degrees, that a target {@link Entity} or its AABB should fill the canvas on arrival. Overrides {@link CameraFlightAnimation#fitFOV}.
-   * @param {Boolean} [params.fit] Whether to fit the target to the view volume. Overrides {@link CameraFlightAnimation#fit}.
+   * @param {Number} [params.fitFOV] How much of field-of-view, in degrees, that a target {@link Entity} or its AABB should fill the canvas on arrival. Overrides {@link CameraFlightAnimation.fitFOV}.
+   * @param {Boolean} [params.fit] Whether to fit the target to the view volume. Overrides {@link CameraFlightAnimation.fit}.
    */
   jumpTo(params: {
     arc?: number;

package/types/viewer/scene/camera/CustomProjection.d.ts

@@ -1,5 +1,5 @@
 import { Component } from "../Component";
-import { Camera } from "../Camera";
+import { Camera } from "./Camera";
 
 /**
  * Defines a custom projection for a {@link Camera} as a custom 4x4 matrix..
@@ -31,16 +31,16 @@ export declare class CustomProjection extends Component {
   get matrix(): number[];
 
   /**
-   * Gets the inverse of {@link CustomProjection#matrix}.
+   * Gets the inverse of {@link CustomProjection.matrix}.
    *
-   * @returns {Number[]} The inverse of {@link CustomProjection#matrix}.
+   * @returns {Number[]} The inverse of {@link CustomProjection.matrix}.
    */
   get inverseMatrix(): number[];
 
   /**
-   * Gets the transpose of {@link CustomProjection#matrix}.
+   * Gets the transpose of {@link CustomProjection.matrix}.
    *
-   * @returns {Number[]} The transpose of {@link CustomProjection#matrix}.
+   * @returns {Number[]} The transpose of {@link CustomProjection.matrix}.
    */
   get transposedMatrix(): number[];
 

package/types/viewer/scene/camera/Frustum.d.ts

@@ -1,5 +1,5 @@
 import { Component } from "../Component";
-import { Camera } from "../Camera";
+import { Camera } from "./Camera";
 
 /**
  * Defines its {@link Camera}'s perspective projection as a frustum-shaped view volume.
@@ -17,7 +17,7 @@ export declare class Frustum extends Component {
   /**
    * Sets the position of the Frustum's left plane on the View-space X-axis.
    *
-   * Fires a {@link Frustum#left:emits} emits on change.
+   * Fires a {@link Frustum.left:emits} emits on change.
    *
    * @param {Number} value New left frustum plane position.
    */
@@ -33,7 +33,7 @@ export declare class Frustum extends Component {
   /**
    * Sets the position of the Frustum's right plane on the View-space X-axis.
    *
-   * Fires a {@link Frustum#right:emits} emits on change.
+   * Fires a {@link Frustum.right:emits} emits on change.
    *
    * @param {Number} value New right frustum plane position.
    */
@@ -42,7 +42,7 @@ export declare class Frustum extends Component {
   /**
    * Gets the position of the Frustum's right plane on the View-space X-axis.
    *
-   * Fires a {@link Frustum#right:emits} emits on change.
+   * Fires a {@link Frustum.right:emits} emits on change.
    *
    * @return {Number} Right frustum plane position.
    */
@@ -51,7 +51,7 @@ export declare class Frustum extends Component {
   /**
    * Sets the position of the Frustum's bottom plane on the View-space Y-axis.
    *
-   * Fires a {@link Frustum#bottom:emits} emits on change.
+   * Fires a {@link Frustum.bottom:emits} emits on change.
    *
    * @emits {"bottom"} event with the value of this property whenever it changes.
    *
@@ -62,7 +62,7 @@ export declare class Frustum extends Component {
   /**
    * Gets the position of the Frustum's bottom plane on the View-space Y-axis.
    *
-   * Fires a {@link Frustum#bottom:emits} emits on change.
+   * Fires a {@link Frustum.bottom:emits} emits on change.
    *
    * @return {Number} Bottom frustum plane position.
    */
@@ -71,7 +71,7 @@ export declare class Frustum extends Component {
   /**
    * Sets the position of the Frustum's top plane on the View-space Y-axis.
    *
-   * Fires a {@link Frustum#top:emits} emits on change.
+   * Fires a {@link Frustum.top:emits} emits on change.
    *
    * @param {Number} value New top frustum plane position.
    */
@@ -80,7 +80,7 @@ export declare class Frustum extends Component {
   /**
    * Gets the position of the Frustum's top plane on the View-space Y-axis.
    *
-   * Fires a {@link Frustum#top:emits} emits on change.
+   * Fires a {@link Frustum.top:emits} emits on change.
    *
    * @return {Number} Top frustum plane position.
    */
@@ -89,7 +89,7 @@ export declare class Frustum extends Component {
   /**
    * Sets the position of the Frustum's near plane on the positive View-space Z-axis.
    *
-   * Fires a {@link Frustum#near:emits} emits on change.
+   * Fires a {@link Frustum.near:emits} emits on change.
    *
    * Default value is ````0.1````.
    *
@@ -100,7 +100,7 @@ export declare class Frustum extends Component {
   /**
    * Gets the position of the Frustum's near plane on the positive View-space Z-axis.
    *
-   * Fires a {@link Frustum#near:emits} emits on change.
+   * Fires a {@link Frustum.near:emits} emits on change.
    *
    * Default value is ````0.1````.
    *
@@ -111,7 +111,7 @@ export declare class Frustum extends Component {
   /**
    * Sets the position of the Frustum's far plane on the positive View-space Z-axis.
    *
-   * Fires a {@link Frustum#far:emits} emits on change.
+   * Fires a {@link Frustum.far:emits} emits on change.
    *
    * Default value is ````10000.0````.
    *
@@ -131,7 +131,7 @@ export declare class Frustum extends Component {
   /**
    * Gets the Frustum's projection transform matrix.
    *
-   * Fires a {@link Frustum#matrix:emits} emits on change.
+   * Fires a {@link Frustum.matrix:emits} emits on change.
    *
    * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
    *
@@ -140,16 +140,16 @@ export declare class Frustum extends Component {
   get matrix(): number[];
 
   /**
-   * Gets the inverse of {@link Frustum#matrix}.
+   * Gets the inverse of {@link Frustum.matrix}.
    *
    * @returns {Number[]} The inverse orthographic projection matrix.
    */
   get inverseMatrix(): number[];
 
   /**
-   * Gets the transpose of {@link Frustum#matrix}.
+   * Gets the transpose of {@link Frustum.matrix}.
    *
-   * @returns {Number[]} The transpose of {@link Frustum#matrix}.
+   * @returns {Number[]} The transpose of {@link Frustum.matrix}.
    */
   get transposedMatrix(): number[];
 

package/types/viewer/scene/camera/Ortho.d.ts

@@ -1,5 +1,5 @@
 import { Component } from "../Component";
-import { Camera } from "../Camera";
+import { Camera } from "./Camera";
 
 /**
  * Defines its {@link Camera}'s orthographic projection as a box-shaped view volume.
@@ -89,16 +89,16 @@ export declare class Ortho extends Component {
   get matrix(): number[];
 
   /**
-   * Gets the inverse of {@link Ortho#matrix}.
+   * Gets the inverse of {@link Ortho.matrix}.
    *
-   * @returns {Number[]} The inverse of {@link Ortho#matrix}.
+   * @returns {Number[]} The inverse of {@link Ortho.matrix}.
    */
   get inverseMatrix(): number[];
 
   /**
-   * Gets the transpose of {@link Ortho#matrix}.
+   * Gets the transpose of {@link Ortho.matrix}.
    *
-   * @returns {Number[]} The transpose of {@link Ortho#matrix}.
+   * @returns {Number[]} The transpose of {@link Ortho.matrix}.
    */
   get transposedMatrix(): number[];
 

package/types/viewer/scene/camera/Perspective.d.ts

@@ -1,5 +1,5 @@
 import { Component } from "../Component";
-import { Camera } from "../Camera";
+import { Camera } from "./Camera";
 
 /**
  * @desc Defines its {@link Camera}'s perspective projection using a field-of-view angle.
@@ -110,16 +110,16 @@ export declare class Perspective extends Component {
   get matrix(): number[];
 
   /**
-   * Gets the inverse of {@link Perspective#matrix}.
+   * Gets the inverse of {@link Perspective.matrix}.
    *
-   * @returns {Number[]} The inverse of {@link Perspective#matrix}.
+   * @returns {Number[]} The inverse of {@link Perspective.matrix}.
    */
   get inverseMatrix(): number[];
 
   /**
-   * Gets the transpose of {@link Perspective#matrix}.
+   * Gets the transpose of {@link Perspective.matrix}.
    *
-   * @returns {Number[]} The transpose of {@link Perspective#matrix}.
+   * @returns {Number[]} The transpose of {@link Perspective.matrix}.
    */
   get transposedMatrix(): number[];
 

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

@@ -1,6 +1,7 @@
-export * from "./Camera";
+export * from "./camera";
 export * from "./CameraControl/CameraControl";
 export * from "./Component";
 export * from "./Entity";
+export * from "./marker";
 export * from "./math/math";
 export * from "./PerformanceModel/PerformanceModel";

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

@@ -4,9 +4,9 @@ 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 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}. */
+  /** 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[];
@@ -15,7 +15,7 @@ export declare type MarkerConfiguration = {
 /**
  * @desc Tracks the World, View and Canvas coordinates, and visibility, of a position within a {@link Scene}.
  */
-export class Marker extends Component {
+export declare class Marker extends Component {
   /**
    * @constructor
    * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this Marker as well.
@@ -26,8 +26,8 @@ export class Marker extends Component {
   /**
    * 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.
+   * 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}
    */
@@ -59,10 +59,10 @@ export class Marker extends Component {
   /**
    * 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.
+   * 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}.
+   * can adjust that frequency via property {@link Scene.ticksPerOcclusionTest}.
    *
    * @type {Boolean}
    */
@@ -71,7 +71,7 @@ export class Marker extends Component {
   /**
    * 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.
+   * 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}
    */
@@ -80,7 +80,7 @@ export class Marker extends Component {
   /**
    * Gets the RTC center of this Marker.
    *
-   * This is automatically calculated from {@link Marker#worldPos}.
+   * This is automatically calculated from {@link Marker.worldPos}.
    *
    * @type {Number[]}
    */
@@ -89,7 +89,7 @@ export class Marker extends Component {
   /**
    * Gets the RTC position of this Marker.
    *
-   * This is automatically calculated from {@link Marker#worldPos}.
+   * This is automatically calculated from {@link Marker.worldPos}.
    *
    * @type {Number[]}
    */
@@ -98,7 +98,7 @@ export class Marker extends Component {
   /**
    * 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.
+   * 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.
    *
@@ -109,7 +109,7 @@ export class Marker extends Component {
   /**
    * 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.
+   * 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.
    *
@@ -124,9 +124,9 @@ export class Marker extends Component {
    *
    * 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.
+   * * {@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.
    *

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

@@ -18,7 +18,7 @@ export declare type EmphasisMaterialConfiguration = {
   edgeAlpha?: number;
   /** Width of xray edges, in pixels. */
   edgeWidth?: number;
-  /** Selects a preset EmphasisMaterial configuration - see {@link EmphasisMaterial#presets}. */
+  /** Selects a preset EmphasisMaterial configuration - see {@link EmphasisMaterial.presets}. */
   preset?: string;
   /** Whether to render geometry backfaces when emphasising. */
   backfaces?: boolean;
@@ -202,7 +202,7 @@ export declare class EmphasisMaterial extends Material {
   get edgeWidth(): number;
 
   /**
-   * Sets whether to render backfaces when {@link EmphasisMaterial#fill} is ````true````.
+   * Sets whether to render backfaces when {@link EmphasisMaterial.fill} is ````true````.
    *
    * Default is ````false````.
    *
@@ -211,7 +211,7 @@ export declare class EmphasisMaterial extends Material {
   set backfaces(arg: boolean);
 
   /**
-   * Gets whether to render backfaces when {@link EmphasisMaterial#fill} is ````true````.
+   * Gets whether to render backfaces when {@link EmphasisMaterial.fill} is ````true````.
    *
    * Default is ````true````.
    *

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

@@ -63,7 +63,7 @@ export declare class Fresnel extends Component {
      * @param {Number} [cfg.power=0]  The power.
      */
     constructor(owner: Component, cfg?: any);
-    _state: RenderState;
+    _state: any;
     /**
      * Sets the Fresnel's edge color.
      *
@@ -145,5 +145,4 @@ export declare class Fresnel extends Component {
      */
     get power(): number;
 }
-import { Component } from "../Component.js";
-import { RenderState } from "../webgl/RenderState.js";
+import { Component } from "../Component";

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

@@ -6,7 +6,7 @@ export declare type LinesMaterialConfiguration = {
   id?: string;
   /** Line width in pixels. */
   lineWidth?: number;
-  /** Selects a preset LinesMaterial configuration - see {@link LinesMaterial#presets}. */
+  /** Selects a preset LinesMaterial configuration - see {@link LinesMaterial.presets}. */
   preset?: string;
 };