Class View

An independent view within a Viewer, with its own canvas, Camera and object visual states.

See @xeokit/sdk/viewer for usage.

Hierarchy (View Summary)

Properties

boundary camera colorizedObjects destroyed dirty edges gammaOutput highlightedObjects highlightMaterial htmlElement id layers lights lightsList linesMaterial objects opacityObjects pointsMaterial resolutionScale sao sectionPlanes sectionPlanesList selectedMaterial selectedObjects texturing transparent viewer viewId viewIndex visibleObjects xrayedObjects xrayMaterial

Accessors

aabb autoLayers backgroundColor backgroundColorFromAmbientLight colorizedObjectIds gammaFactor highlightedObjectIds numColorizedObjects numHighlightedObjects numObjects numOpacityObjects numSelectedObjects numVisibleObjects numXRayedObjects objectIds opacityObjectIds renderMode selectedObjectIds visibleObjectIds xrayedObjectIds

Methods

beginSnapshot clean cleanIfDirty clearLights clearSectionPlanes createLayer createSectionPlane destroy error fromParams getNumAllocatedSectionPlanes getSnapshot log pick setDirty setObjectsClippable setObjectsCollidable setObjectsColorized setObjectsCulled setObjectsHighlighted setObjectsOpacity setObjectsPickable setObjectsSelected setObjectsVisible setObjectsXRayed toParams warn withObjects

Events

onBoundary onDestroyed onLayerCreated onLayerDestroyed onObjectCreated onObjectDestroyed onObjectVisibility onObjectXRayed onSectionPlaneCreated onSectionPlaneDestroyed onSnapshotFinished onSnapshotStarted

Properties

Readonlyboundary

boundary: number[]

Boundary of the canvas in absolute browser window coordinates. Format is [xmin, ymin, xwidth, ywidth].

Readonlycamera

camera: Camera

Manages the Camera for this View.

ReadonlycolorizedObjects

colorizedObjects: { [key: string]: ViewObject }

Map of currently colorized ViewObjects in this View.

Each ViewObject is mapped here by ViewObject.id.

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

Protecteddirty

dirty: boolean

Readonlyedges

edges: Edges

Configures the appearance of edges belonging to ViewObject in this View.

gammaOutput

gammaOutput: boolean

ReadonlyhighlightedObjects

highlightedObjects: { [key: string]: ViewObject }

Map of currently highlighted ViewObjects in this View.

A ViewObject is highlighted when ViewObject.highlighted is true.

Each ViewObject is mapped here by ViewObject.id.

ReadonlyhighlightMaterial

highlightMaterial: EmphasisMaterial

Configures the highlighted appearance of ViewObjects in this View.

htmlElement

htmlElement: HTMLElement

The HTML canvas.

id

id: string

Unique ID of this Component.

Readonlylayers

layers: { [key: string]: ViewLayer }

Map of the all ViewLayers in this View.

Each ViewLayer is mapped here by ViewLayer.id.

Readonlylights

lights: { [key: string]: AmbientLight | PointLight | DirLight }

Map of light sources in this View.

ReadonlylightsList

lightsList: (AmbientLight | PointLight | DirLight)[] = []

List of light sources in this View.

ReadonlylinesMaterial

linesMaterial: LinesMaterial

Configures the appearance of lines belonging to ViewObjects in this View.

Readonlyobjects

objects: { [key: string]: ViewObject }

Map of the all ViewObjects in this View.

Each ViewObject is mapped here by ViewObject.id.

The View automatically ensures that there is a ViewObject here for each RendererObject in the Viewer

ReadonlyopacityObjects

opacityObjects: { [key: string]: ViewObject }

Map of ViewObjects in this View whose opacity has been updated.

Each ViewObject is mapped here by ViewObject.id.

ReadonlypointsMaterial

pointsMaterial: PointsMaterial

Configures the appearance of point primitives belonging to ViewObjects in this View .

ReadonlyresolutionScale

resolutionScale: ResolutionScale

Configures resolution scaling for this View.

Readonlysao

sao: SAO

Configures Scalable Ambient Obscurance (SAO) for this View.

ReadonlysectionPlanes

sectionPlanes: { [key: string]: SectionPlane }

Map of SectionPlanes in this View.

Each SectionPlane is mapped here by SectionPlane.id.

ReadonlysectionPlanesList

sectionPlanesList: SectionPlane[] = []

List of SectionPlanes in this View.

ReadonlyselectedMaterial

selectedMaterial: EmphasisMaterial

Configures the appearance of ViewObjects in this View.

ReadonlyselectedObjects

selectedObjects: { [key: string]: ViewObject }

Map of currently selected ViewObjects in this View.

A ViewObject is selected when ViewObject.selected is true.

Each ViewObject is mapped here by ViewObject.id.

Readonlytexturing

texturing: Texturing

Configures when textures are rendered for this View.

Readonlytransparent

transparent: boolean

Indicates if this View is transparent.

Readonlyviewer

viewer: Viewer

The Viewer to which this View belongs.

viewId

viewId: string

ID of this View, unique within the Viewer.

InternalviewIndex

viewIndex: number

The index of this View in Viewer.viewList.

ReadonlyvisibleObjects

visibleObjects: { [key: string]: ViewObject }

Map of the currently visible ViewObjects in this View.

A ViewObject is visible when ViewObject.visible is true.

Each ViewObject is mapped here by ViewObject.id.

ReadonlyxrayedObjects

xrayedObjects: { [key: string]: ViewObject }

Map of currently x-rayed ViewObjects in this View.

A ViewObject is x-rayed when ViewObject.xrayed is true.

Each ViewObject is mapped here by ViewObject.id.

ReadonlyxrayMaterial

xrayMaterial: EmphasisMaterial

Configures the X-rayed appearance of ViewObjects in this View.

Accessors

aabb

autoLayers

  • get autoLayers(): boolean

    Gets wether this View will automatically create ViewLayers on-demand as ViewerObjects are created.

    Returns boolean

  • set autoLayers(autoLayers: boolean): void

    Sets wether this View will automatically create ViewLayers on-demand as ViewerObjects are created.

    When true (default), the View will automatically create ViewLayers as needed for each new RendererObject.layerId encountered, including a "default" ViewLayer for ViewerObjects that have no layerId. This "default" ViewLayer ensures that a ViewObject is created in the View for every SceneObject that is created.

    If you set this false, however, then the View will only create ViewObjects for SceneObjects that have a scene!SceneObject.layerId that matches the ID of a ViewLayer that you have explicitly created previously with View.createLayer.

    Setting this parameter false enables Views to contain only the ViewObjects that they actually need to show, i.e. to represent only ViewerObjects that they need to view. This enables a View to avoid wastefully creating and maintaining ViewObjects for ViewerObjects that it never needs to show.

    Default value is `true``.

    Parameters

    • autoLayers: boolean

      The new value for atuoLayers

    Returns void

backgroundColor

backgroundColorFromAmbientLight

  • get backgroundColorFromAmbientLight(): boolean

    Gets whether the canvas clear color will be derived from AmbientLight or View#backgroundColor when View#transparent is true.

    When View#transparent is true and this is true, then the canvas clear color will be taken from the ambient light color.

    When View#transparent is true and this is false, then the canvas clear color will be taken from View#backgroundColor.

    Default value is true.

    Returns boolean

  • set backgroundColorFromAmbientLight(
        backgroundColorFromAmbientLight: boolean,
    ): void

    Sets if the canvas background color is derived from an AmbientLight.

    This only has effect when the canvas is not transparent. When not enabled, the background color will be the canvas element's HTML/CSS background color.

    Default value is true.

    Parameters

    • backgroundColorFromAmbientLight: boolean

    Returns void

colorizedObjectIds

gammaFactor

highlightedObjectIds

numColorizedObjects

numHighlightedObjects

numObjects

numOpacityObjects

numSelectedObjects

numVisibleObjects

numXRayedObjects

objectIds

opacityObjectIds

renderMode

  • get renderMode(): number

    Gets which rendering mode this View is in.

    Default value is QualityRender.

    Returns number

  • set renderMode(renderMode: number): void

    Sets which rendering mode this View is in.

    Default value is QualityRender.

    Setting a View's rendering mode will activate whatever effects (eg. SAO, edges, canas scaling) are configured to be active in that mode, while deactivating all other effects.

    Parameters

    • renderMode: number

    Returns void

selectedObjectIds

visibleObjectIds

xrayedObjectIds

Methods

beginSnapshot

Protectedclean

ProtectedcleanIfDirty

clearLights

clearSectionPlanes

createLayer

createSectionPlane

destroy

Protectederror

  • error(message: string): void
    Protected

    Logs an error for this component to the JavaScript console.

    The console message will have this format: [ERROR] [<component type> =<component id>: <message>

    Parameters

    • message: string

      The error message to log

    Returns void

fromParams

getNumAllocatedSectionPlanes

getSnapshot

Protectedlog

  • log(message: string): void
    Protected

    Logs a message for this component.

    The message will have this format: [LOG] [<component type> <component id>: <message>

    Parameters

    • message: string

      The message to log

    Returns void

pick

ProtectedsetDirty

setObjectsClippable

  • setObjectsClippable(objectIds: string[], clippable: boolean): boolean

    Sets the clippability of the given ViewObjects in this View.

    Parameters

    • objectIds: string[]

      Array of ViewObject.id values.

    • clippable: boolean

      Whether or not to set clippable.

    Returns boolean

    True if any ViewObjects were updated, else false if all updates were redundant and not applied.

setObjectsCollidable

  • setObjectsCollidable(objectIds: string[], collidable: boolean): boolean

    Updates the collidability of the given ViewObjects in this View.

    Updates ViewObject.collidable on the Objects with the given IDs.

    Parameters

    • objectIds: string[]

      Array of ViewObject.id values.

    • collidable: boolean

      Whether or not to cull.

    Returns boolean

    True if any ViewObjects were updated, else false if all updates were redundant and not applied.

setObjectsColorized

setObjectsCulled

  • setObjectsCulled(objectIds: string[], culled: boolean): boolean

    Updates the culled status of the given ViewObjects in this View.

    Updates ViewObject.culled on the Objects with the given IDs.

    Parameters

    • objectIds: string[]

      Array of ViewObject.id values.

    • culled: boolean

      Whether or not to cull.

    Returns boolean

    True if any ViewObjects were updated, else false if all updates were redundant and not applied.

setObjectsHighlighted

setObjectsOpacity

setObjectsPickable

  • setObjectsPickable(objectIds: string[], pickable: boolean): boolean

    Sets the pickability of the given ViewObjects in this View.

    Parameters

    • objectIds: string[]

      Array of ViewObject.id values.

    • pickable: boolean

      Whether or not to set pickable.

    Returns boolean

    True if any ViewObjects were updated, else false if all updates were redundant and not applied.

setObjectsSelected

setObjectsVisible

setObjectsXRayed

toParams

Protectedwarn

  • warn(message: string): void
    Protected

    Logs a warning for this component to the JavaScript console.

    The console message will have this format: [WARN] [<component type> =<component id>: <message>

    Parameters

    • message: string

      The warning message to log

    Returns void

withObjects

  • withObjects(objectIds: string[], callback: Function): boolean

    Iterates with a callback over the given ViewObjects in this View.

    Parameters

    Returns boolean

    True if any ViewObjects were updated, else false if all updates were redundant and not applied.

Events

ReadonlyonBoundary

onBoundary: EventEmitter<View, IntArrayParam>

Emits an event each time the canvas boundary changes.

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.

ReadonlyonLayerCreated

onLayerCreated: EventEmitter<View, ViewLayer>

Emits an event each time a ViewLayer is created in this View.

Layers are created explicitly with View.createLayer, or implicitly with SceneModel.createObject and SceneObjectParams.layerId.

ReadonlyonLayerDestroyed

onLayerDestroyed: EventEmitter<View, ViewLayer>

Emits an event each time a ViewLayer in this View is destroyed.

ViewLayers are destroyed explicitly with ViewLayer.destroy, or implicitly when they become empty and View.autoLayers is false.

ReadonlyonObjectCreated

onObjectCreated: EventEmitter<View, ViewObject>

Emits an event each time a ViewObject is created in this View.

ReadonlyonObjectDestroyed

onObjectDestroyed: EventEmitter<View, ViewObject>

Emits an event each time a ViewObject is destroyed in this View.

ReadonlyonObjectVisibility

onObjectVisibility: EventEmitter<View, ViewObject>

Emits an event each time the visibility of a ViewObject changes in this View.

ViewObjects are shown and hidden with View.setObjectsVisible, ViewLayer.setObjectsVisible or ViewObject.visible.

ReadonlyonObjectXRayed

onObjectXRayed: EventEmitter<View, ViewObject>

Emits an event each time the X-ray state of a ViewObject changes in this View.

ViewObjects are X-rayed with View.setObjectsXRayed, ViewLayer.setObjectsXRayed or ViewObject.xrayed.

ReadonlyonSectionPlaneCreated

onSectionPlaneCreated: EventEmitter<View, SectionPlane>

Emits an event each time a SectionPlane is created in this View.

ReadonlyonSectionPlaneDestroyed

onSectionPlaneDestroyed: EventEmitter<View, SectionPlane>

Emits an event each time a SectionPlane in this View is destroyed.

ReadonlyonSnapshotFinished

onSnapshotFinished: EventEmitter<View, SnapshotFinishedEvent>

Emits an event each time a snapshot is completed with View.getSnapshot.

ReadonlyonSnapshotStarted

onSnapshotStarted: EventEmitter<View, SnapshotStartedEvent>

Emits an event each time a snapshot is initiated with View.getSnapshot.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
Events