Reference Source
public class | source

VBOSceneModel

Extends:

ComponentSceneModel → VBOSceneModel

Implements:

Indirect Implements:

this class was deprecated.

A high-performance model representation for efficient rendering and low memory usage.

  • VBOSceneModel was replaced with SceneModel in xeokit-sdk v2.4.
  • VBOSceneModel currently extends SceneModel, in order to maintain backward-compatibility until we remove VBOSceneModel.
  • See SceneModel for API details.

Constructor Summary

Public Constructor
public

constructor(owner: *, cfg: *)

See VBOSceneModel for details.

Inherited Summary

From class Component
public get

The Component that owns the lifecycle of this Component, if any.

public

True as soon as this Component has been destroyed

public

ID of this Component, unique within the Scene.

public

meta: *

Arbitrary, user-defined metadata on this component.

public

The parent Scene that contains this Component.

public

The viewer that contains this Scene.

public

clear()

Destroys all Components that are owned by this.

public

Destroys this component.

public

error(message: String)

Logs an error for this component to the JavaScript console.

public

fire(event: String, value: Object, forget: Boolean)

Fires an event on this component.

public

Returns true if there are any subscribers to the given event on this component.

public

isType(type: *): *: Boolean

Tests if this component is of the given type, or is a subclass of the given type.

public

log(message: String)

Logs a console debugging message for this component.

public

off(subId: String)

Cancels an event subscription that was previously made with Component#on or Component#once.

public

on(event: String, callback: Function, scope: Object): String

Subscribes to an event on this component.

public

once(event: String, callback: Function, scope: Object)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.

public

scheduleTask(task: *)

Schedule a task to perform on the next browser interval

public

warn(message: String)

Logs a warning for this component to the JavaScript console.

From class SceneModel
public get

Gets the SceneModel'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].

public get

Sets if backfaces are rendered for this SceneModel.

public set

Sets if backfaces are rendered for this SceneModel.

public get

Gets if this SceneModel casts a shadow.

public set

Sets if this SceneModel casts a shadow.

public get

Gets if SceneModelEntitys in this SceneModel are clippable.

public set

Sets if SceneModelEntitys in this SceneModel are clippable.

public get

Gets if this SceneModel is collidable.

public set

Sets if SceneModelEntitys in this SceneModel are collidable.

public get

Gets if color textures are enabled for this SceneModel.

public get

Gets the RGB colorize color for this SceneModel.

public set

Sets the RGB colorize color for this SceneModel.

public get

Gets if this SceneModel is culled from view.

public set

Sets if this SceneModel is culled from view.

public get

Configures the appearance of edges of SceneModelEntitys within this SceneModel.

public get

Gets if any SceneModelEntitys in this SceneModel have edges emphasised.

public set

Sets if all SceneModelEntitys in this SceneModel have edges emphasised.

public get

Gets the list of SceneModelEntitys within this SceneModel.

public get

Configures the appearance of highlighted SceneModelEntitys within this SceneModel.

public get

Gets if any SceneModelEntitys in this SceneModel are highlighted.

public set

Sets if all SceneModelEntitys in this SceneModel are highlighted.

public get

Returns true to indicate that SceneModel is implements Drawable.

public get

Returns true to indicate that SceneModel is an Entity.

public get

Returns true if this SceneModel represents a model.

public get

Returns false to indicate that SceneModel never represents an object.

public get

Returns true to indicate that this Component is a SceneModel.

public get

Gets the SceneModel's local modeling transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

public set

Sets the SceneModel's local modeling transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

public get

meshes: * | {}: *

The SceneModelMeshes in this SceneModel.

public get

The approximate number of line primitives in this SceneModel.

public get

The approximate number of point primitives in this SceneModel.

public get

The approximate number of triangle primitives in this SceneModel.

public get

objects: * | {}: *

The SceneModelEntitys in this SceneModel.

public get

Gets this SceneModel's opacity factor.

This is a factor in range [0..1] which multiplies by the rendered fragment alphas.

public set

Sets the opacity factor for this SceneModel.

public get

Gets the 3D World-space origin for this SceneModel.

public get

Gets if physically-based rendering (PBR) is enabled for this SceneModel.

public get

Gets if this SceneModel is pickable.

public set

Sets if SceneModelEntitys in this SceneModel are pickable.

public get

Gets the SceneModel's local translation.

Default value is [0,0,0].

public set

Sets the SceneModel's local translation.

Default value is [0,0,0].

public get

Gets the SceneModel's local rotation quaternion.

Default value is [0,0,0,1].

public set

Sets the SceneModel's local rotation quaternion.

Default value is [0,0,0,1].

public get

Sets if this SceneModel can have shadow cast upon it.

public set

Sets if this SceneModel can have shadow cast upon it.

public get

Gets the SceneModel's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.

Default value is [0,0,0].

public set

Sets the SceneModel's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.

Default value is [0,0,0].

public get

Gets the SceneModel's local modeling rotation transform matrix.

public get

Gets the conjugate of the SceneModel's local modeling rotation transform matrix.

This is used for RTC view matrix management in renderers.

public get

Gets if Scalable Ambient Obscurance (SAO) will apply to this SceneModel.

public get
this get was deprecated.

Gets the SceneModel's local scale.

Default value is [1,1,1].

public set
this set was deprecated.

Sets the SceneModel's local scale.

Default value is [1,1,1].

public get

Gets if any SceneModelEntitys in this SceneModel are selected.

public set

Sets if all SceneModelEntitys in this SceneModel are selected.

public get

Configures the appearance of selected SceneModelEntitys within this SceneModel.

public get

textureSets: * | {}: *

The SceneModelTextureSets in this SceneModel.

public get

textures: * | {}: *

The SceneModelTextures in this SceneModel.

public get

transforms: * | {}: *

The SceneModelTransforms in this SceneModel.

public get

Gets if any SceneModelEntitys in this SceneModel are visible.

public set

Sets if this SceneModel is visible.

public get

Gets the SceneModel's World matrix.

public get

Gets the SceneModel's World normal matrix.

public get

Configures the appearance of xrayed SceneModelEntitys within this SceneModel.

public get

Gets if any SceneModelEntitys in this SceneModel are xrayed.

public set

Sets if all SceneModelEntitys in this SceneModel are xrayed.

public

layerList: *[]

public
public

Creates a SceneModelEntity within this SceneModel.

public

createGeometry(cfg: *): *

Creates a reusable geometry within this SceneModel.

public

Creates a new SceneModelMesh within this SceneModel.

public
public

createTexture(cfg: *): *

Creates a texture within this SceneModel.

public

Creates a texture set within this SceneModel.

public

Creates a new SceneModelTransform within this SceneModel.

public

Destroys this SceneModel.

public

Finalizes this SceneModel.

Public Constructors

public constructor(owner: *, cfg: *) source

See VBOSceneModel for details.

Override:

SceneModel#constructor

Params:

NameTypeAttributeDescription
owner *
cfg *