Overlay

class cee.Overlay()

Manages 2d overlay items in a View.

Overlay items are 2d items drawn in the view together with the 3d model, for example color legends, navigation cube, step text and info box.

You can access the overlay object with the View.overlay property.

Accessors

cee.Overlay.autoAppendModelInfoToInfoBox()
get autoAppendModelInfoToInfoBox(): boolean

Whether information from the models should be appended to the info box

Returns: boolean

set autoAppendModelInfoToInfoBox(enable: boolean): void

Parameters

enable: boolean

Returns: void

cee.Overlay.infoBoxPosition()
get infoBoxPosition(): OverlayItemPosition

The position of the info box.

Returns: OverlayItemPosition

set infoBoxPosition(position: OverlayItemPosition): void

Parameters

Returns: void

cee.Overlay.infoBoxVisible()
get infoBoxVisible(): boolean

The visibility of the info box (the blue box in the bottom right corner) in the view

Returns: boolean

set infoBoxVisible(show: boolean): void

Parameters

show: boolean

Returns: void

cee.Overlay.legendsPosition()
get legendsPosition(): OverlayItemPosition

The position of the legends.

Returns: OverlayItemPosition

set legendsPosition(position: OverlayItemPosition): void

Parameters

Returns: void

cee.Overlay.maximumLegendHeight()
get maximumLegendHeight(): number

The maximum height of the legends (color legends and category legends).

Legends are sized to fit the view, depending on the view height and the number of legends. This property controls the maximum height a legend can have.

The value of this property is in device pixels, so it’s multiplied by the display’s pixelScaleFactor to give the native (full resolution) pixel height.

Returns: number

set maximumLegendHeight(height: number): void

Parameters

height: number

Returns: void

cee.Overlay.modelColorLegendsVisible()
get modelColorLegendsVisible(): boolean

The visibility of the color legend overlay items for models (currently only for RemoteModel).

Returns: boolean

set modelColorLegendsVisible(show: boolean): void

Parameters

show: boolean

Returns: void

cee.Overlay.navigationCubeHomeDirection()
get navigationCubeHomeDirection(): Vec3

The view direction to set when the “Home” button on the navigation cube is pressed

Returns: Vec3

set navigationCubeHomeDirection(direction: Vec3): void

Parameters

direction: Vec3

Returns: void

cee.Overlay.navigationCubeHomeEye()
get navigationCubeHomeEye(): Vec3

The view eye position to set when the “Home” button on the navigation cube is pressed If undefined then eye position is set automatically to fit view

Returns: Vec3

set navigationCubeHomeEye(eye: Vec3): void

Parameters

eye: Vec3

Returns: void

cee.Overlay.navigationCubeHomeUp()
get navigationCubeHomeUp(): Vec3

The up direction to set when the “Home” button on the navigation cube is pressed

Returns: Vec3

set navigationCubeHomeUp(up: Vec3): void

Parameters

up: Vec3

Returns: void

cee.Overlay.navigationCubePosition()
get navigationCubePosition(): OverlayItemPosition

The position of the navigation cube.

Returns: OverlayItemPosition

set navigationCubePosition(position: OverlayItemPosition): void

Parameters

Returns: void

cee.Overlay.navigationCubeVisible()
get navigationCubeVisible(): boolean

The visibility of the navigation cube in the view

Returns: boolean

set navigationCubeVisible(show: boolean): void

Parameters

show: boolean

Returns: void

cee.Overlay.stepTextVisible()
get stepTextVisible(): boolean

The visibility of the step text (the text at the bottom of the view displaying the current step for RemoteModels)

Returns: boolean

set stepTextVisible(show: boolean): void

Parameters

show: boolean

Returns: void

Methods

cee.Overlay.addCustomCategoryLegend()
addCustomCategoryLegend(categories: string[], colors: ArrayLike, legendTitle: string, resultId: number): void

Adds a category legend to the view.

The category legend shows each color with its corresponding descriptive text.

Note that the categories and colors arrays must have the same length.

Legends can be removed with the removeAllCustomLegends method.

Parameters

categories: string[]

colors: ArrayLike

legendTitle: string

resultId: number

Returns: void

cee.Overlay.addCustomColorLegend()
addCustomColorLegend(legend: OverlayColorLegendContinuousDomain): void

Adds a color legend displaying the settings of the given scalar mapper.

Legends can be removed with the removeAllCustomLegends method.

Parameters

Returns: void

cee.Overlay.addCustomColorLegendForScalarMapper()
addCustomColorLegendForScalarMapper(scalarMapper: ScalarMapperContinuousDomain, legendTitle: string, resultId: number): void

Adds a color legend displaying the settings of the given scalar mapper.

Legends can be removed with the removeAllCustomLegends method.

The resultId parameter is an optional user defined id identifying the scalar mapper. This id will be passed to the legend picked handler when the user clicks on the color legend. See Viewer.setColorLegendClickHandler and ColorLegendClickedHandler for more information.

Parameters

scalarMapper: ScalarMapperContinuousDomain

legendTitle: string

resultId: number

Returns: void

cee.Overlay.configureNavigationCube()
configureNavigationCube(faceNames: string[], faceColors: Color3Like[], axisLabels: string[]): void

Configure the navigation cube

  • faceNames: Must contain 6 values, names for: Pos_X, Neg_X, Pos_Y, Neg_Y, Pos_Z, Neg_Z
  • faceColors: null or 6 values, colors for: Pos_X, Neg_X, Pos_Y, Neg_Y, Pos_Z, Neg_Z axisLabels: null (defaults to x,y,z) or 3 values, names for X_AXIS, Y_AXIS, Z_AXIS

Parameters

faceNames: string[]

faceColors: Color3Like[]

axisLabels: string[]

Returns: void

cee.Overlay.removeAllCustomLegends()
removeAllCustomLegends(): void

Removes all custom legends from the view.

This method will remove all legends added with the addCustomColorLegendForScalarMapper and addCustomCategoryLegend methods.

Returns: void

cee.Overlay.setInfoBoxAppearance()
setInfoBoxAppearance(backgroundColor: Color4Like, textColor: Color3Like, borderColor: Color3Like): void

Sets the appearance of the info box.

Parameters

backgroundColor: Color4Like

textColor: Color3Like

borderColor: Color3Like

Returns: void

cee.Overlay.setInfoBoxContent()
setInfoBoxContent(content: string): void

Sets the text to show in the info box.

Note that any information from the models will be appended to the given string unless autoAppendModelInfoToInfoBox is set to false.

Parameters

content: string

Returns: void

cee.Overlay.setStepTextContent()
setStepTextContent(content: string): void

Sets the text to show in as the step info.

This will remove any automatic step info from the Remote Model.

Parameters

content: string

Returns: void

cee.Overlay.viewConfigurationFromNavigationCubeItem()
viewConfigurationFromNavigationCubeItem(item: NavigationCubeItem): NavigationCubeViewConfiguration

Get the view direction and up vector based on the navigation cube item

Parameters

Returns: NavigationCubeViewConfiguration