import {PerformanceModel} from '@xeokit/xeokit-sdk/src/viewer/scene/model/PerformanceModel.js'

public class | source

PerformanceModel

Extends:

Component → SceneModel → PerformanceModel

Implements:

Drawable
Entity

Indirect Implements:

Entity

this class was deprecated.

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

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

Constructor Summary

Public Constructor
public	constructor(owner: , cfg: ) See VBOSceneModel for details.

Inherited Summary

From class Component
public get	owner: Component The Component that owns the lifecycle of this Component, if any.
public	destroyed: Boolean True as soon as this Component has been destroyed
public	id: String \| Number ID of this Component, unique within the Scene.
public	meta: * Arbitrary, user-defined metadata on this component.
public	scene: Scene The parent Scene that contains this Component.
public	viewer: Viewer The viewer that contains this Scene.
public	clear() Destroys all Components that are owned by this.
public	destroy() 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	hasSubs(event: String): Boolean 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	aabb: Number[] 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	backfaces: Boolean Sets if backfaces are rendered for this SceneModel.
public set	backfaces: Boolean Sets if backfaces are rendered for this SceneModel.
public get	castsShadow: Boolean Gets if this SceneModel casts a shadow.
public set	castsShadow: Boolean Sets if this SceneModel casts a shadow.
public get	clippable: Boolean Gets if SceneModelEntitys in this SceneModel are clippable.
public set	clippable: Boolean Sets if SceneModelEntitys in this SceneModel are clippable.
public get	collidable: Boolean Gets if this SceneModel is collidable.
public set	collidable: Boolean Sets if SceneModelEntitys in this SceneModel are collidable.
public get	colorTextureEnabled: Boolean Gets if color textures are enabled for this SceneModel.
public get	colorize: Number[] Gets the RGB colorize color for this SceneModel.
public set	colorize: Number[] Sets the RGB colorize color for this SceneModel.
public get	culled: Boolean Gets if this SceneModel is culled from view.
public set	culled: Boolean Sets if this SceneModel is culled from view.
public get	edgeMaterial: EdgeMaterial Configures the appearance of edges of SceneModelEntitys within this SceneModel.
public get	edges: Boolean Gets if any SceneModelEntitys in this SceneModel have edges emphasised.
public set	edges: Boolean Sets if all SceneModelEntitys in this SceneModel have edges emphasised.
public get	entityList: SceneModelEntity[]: * Gets the list of SceneModelEntitys within this SceneModel.
public get	highlightMaterial: EmphasisMaterial Configures the appearance of highlighted SceneModelEntitys within this SceneModel.
public get	highlighted: Boolean Gets if any SceneModelEntitys in this SceneModel are highlighted.
public set	highlighted: Boolean Sets if all SceneModelEntitys in this SceneModel are highlighted.
public get	isDrawable: Boolean Returns true to indicate that SceneModel is implements Drawable.
public get	isEntity: Boolean Returns true to indicate that SceneModel is an Entity.
public get	isModel: Boolean Returns `true` if this SceneModel represents a model.
public get	isObject: Boolean Returns `false` to indicate that SceneModel never represents an object.
public get	isPerformanceModel: Boolean Returns true to indicate that this Component is a SceneModel.
public get	matrix: Number[] 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	matrix: Number[] 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	numLines: Number The approximate number of line primitives in this SceneModel.
public get	numPoints: Number The approximate number of point primitives in this SceneModel.
public get	numTriangles: Number The approximate number of triangle primitives in this SceneModel.
public get	objects: * \| {}: * The SceneModelEntitys in this SceneModel.
public get	opacity: Number Gets this SceneModel's opacity factor. This is a factor in range `[0..1]` which multiplies by the rendered fragment alphas.
public set	opacity: Number Sets the opacity factor for this SceneModel.
public get	origin: Float64Array Gets the 3D World-space origin for this SceneModel.
public get	pbrEnabled: Boolean Gets if physically-based rendering (PBR) is enabled for this SceneModel.
public get	pickable: Boolean Gets if this SceneModel is pickable.
public set	pickable: Boolean Sets if SceneModelEntitys in this SceneModel are pickable.
public get	position: Number[] Gets the SceneModel's local translation. Default value is `[0,0,0]`.
public set	position: Number[] Sets the SceneModel's local translation. Default value is `[0,0,0]`.
public get	quaternion: Number[] Gets the SceneModel's local rotation quaternion. Default value is `[0,0,0,1]`.
public set	quaternion: Number[] Sets the SceneModel's local rotation quaternion. Default value is `[0,0,0,1]`.
public get	receivesShadow: Boolean Sets if this SceneModel can have shadow cast upon it.
public set	receivesShadow: Boolean Sets if this SceneModel can have shadow cast upon it.
public get	rotation: Number[] 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	rotation: Number[] 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	rotationMatrix: Number[] Gets the SceneModel's local modeling rotation transform matrix.
public get	rotationMatrixConjugate: Number[] Gets the conjugate of the SceneModel's local modeling rotation transform matrix. This is used for RTC view matrix management in renderers.
public get	saoEnabled: Boolean Gets if Scalable Ambient Obscurance (SAO) will apply to this SceneModel.
public get	scale: Number[] this get was deprecated. Gets the SceneModel's local scale. Default value is `[1,1,1]`.
public set	scale: Number[] this set was deprecated. Sets the SceneModel's local scale. Default value is `[1,1,1]`.
public get	selected: Boolean Gets if any SceneModelEntitys in this SceneModel are selected.
public set	selected: Boolean Sets if all SceneModelEntitys in this SceneModel are selected.
public get	selectedMaterial: EmphasisMaterial 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	visible: Boolean Gets if any SceneModelEntitys in this SceneModel are visible.
public set	visible: Boolean Sets if this SceneModel is visible.
public get	worldMatrix: Number[] Gets the SceneModel's World matrix.
public get	worldNormalMatrix: Number[] Gets the SceneModel's World normal matrix.
public get	xrayMaterial: EmphasisMaterial Configures the appearance of xrayed SceneModelEntitys within this SceneModel.
public get	xrayed: Boolean Gets if any SceneModelEntitys in this SceneModel are xrayed.
public set	xrayed: Boolean Sets if all SceneModelEntitys in this SceneModel are xrayed.
public	layerList: *[]
public	numEntities: number
public	renderOrder: *
public	createEntity(cfg: Object): SceneModelEntity Creates a SceneModelEntity within this SceneModel.
public	createGeometry(cfg: ): Creates a reusable geometry within this SceneModel.
public	createMesh(cfg: object): SceneModelMesh Creates a new SceneModelMesh within this SceneModel.
public	createQuantizationRange(cfg: *)
public	createTexture(cfg: ): Creates a texture within this SceneModel.
public	createTextureSet(cfg: *): SceneModelTransform Creates a texture set within this SceneModel.
public	createTransform(cfg: *): SceneModelTransform Creates a new SceneModelTransform within this SceneModel.
public	destroy() Destroys this SceneModel.
public	finalize() Finalizes this SceneModel.
public	preFinalize(): boolean Pre-renders all meshes that have been added, even if the SceneModel has not bee finalized yet.

Public Constructors

public constructor(owner: , cfg: ) source

See VBOSceneModel for details.

Override:

SceneModel#constructor

Params:

Name	Type	Attribute	Description
owner	*
cfg	*