@xeokit/xeokit-sdk 2.4.2-beta-8 → 2.4.2-beta-9

package/types/viewer/scene/models/VBOSceneModel/VBOSceneModel.d.ts

@@ -1,615 +1,7 @@
-import { Entity } from "../../Entity";
-import { Component } from "../../Component";
-import { EdgeMaterial, EmphasisMaterial } from "../../materials";
+import {SceneModel} from "../SceneModel";
 
 /**
  * A high-performance model representation for efficient rendering and low memory usage.
  */
-export declare class VBOSceneModel extends Component {
-
-  /**
-   * Fires when the model is loaded
-   * @param event The loaded event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-  on(event: "loaded", callback: (loaded: true) => void, scope?: any): string;
-
-  /**
-   * Fires when the loading the model has an error
-   * @param event The error event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-   on(event: "error", callback: (msg: string) => void, scope?: any): string;
-
-  /**
-  * Returns the {@link Entity}s in this VBOSceneModel.
-  * @returns {*|{}}
-  */
-  get objects(): {[key: string]: Entity}
-
-  /**
-  * Gets the 3D World-space origin for this VBOSceneModel.
-  *
-  * Each geometry or mesh origin, if supplied, is relative to this origin.
-  *
-  * Default value is ````[0,0,0]````.
-  *
-  * @type {Number[]}
-  */
-  get origin(): number[];
-
-  /**
-  * Gets the VBOSceneModel's local translation.
-  *
-  * Default value is ````[0,0,0]````.
-  *
-  * @type {Number[]}
-  */
-  get position(): number[];
-
-  /**
-  * Gets the VBOSceneModel's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
-  *
-  * Default value is ````[0,0,0]````.
-  *
-  * @type {Number[]}
-  */
-  get rotation(): number[];
-
-  /**
-  * Gets the VBOSceneModels's local rotation quaternion.
-  *
-  * Default value is ````[0,0,0,1]````.
-  *
-  * @type {Number[]}
-  */
-  get quaternion(): number[];
-
-  /**
-  * Gets the VBOSceneModel's local scale.
-  *
-  * Default value is ````[1,1,1]````.
-  *
-  * @type {Number[]}
-  */
-  get scale(): number[];
-
-  /**
-  * Gets the VBOSceneModel's local modeling transform matrix.
-  *
-  * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
-  *
-  * @type {Number[]}
-  */
-  get matrix(): number[];
-
-  /**
-  * Gets the VBOSceneModel's World matrix.
-  *
-  * @type {Number[]}
-  */
-  get worldMatrix(): number[];
-
-  /**
-  * Gets the VBOSceneModel's World normal matrix.
-  *
-  * @type {Number[]}
-  */
-  get worldNormalMatrix(): number[];
-
-  /**
-   * Sets if backfaces are rendered for this VBOSceneModel.
-   *
-   * Default is ````false````.
-   *
-   * @type {Boolean}
-   */
-  get backfaces(): boolean;
-
-  /**
-   * Sets if backfaces are rendered for this VBOSceneModel.
-   *
-   * Default is ````false````.
-   *
-   * When we set this ````true````, then backfaces are always rendered for this VBOSceneModel.
-   *
-   * When we set this ````false````, then we allow the Viewer to decide whether to render backfaces. In this case,
-   * the Viewer will:
-   *
-   *  * hide backfaces on watertight meshes,
-   *  * show backfaces on open meshes, and
-   *  * always show backfaces on meshes when we slice them open with {@link SectionPlane}s.
-   *
-   * @type {Boolean}
-   */
-  set backfaces(backfaces: boolean);
-
-  /**
-   * Gets the list of {@link Entity}s within this VBOSceneModel.
-   *
-   * @returns {Entity[]}
-   */
-  get entityList(): Entity[];
-
-  /**
-   * Returns true to indicate that VBOSceneModel is an {@link Entity}.
-   * @type {Boolean}
-   */
-  get isEntity(): boolean;
-
-  /**
-   * Returns ````true```` if this VBOSceneModel represents a model.
-   *
-   * When ````true```` the VBOSceneModel will be registered by {@link VBOSceneModel.id} in
-   * {@link Scene.models} and may also have a {@link MetaObject} with matching {@link MetaObject.id}.
-   *
-   * @type {Boolean}
-   */
-  get isModel(): boolean;
-
-  /**
-   * Returns ````false```` to indicate that VBOSceneModel never represents an object.
-   *
-   * @type {Boolean}
-   */
-  get isObject(): boolean;
-
-  /**
-   * Gets the VBOSceneModel's World-space 3D axis-aligned bounding box.
-   *
-   * Represented by a six-element Float64Array containing the min/max extents of the
-   * axis-aligned volume, ie. ````[xmin, ymin,zmin,xmax,ymax, zmax]````.
-   *
-   * @type {Number[]}
-   */
-  get aabb(): number[];
-
-  /**
-   * The approximate number of triangle primitives in this VBOSceneModel.
-   *
-   * @type {Number}
-   */
-  get numTriangles(): number;
-
-  /**
-   * The approximate number of line primitives in this VBOSceneModel.
-   *
-   * @type {Number}
-   */
-  get numLines(): number;
-
-  /**
-   * The approximate number of point primitives in this VBOSceneModel.
-   *
-   * @type {Number}
-   */
-  get numPoints(): number;
-
-  /**
-   * Gets if any {@link Entity}s in this VBOSceneModel are visible.
-   *
-   * The VBOSceneModel is only rendered when {@link VBOSceneModel.visible} is ````true```` and {@link VBOSceneModel.culled} is ````false````.
-   *
-   * @type {Boolean}
-   */
-  get visible(): boolean;
-
-  /**
-   * Sets if this VBOSceneModel is visible.
-   *
-   * The VBOSceneModel is only rendered when {@link VBOSceneModel.visible} is ````true```` and {@link VBOSceneModel.culled} is ````false````.
-   **
-   * @type {Boolean}
-   */
-  set visible(visible: boolean);
-
-  /**
-   * Gets if any {@link Entity}s in this VBOSceneModel are xrayed.
-   *
-   * @type {Boolean}
-   */
-  get xrayed(): boolean
-
-  /**
-   * Sets if all {@link Entity}s in this VBOSceneModel are xrayed.
-   *
-   * @type {Boolean}
-   */
-  set xrayed(xrayed: boolean);
-
-  /**
-   * Gets if any {@link Entity}s in this VBOSceneModel are highlighted.
-   *
-   * @type {Boolean}
-   */
-  get highlighted(): boolean;
-
-  /**
-   * Sets if all {@link Entity}s in this VBOSceneModel are highlighted.
-   *
-   * @type {Boolean}
-   */
-  set highlighted(highlighted: boolean);
-
-  /**
-   * Gets if any {@link Entity}s in this VBOSceneModel are selected.
-   *
-   * @type {Boolean}
-   */
-  get selected(): boolean;
-
-  /**
-   * Sets if all {@link Entity}s in this VBOSceneModel are selected.
-   *
-   * @type {Boolean}
-   */
-  set selected(selected: boolean);
-
-  /**
-   * Gets if any {@link Entity}s in this VBOSceneModel have edges emphasised.
-   *
-   * @type {Boolean}
-   */
-  get edges(): boolean;
-
-  /**
-   * Sets if all {@link Entity}s in this VBOSceneModel have edges emphasised.
-   *
-   * @type {Boolean}
-   */
-  set edges(edges: boolean);
-
-  /**
-   * Gets if this VBOSceneModel is culled from view.
-   *
-   * The VBOSceneModel is only rendered when {@link VBOSceneModel.visible} is true and {@link VBOSceneModel.culled} is false.
-   *
-   * @type {Boolean}
-   */
-  get culled(): boolean;
-
-  /**
-   * Sets if this VBOSceneModel is culled from view.
-   *
-   * The VBOSceneModel is only rendered when {@link VBOSceneModel.visible} is true and {@link VBOSceneModel.culled} is false.
-   *
-   * @type {Boolean}
-   */
-  set culled(culled: boolean);
-
-  /**
-   * Gets if {@link Entity}s in this VBOSceneModel are clippable.
-   *
-   * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
-   *
-   * @type {Boolean}
-   */
-  get clippable(): boolean;
-
-  /**
-   * Sets if {@link Entity}s in this VBOSceneModel are clippable.
-   *
-   * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
-   *
-   * @type {Boolean}
-   */
-  set clippable(clippable: boolean) ;
-
-  /**
-   * Gets if this VBOSceneModel is collidable.
-   *
-   * @type {Boolean}
-   */
-  get collidable(): boolean;
-
-  /**
-   * Sets if {@link Entity}s in this VBOSceneModel are collidable.
-   *
-   * @type {Boolean}
-   */
-  set collidable(collidable: boolean);
-
-  /**
-   * Gets if this VBOSceneModel is pickable.
-   *
-   * Picking is done via calls to {@link Scene.pick}.
-   *
-   * @type {Boolean}
-   */
-  get pickable(): boolean;
-
-  /**
-   * Sets if {@link Entity}s in this VBOSceneModel are pickable.
-   *
-   * Picking is done via calls to {@link Scene.pick}.
-   *
-   * @type {Boolean}
-   */
-  set pickable(pickable: boolean);
-
-  /**
-   * Gets the RGB colorize color for this VBOSceneModel.
-   *
-   * Each element of the color is in range ````[0..1]````.
-   *
-   * @type {Number[]}
-   */
-  get colorize(): number[];
-
-  /**
-   * Sets the RGB colorize color for this VBOSceneModel.
-   *
-   * Multiplies by rendered fragment colors.
-   *
-   * Each element of the color is in range ````[0..1]````.
-   *
-   * @type {Number[]}
-   */
-  set colorize(colorize: number[]);
-
-  /**
-   * Gets this VBOSceneModel's opacity factor.
-   *
-   * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
-   *
-   * @type {Number}
-   */
-  get opacity(): number;
-
-  /**
-   * Sets the opacity factor for this VBOSceneModel.
-   *
-   * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
-   *
-   * @type {Number}
-   */
-  set opacity(opacity: number);
-
-  /**
-   * Gets if this VBOSceneModel casts a shadow.
-   *
-   * @type {Boolean}
-   */
-  get castsShadow(): boolean;
-
-  /**
-   * Sets if this VBOSceneModel casts a shadow.
-   *
-   * @type {Boolean}
-   */
-  set castsShadow(castsShadow: boolean);
-
-  /**
-   * Sets if this VBOSceneModel can have shadow cast upon it.
-   *
-   * @type {Boolean}
-   */
-  get receivesShadow(): boolean;
-
-  /**
-   * Sets if this VBOSceneModel can have shadow cast upon it.
-   *
-   * @type {Boolean}
-   */
-  set receivesShadow(receivesShadow: boolean) ;
-
-  /**
-   * Gets if Scalable Ambient Obscurance (SAO) will apply to this VBOSceneModel.
-   *
-   * SAO is configured by the Scene's {@link SAO} component.
-   *
-   *  Only works when {@link SAO.enabled} is also true.
-   *
-   * @type {Boolean}
-   */
-  get saoEnabled(): boolean;
-
-  /**
-   * Gets if physically-based rendering (PBR) is enabled for this VBOSceneModel.
-   *
-   * Only works when {@link Scene.pbrEnabled} is also true.
-   *
-   * @type {Boolean}
-   */
-  get pbrEnabled(): boolean;
-
-  /**
-   * Returns true to indicate that VBOSceneModel is implements {@link Drawable}.
-   *
-   * @type {Boolean}
-   */
-  get isDrawable(): boolean;
-
-  /**
-   * Configures the appearance of xrayed {@link Entity}s within this VBOSceneModel.
-   *
-   * This is the {@link Scene.xrayMaterial}.
-   *
-   * @type {EmphasisMaterial}
-   */
-  get xrayMaterial(): EmphasisMaterial;
-
-  /**
-   * Configures the appearance of highlighted {@link Entity}s within this VBOSceneModel.
-   *
-   * This is the {@link Scene.highlightMaterial}.
-   *
-   * @type {EmphasisMaterial}
-   */
-  get highlightMaterial(): EmphasisMaterial;
-
-  /**
-   * Configures the appearance of selected {@link Entity}s within this VBOSceneModel.
-   *
-   * This is the {@link Scene.selectedMaterial}.
-   *
-   * @type {EmphasisMaterial}
-   */
-  get selectedMaterial(): EmphasisMaterial;
-
-  /**
-   * Configures the appearance of edges of {@link Entity}s within this VBOSceneModel.
-   *
-   * This is the {@link Scene.edgeMaterial}.
-   *
-   * @type {EdgeMaterial}
-   */
-  get edgeMaterial(): EdgeMaterial;
-
-  /**
-   * Creates a reusable geometry within this VBOSceneModel.
-   *
-   * We can then supply the geometry ID to {@link VBOSceneModel.createMesh} when we want to create meshes that instance the geometry.
-   *
-   * If provide a  ````positionsDecodeMatrix```` , then ````createGeometry()```` will assume
-   * that the ````positions```` and ````normals```` arrays are compressed. When compressed, ````positions```` will be
-   * quantized and in World-space, and ````normals```` will be oct-encoded and in World-space.
-   *
-   * Note that ````positions````, ````normals```` and ````indices```` are all required together.
-   *
-   * @param {*} cfg Geometry properties.
-   * @param {String|Number} cfg.id Mandatory ID for the geometry, to refer to with {@link VBOSceneModel.createMesh}.
-   * @param {String} cfg.primitive The primitive type. Accepted values are 'points', 'lines', 'triangles', 'solid' and 'surface'.
-   * @param {Number[]} cfg.positions Flat array of positions.
-   * @param {Number[]} [cfg.normals] Flat array of normal vectors. Only used with 'triangles' primitives. When no normals are given, the geometry will be flat shaded using auto-generated face-aligned normals.
-   * @param {Number[]} [cfg.colors] Flat array of RGBA vertex colors as float values in range ````[0..1]````. Ignored when ````geometryId```` is given, overidden by ````color```` and ````colorsCompressed````.
-   * @param {Number[]} [cfg.colorsCompressed] Flat array of RGBA vertex colors as unsigned short integers in range ````[0..255]````. Ignored when ````geometryId```` is given, overrides ````colors```` and is overriden by ````color````.
-   * @param {Number[]} [cfg.indices] Array of indices. Not required for `points` primitives.
-   * @param {Number[]} [cfg.edgeIndices] Array of edge line indices. Used only for Required for 'triangles' primitives. These are automatically generated internally if not supplied, using the ````edgeThreshold```` given to the ````VBOSceneModel```` constructor.
-   * @param {Number[]} [cfg.positionsDecodeMatrix] A 4x4 matrix for decompressing ````positions````.
-   * @param {Number[]} [cfg.origin] Optional geometry origin, relative to {@link VBOSceneModel.origin}. When this is given, then every mesh created with {@link VBOSceneModel.createMesh} that uses this geometry will
-   * be transformed relative to this origin.
-   */
-  createGeometry(cfg: {
-    id: string | number;
-    primitive: "lines" | "triangles" | "solid" | "surface";
-    positions: number[];
-    normals: number[];
-    colors: number[];
-    colorsCompressed: number[];
-    indices: number[];
-    edgeIndices: number[];
-    positionsDecodeMatrix: number[];
-    origin?: number[];
-  }): void;
-
-  /**
-   * Creates a mesh within this VBOSceneModel.
-   *
-   * A mesh can either share geometry with other meshes, or have its own unique geometry.
-   *
-   * To share a geometry with other meshes, provide the ID of a geometry created earlier
-   * with {@link VBOSceneModel.createGeometry}.
-   *
-   * To create unique geometry for the mesh, provide geometry data arrays.
-   *
-   * Internally, VBOSceneModel will batch all unique mesh geometries into the same arrays, which improves
-   * rendering performance.
-   *
-   * If you accompany the arrays with a  ````positionsDecodeMatrix```` , then ````createMesh()```` will assume
-   * that the ````positions```` and ````normals```` arrays are compressed. When compressed, ````positions```` will be
-   * quantized and in World-space, and ````normals```` will be oct-encoded and in World-space.
-   *
-   * If you accompany the arrays with an  ````origin````, then ````createMesh()```` will assume
-   * that the ````positions```` are in relative-to-center (RTC) coordinates, with ````origin```` being the origin of their
-   * RTC coordinate system.
-   *
-   * When providing either ````positionsDecodeMatrix```` or ````origin````, ````createMesh()```` will start a new
-   * batch each time either of those two parameters change since the last call. Therefore, to combine arrays into the
-   * minimum number of batches, it's best for performance to create your shared meshes in runs that have the same value
-   * for ````positionsDecodeMatrix```` and ````origin````.
-   *
-   * Note that ````positions````, ````normals```` and ````indices```` are all required together.
-   *
-   * @param {object} cfg Object properties.
-   * @param {String} cfg.id Mandatory ID for the new mesh. Must not clash with any existing components within the {@link Scene}.
-   * @param {String|Number} [cfg.geometryId] ID of a geometry to instance, previously created with {@link VBOSceneModel.createGeometry:method"}}createMesh(){{/crossLink}}. Overrides all other geometry parameters given to this method.
-   * @param {String} [cfg.primitive="triangles"]  Geometry primitive type. Ignored when ````geometryId```` is given. Accepted values are 'points', 'lines' and 'triangles'.
-   * @param {Number[]} [cfg.positions] Flat array of vertex positions. Ignored when ````geometryId```` is given.
-   * @param {Number[]} [cfg.colors] Flat array of RGB vertex colors as float values in range ````[0..1]````. Ignored when ````geometryId```` is given, overriden by ````color```` and ````colorsCompressed````.
-   * @param {Number[]} [cfg.colorsCompressed] Flat array of RGB vertex colors as unsigned short integers in range ````[0..255]````. Ignored when ````geometryId```` is given, overrides ````colors```` and is overriden by ````color````.
-   * @param {Number[]} [cfg.normals] Flat array of normal vectors. Only used with 'triangles' primitives. When no normals are given, the mesh will be flat shaded using auto-generated face-aligned normals.
-   * @param {Number[]} [cfg.positionsDecodeMatrix] A 4x4 matrix for decompressing ````positions````.
-   * @param {Number[]} [cfg.origin] Optional geometry origin, relative to {@link VBOSceneModel.origin}. When this is given, then ````positions```` are assumed to be relative to this.
-   * @param {Number[]} [cfg.indices] Array of triangle indices. Ignored when ````geometryId```` is given.
-   * @param {Number[]} [cfg.edgeIndices] Array of edge line indices. If ````geometryId```` is not given, edge line indices are
-   * automatically generated internally if not given, using the ````edgeThreshold```` given to the ````VBOSceneModel````
-   * constructor. This parameter is ignored when ````geometryId```` is given.
-   * @param {Number[]} [cfg.position=[0,0,0]] Local 3D position. of the mesh
-   * @param {Number[]} [cfg.scale=[1,1,1]] Scale of the mesh.
-   * @param {Number[]} [cfg.rotation=[0,0,0]] Rotation of the mesh as Euler angles given in degrees, for each of the X, Y and Z axis.
-   * @param {Number[]} [cfg.matrix=[1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]] Mesh modelling transform matrix. Overrides the ````position````, ````scale```` and ````rotation```` parameters.
-   * @param {Number[]} [cfg.color=[1,1,1]] RGB color in range ````[0..1, 0..`, 0..1]````. Overrides ````colors```` and ````colorsCompressed````.
-   * @param {Number} [cfg.opacity=1] Opacity in range ````[0..1]````.
-   */
-  createMesh(cfg: {
-    id: string;
-    geometryId?: string | number;
-    primitive: "lines" | "triangles" | "points";
-    positions: number[];
-    normals: number[];
-    colors: number[];
-    colorsCompressed: number[];
-    indices: number[];
-    edgeIndices: number[];
-    positionsDecodeMatrix: number[];
-    origin?: number[];
-    position?: number[];
-    scale?: number[];
-    rotation?: number[];
-    matrix?: number[];
-    color?: number[];
-    opacity?: number;
-  }): void;
-
-  /**
-   * Creates an {@link Entity} within this VBOSceneModel, giving it one or more meshes previously created with {@link VBOSceneModel.createMesh}.
-   *
-   * A mesh can only belong to one {@link Entity}, so you'll get an error if you try to reuse a mesh among multiple {@link Entity}s.
-   *
-   * @param {Object} cfg Entity configuration.
-   * @param {String} cfg.id Optional ID for the new Entity. Must not clash with any existing components within the {@link Scene}.
-   * @param {String[]} cfg.meshIds IDs of one or more meshes created previously with {@link VBOSceneModel@createMesh}.
-
-   * @param {Boolean} [cfg.isObject] Set ````true```` if the {@link Entity} represents an object, in which case it will be registered by {@link Entity.id} in {@link Scene.objects} and can also have a corresponding {@link MetaObject} with matching {@link MetaObject.id}, registered by that ID in {@link MetaScene.metaObjects}.
-   * @param {Boolean} [cfg.visible=true] Indicates if the Entity is initially visible.
-   * @param {Boolean} [cfg.culled=false] Indicates if the Entity is initially culled from view.
-   * @param {Boolean} [cfg.pickable=true] Indicates if the Entity is initially pickable.
-   * @param {Boolean} [cfg.clippable=true] Indicates if the Entity is initially clippable.
-   * @param {Boolean} [cfg.collidable=true] Indicates if the Entity is initially included in boundary calculations.
-   * @param {Boolean} [cfg.castsShadow=true] Indicates if the Entity initially casts shadows.
-   * @param {Boolean} [cfg.receivesShadow=true]  Indicates if the Entity initially receives shadows.
-   * @param {Boolean} [cfg.xrayed=false] Indicates if the Entity is initially xrayed. XRayed appearance is configured by {@link VBOSceneModel.xrayMaterial}.
-   * @param {Boolean} [cfg.highlighted=false] Indicates if the Entity is initially highlighted. Highlighted appearance is configured by {@link VBOSceneModel.highlightMaterial}.
-   * @param {Boolean} [cfg.selected=false] Indicates if the Entity is initially selected. Selected appearance is configured by {@link VBOSceneModel.selectedMaterial}.
-   * @param {Boolean} [cfg.edges=false] Indicates if the Entity's edges are initially emphasized. Edges appearance is configured by {@link VBOSceneModel.edgeMaterial}.
-   * @returns {Entity}
-   */
-  createEntity(cfg: {
-    id: string;
-    meshIds: string[]
-    isObject: boolean;
-    visible?: boolean;
-    culled?: boolean;
-    pickable?: boolean;
-    clippable?: boolean;
-    collidable?: boolean;
-    castsShadow?: boolean;
-    receivesShadow?: boolean;
-    xrayed?: boolean;
-    highlighted?: boolean;
-    selected?: boolean;
-    edges?: boolean;
-  }): Entity;
-
-  /**
-   * Finalizes this VBOSceneModel.
-   *
-   * Immediately creates the VBOSceneModel's {@link Entity}s within the {@link Scene}.
-   *
-   * Once finalized, you can't add anything more to this VBOSceneModel.
-   */
-  finalize(): void;
+export declare class VBOSceneModel extends SceneModel {
 }

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

@@ -1 +1,8 @@
-export * from "./VBOSceneModel/";
+export * from "./VBOSceneModel/";
+export * from "./PerformanceModel/";
+export * from "./SceneModel";
+export * from "./SceneModelMesh";
+export * from "./SceneModelTransform";
+export * from "./SceneModelTexture";
+export * from "./SceneModelTextureSet";
+export * from "./SceneModelEntity";