Classes

Classes

Annotation
AudioPlayer
BoundingBox
Camera
Canvas
Color
Colormap
ColormapLegend
Controller
Controller2D
ControllerFocusContext
ControllerLens
ControllerPanZoom
CoordinateSystem
Draggable
EditorSvgAnnotation
FocusContext
Layer
LayerAnnotation
LayerAnnotationImage
LayerBRDF
LayerCombiner
LayerDstretch
LayerImage
LayerLens
LayerMaskedImage
LayerNeuralRTI
LayerRTI
LayerSvgAnnotation
Layout
LayoutTileImages
LayoutTiles
LensDashboard
LensDashboardNavigator
LensDashboardNavigatorRadial
LightSphereController
PointerManager
Raster
Ruler
ScaleBar
Shader
ShaderBRDF
ShaderCombiner
ShaderDstretch
ShaderFilter
ShaderFilterColormap
ShaderFilterOpacity
ShaderFilterTest
ShaderFilterVector
ShaderFilterVectorGlyph
ShaderGammaFilter
ShaderLens
ShaderNeural
ShaderRTI
Skin
TextToSpeechPlayer
Tile
Transform
UIBasic
UIDialog
Units
Util
Viewer

Namespaces

Cache

Events


update

The event is fired when the camera target is changed.

Source:

update

The event is fired when a uniform shader variable is changed.

Source:

ready

Fired when all layers are initialized and ready to display.

Source:

update

Fired when canvas content is updated (layer changes, camera moves).

Source:

updateSize

Fired when canvas or layout size changes.

Source:

ready

The event is fired when a layer is initialized.

Source:

update

The event is fired if a redraw is needed.

Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layer is initialized.

Inherited From:
Overrides:
Source:

update

The event is fired if a redraw is needed.

Inherited From:
Overrides:
Source:

ready

The event is fired when a layout is ready to be drawn(the single-resolution image is downloaded or the multi-resolution structure has been initialized).

Source:

ready

The event is fired when a layout is ready to be drawn(the single-resolution image is downloaded or the multi-resolution structure has been initialized).

Source:

updateSize

The event is fired when a layout size is modified (and the scene extension must be recomputed at canvas level).

Source:

Layout#ready Fired when the layout is ready for rendering. This occurs when: - Single-resolution image is fully downloaded - Multi-resolution structure is initialized and validated - Tile pyramid information is computed

Source:

Layout#ready Fired when the layout is ready for rendering. This occurs when: - Tile descriptors are loaded from annotation file - Tile descriptors are set programmatically

Source:

Layout#updateSize Fired when the layout size changes and scene extension needs updating. This occurs when: - Image dimensions are determined - Pyramid levels are initialized - Bounding boxes are computed

Source:

Layout#updateSize Fired when the layout size changes and scene extension needs updating. This occurs when: - Tile descriptors are loaded and bounding box is computed

Source:

ready

The event is fired when a layout is ready to be drawn(the single-resolution image is downloaded or the multi-resolution structure has been initialized).

Inherited From:
Overrides:
Source:

updateSize

The event is fired when a layout size is modified (and the scene extension must be recomputed at canvas level).

Inherited From:
Overrides:
Source:

ready

The event is fired when a layout is ready to be drawn(the single-resolution image is downloaded or the multi-resolution structure has been initialized).

Inherited From:
Overrides:
Source:

updateSize

The event is fired when a layout size is modified (and the scene extension must be recomputed at canvas level).

Inherited From:
Overrides:
Source:

update

Fired when shader state changes (uniforms, filters, etc).

Source:

update

Fired when shader state changes (uniforms, filters, etc).

Inherited From:
Overrides:
Source:

update

Fired when shader combination mode changes.

Type: Object
Properties:
Name Type Description
mode string

New combination mode

previousMode string

Previous combination mode

Overrides:
Source:

update

Fired when shader state changes (uniforms, filters, etc).

Inherited From:
Overrides:
Source:

update

Fired when shader state changes (uniforms, filters, etc).

Inherited From:
Overrides:
Source:

update

Fired when shader state changes (uniforms, filters, etc).

Inherited From:
Overrides:
Source:

update

Fired when shader state changes (uniforms, filters, etc).

Inherited From:
Overrides:
Source:

UIDialog#closed Emitted when dialog is closed through any means

Event Definitions

Light Direction Change Event:

Type: Object
Properties:
Name Type Description
direction Array.<number>

[x, y, z] normalized light vector

Dialog Close Event:

Source:

closed

The event is fired when the dialog is closed.

Source:

draw

Fired when frame is drawn

Source:

resize

Fired when viewer is resized

Properties:
Name Type Description
viewport Viewport

New viewport configuration

Source: