@xeokit/xeokit-sdk 2.6.78-rc2-no-las → 2.6.78

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

@@ -51,7 +51,7 @@ export abstract class Component {
      * @property owner
      * @type {Component}
      */
-    readonly owner: Component;
+    get owner(): Component;
 
     /**
      * Tests if this component is of the given type, or is a subclass of the given type.

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

@@ -12,7 +12,7 @@ export declare abstract class Entity {
    * @type {Number|String}
    * @abstract
    */
-  readonly id: string | number;
+  get id(): string | number;
 
   /**
    * ID of the corresponding object within the originating system, if any.
@@ -24,14 +24,14 @@ export declare abstract class Entity {
    *
    * @type {String}
    */
-  readonly originalSystemId: string;
+  get originalSystemId(): string;
 
   /**
    * Returns true to indicate that this is an Entity.
    *
    * @returns {Boolean}
    */
-  readonly isEntity: boolean;
+  get isEntity(): boolean;
 
   /**
    * Returns ````true```` if this Entity represents a model.
@@ -42,7 +42,7 @@ export declare abstract class Entity {
    * @type {Boolean}
    * @abstract
    */
-  readonly isModel: boolean;
+  get isModel(): boolean;
 
   /**
    * Returns ````true```` if this Entity represents an object.
@@ -53,18 +53,26 @@ export declare abstract class Entity {
    * @type {Boolean}
    * @abstract
    */
-  readonly isObject: boolean;
+  get isObject(): boolean;
 
   /** Returns the parent Entity, if any. */
-  readonly parent: void;
+  get parent(): void;
 
   /**
-   * The 3D World-space origin for this Entity.
+   * Sets the 3D World-space origin for this Entity.
    *
    * @type {Float64Array}
    * @abstract
    */
-  origin: Float64Array;
+  set origin(arg: Float64Array);
+
+  /**
+   * Gets the 3D World-space origin for this Entity.
+   *
+   * @type {Float64Array}
+   * @abstract
+   */
+  get origin(): Float64Array;
 
   /**
    * World-space 3D axis-aligned bounding box (AABB) of this Entity.
@@ -75,7 +83,7 @@ export declare abstract class Entity {
    * @type {Float64Array}
    * @abstract
    */
-  readonly aabb: number[];
+  get aabb(): number[];
 
   /**
    * The approximate number of triangles in this Entity.
@@ -83,10 +91,23 @@ export declare abstract class Entity {
    * @type {Number}
    * @abstract
    */
-  readonly numTriangles: number;
+  get numTriangles(): number;
+
+  /**
+   * Sets if this Entity is visible.
+   *
+   * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
+   *
+   * When {@link Entity.isObject} and {@link Entity.visible} are both ````true```` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.visibleObjects}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set visible(arg: boolean);
 
   /**
-   * Whether this Entity is visible.
+   * Gets if this Entity is visible.
    *
    * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
    *
@@ -96,10 +117,10 @@ export declare abstract class Entity {
    * @type {Boolean}
    * @abstract
    */
-  visible: boolean;
+  get visible(): boolean;
 
   /**
-   * Whether this Entity is xrayed.
+   * Sets if this Entity is xrayed.
    *
    * When {@link Entity.isObject} and {@link Entity.xrayed} are both ````true``` the Entity will be
    * registered by {@link Entity.id} in {@link Scene.xrayedObjects}.
@@ -107,10 +128,21 @@ export declare abstract class Entity {
    * @type {Boolean}
    * @abstract
    */
-  xrayed: boolean;
+  set xrayed(arg: boolean);
 
   /**
-   * Whether this Entity is highlighted.
+   * Gets if this Entity is xrayed.
+   *
+   * When {@link Entity.isObject} and {@link Entity.xrayed} are both ````true``` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.xrayedObjects}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get xrayed(): boolean;
+
+  /**
+   * Sets if this Entity is highlighted.
    *
    * When {@link Entity.isObject} and {@link Entity.highlighted} are both ````true```` the Entity will be
    * registered by {@link Entity.id} in {@link Scene.highlightedObjects}.
@@ -118,10 +150,21 @@ export declare abstract class Entity {
    * @type {Boolean}
    * @abstract
    */
-  highlighted: boolean;
+  set highlighted(arg: boolean);
 
   /**
-   * Whether this Entity is selected.
+   * Gets if this Entity is highlighted.
+   *
+   * When {@link Entity.isObject} and {@link Entity.highlighted} are both ````true```` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.highlightedObjects}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get highlighted(): boolean;
+
+  /**
+   * Sets if this Entity is selected.
    *
    * When {@link Entity.isObject} and {@link Entity.selected} are both ````true``` the Entity will be
    * registered by {@link Entity.id} in {@link Scene.selectedObjects}.
@@ -129,102 +172,195 @@ export declare abstract class Entity {
    * @type {Boolean}
    * @abstract
    */
-  selected: boolean;
+  set selected(arg: boolean);
 
   /**
-   * Whether this Entity's edges are enhanced.
+   * Gets if this Entity is selected.
+   *
+   * When {@link Entity.isObject} and {@link Entity.selected} are both ````true``` the Entity will be
+   * registered by {@link Entity.id} in {@link Scene.selectedObjects}.
    *
    * @type {Boolean}
    * @abstract
    */
-  edges: boolean;
+  get selected(): boolean;
 
   /**
-   * Whether this Entity is culled.
+   * Sets if this Entity's edges are enhanced.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set edges(arg: boolean);
+
+  /**
+   * Gets if this Entity's edges are enhanced.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get edges(): boolean;
+
+  /**
+   * Sets if this Entity is culled.
+   *
+   * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set culled(arg: boolean);
+
+  /**
+   * Gets if this Entity is culled.
    *
    * Only rendered when {@link Entity.visible} is ````true```` and {@link Entity.culled} is ````false````.
    *
    * @type {Boolean}
    * @abstract
    */
-  culled: boolean;
+  get culled(): boolean;
+
+  /**
+   * Sets if this Entity is clippable.
+   *
+   * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set clippable(arg: boolean);
 
   /**
-   * Whether this Entity is clippable.
+   * Gets if this Entity is clippable.
    *
    * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
    *
    * @type {Boolean}
    * @abstract
    */
-  clippable: boolean;
+  get clippable(): boolean;
+
+  /**
+   * Sets if this Entity is included in boundary calculations.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set collidable(arg: boolean);
+
+  /**
+   * Gets if this Entity is included in boundary calculations.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get collidable(): boolean;
 
   /**
-   * Whether this Entity is included in boundary calculations.
+   * Sets if this Entity is pickable.
+   *
+   * Picking is done via calls to {@link Scene.pick}.
    *
    * @type {Boolean}
    * @abstract
    */
-  collidable: boolean;
+  set pickable(arg: boolean);
 
   /**
-   * Whether this Entity is pickable.
+   * Gets if this Entity is pickable.
    *
    * Picking is done via calls to {@link Scene.pick}.
    *
    * @type {Boolean}
    * @abstract
    */
-  pickable: boolean;
+  get pickable(): boolean;
 
   /**
-   * The Entity's RGB colorize color, multiplies by the Entity's rendered fragment colors.
+   * Sets the Entity's RGB colorize color, multiplies by the Entity's rendered fragment colors.
    *
    * Each element of the color is in range ````[0..1]````.
    *
    * @type {Number[]}
    * @abstract
    */
-  colorize: number[];
+  set colorize(arg: number[]);
 
   /**
-   * The Entity's opacity factor, multiplies by the Entity's rendered fragment alphas.
+   * Gets the Entity's RGB colorize color, multiplies by the Entity's rendered fragment colors.
+   *
+   * Each element of the color is in range ````[0..1]````.
+   *
+   * @type {Number[]}
+   * @abstract
+   */
+  get colorize(): number[];
+
+  /**
+   * Sets the Entity's opacity factor, multiplies by the Entity's rendered fragment alphas.
    *
    * This is a factor in range ````[0..1]````.
    *
    * @type {Number}
    * @abstract
    */
-  opacity: number;
+  set opacity(arg: number);
 
   /**
-   * Whether this Entity casts shadows.
+   * Gets the Entity's opacity factor.
+   *
+   * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
+   *
+   * @type {Number}
+   * @abstract
+   */
+  get opacity(): number;
+
+  /**
+   * Sets if this Entity casts shadows.
    *
    * @type {Boolean}
    * @abstract
    */
-  castsShadow: boolean;
+  set castsShadow(arg: boolean);
 
   /**
-   * Whether this Entity can have shadows cast upon it
+   * Gets if this Entity casts shadows.
    *
    * @type {Boolean}
    * @abstract
    */
-  receivesShadow: boolean;
+  get castsShadow(): boolean;
 
   /**
-   * Whether this Entity can have Scalable Ambient Obscurance (SAO) applied to it.
+   * Sets if to this Entity can have shadows cast upon it
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  set receivesShadow(arg: boolean);
+
+  /**
+   * Gets if this Entity can have shadows cast upon it
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get receivesShadow(): boolean;
+
+  /**
+   * Gets if this Entity can have Scalable Ambient Obscurance (SAO) applied to it.
    *
    * SAO is configured by {@link SAO}.
    *
    * @type {Boolean}
    * @abstract
    */
-  readonly saoEnabled: boolean;
+  get saoEnabled(): boolean;
 
   /**
-   * The Entity's 3D World-space offset.
+   * Sets the Entity's 3D World-space offset.
    *
    * Since offsetting Entities comes with memory and rendering overhead on some systems, this feature
    * only works when {@link Viewer} is configured with ````entityOffsetsEnabled: true````.
@@ -239,7 +375,17 @@ export declare abstract class Entity {
    * @abstract
    * @type {Number[]}
    */
-  offset: number[];
+  set offset(arg: number[]);
+
+  /**
+   * Gets the Entity's 3D World-space offset.
+   *
+   * Default value is ````[0,0,0]````.
+   *
+   * @abstract
+   * @type {Number[]}
+   */
+  get offset(): number[];
 
   /**
    * Gets the World, View and Canvas-space positions of each vertex in a callback.
@@ -248,6 +394,11 @@ export declare abstract class Entity {
    */
   getEachVertex(callback: any): void;
 
+  /**
+   * Gets the complete geometry of this entity.
+   */
+  getGeometryData(): {indices: number[],positions:number[]}
+
   /**
    * Destroys this Entity.
    */