Class SilhouetteHighlight

An implementation for highlighting 3D objects in Cesium.

Supported Object Types:

Entity with model graphics. (adjustable outline width)
Cesium3DTileset instances. (fixed outline width)

Currently supports outline style only.

Example

const viewer = new Viewer("cesiumContainer");
const silhouetteHighlight = new SilhouetteHighlight(viewer);

// Highlight an object
const entity = viewer.entities.add(new Entity({
  model: new ModelGraphics(),
}));
silhouetteHighlight.show(entity);

Implements

Highlight.Base

Index

Constructors

constructor

new SilhouetteHighlight(viewer: Viewer): SilhouetteHighlight
Creates a new Silhouette instance.
Parameters
- viewer: Viewer
  A viewer to create highlight silhouette in
Returns SilhouetteHighlight
- Defined in highlight/silhouette-highlight.ts:53

Properties

`Private`_color

_color: Color = Color.RED

`Private`_composite

_composite: PostProcessStageComposite

`Private`_currentObject

_currentObject: Entity | Cesium3DTileFeature | undefined

`Private`_currentOptions

_currentOptions: Highlight.Options | undefined

`Private` `Optional`_entity

_entity?: Entity

`Private`_silhouette

_silhouette: PostProcessStage

`Private`_stages

_stages: PostProcessStageCollection

Accessors

color

get color(): Color
Gets the highlight color.

Returns Color
Implementation of Base.color
- Defined in highlight/silhouette-highlight.ts:67
set color(color: Color): void
Sets the highlight color.
Parameters
- color: Color
Returns void
Implementation of Base.color
- Defined in highlight/silhouette-highlight.ts:72

currentObject

get currentObject(): Entity | Cesium3DTileFeature | undefined
Gets the currently highlighted object

Returns Entity | Cesium3DTileFeature | undefined
- Defined in highlight/silhouette-highlight.ts:77

Methods

`Private`_clearHighlights

_clearHighlights(): void
Private
Clears all current highlights

Returns void
- Defined in highlight/silhouette-highlight.ts:176

`Private`_optionsEqual

_optionsEqual(
options1: Highlight.Options | undefined,
options2: Highlight.Options | undefined,
): boolean
Private
Compares two Highlight.Options objects for equality
Parameters
- options1: Highlight.Options | undefined
- options2: Highlight.Options | undefined
Returns boolean
- Defined in highlight/silhouette-highlight.ts:154

destroy

destroy(): void
Clean up the instances

Returns void
Implementation of Base.destroy
- Defined in highlight/silhouette-highlight.ts:141

hide

hide(): void
Clears the current highlight

Returns void
Implementation of Base.hide
- Defined in highlight/silhouette-highlight.ts:132

show

show(object: Cesium3DTileFeature, options?: Highlight.Options): void
Highlights a picked Cesium3DTileset by updating silhouette composite.
Parameters
- object: Cesium3DTileFeature
  The object to be highlighted.
- Optionaloptions: Highlight.Options
  Optional style for the highlight.
Returns void
Implementation of Base.show
- Defined in highlight/silhouette-highlight.ts:86
show(object: Entity, options?: Highlight.Options): void
Highlights a picked Entity by updating the model properties.
Parameters
- object: Entity
  The object to be highlighted.
- Optionaloptions: Highlight.Options
  Optional style for the highlight.
Returns void
Implementation of Highlight.Base.show
- Defined in highlight/silhouette-highlight.ts:92

Class SilhouetteHighlight

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SilhouetteHighlight

Properties

Private_color

Private_composite

Private_currentObject

Private_currentOptions

Private Optional_entity

Private_silhouette

Private_stages

Accessors

color

Returns Color

Parameters

Returns void

currentObject

Returns Entity | Cesium3DTileFeature | undefined

Methods

Private_clearHighlights

Returns void

Private_optionsEqual

Parameters

Returns boolean

destroy

Returns void

hide

Returns void

show

Parameters

Returns void

Parameters

Returns void

Settings

On This Page

`Private`_color

`Private`_composite

`Private`_currentObject

`Private`_currentOptions

`Private` `Optional`_entity

`Private`_silhouette

`Private`_stages

`Private`_clearHighlights

`Private`_optionsEqual