Class SelectionHighlightRenderer

Handles rendering of the selection highlights for SceneObjects.

Hierarchy

FrameworkObject
- SelectionHighlightRenderer

Index

Constructors

Accessors

isManualModeEnabled settings

Methods

addManual clearManual destroy update

Constructors

constructor

new SelectionHighlightRenderer(camera, isInternalConstructor?): SelectionHighlightRenderer
Parameters
- camera: Camera
- OptionalisInternalConstructor: boolean
Returns SelectionHighlightRenderer
Overrides FrameworkObject.constructor

Accessors

isManualModeEnabled

get isManualModeEnabled(): boolean
Enable the manual selection for renderable objects.

Returns boolean
set isManualModeEnabled(value): void
Parameters
- value: boolean
Returns void

settings

get settings(): Immutable<SelectionHighlightRendererSettings>
Sets the renderer settings.

Returns Immutable<SelectionHighlightRendererSettings>
set settings(value): void
Parameters
- value: Immutable<SelectionHighlightRendererSettings>
Returns void

Methods

addManual

addManual(sceneObject, color, drawOperationType?): any
Adds a manual sceneObject to the render list. All renderables in the mesh will be selected for rendering.
Parameters
- sceneObject: SceneObject
- color: Immutable<SRGBColor>
  The optional tint color.
- OptionaldrawOperationType: EnumValue<MeshTopology, number>
  The draw operation type.
Returns any
Note
Must be called before the next call to update.
addManual(renderable, lodIndex, indexOffset, indexCount, color, drawOperationType?): any
Adds a manual renderable to the list that renders a sub section of the mesh at the specified lodIndex.
Parameters
- renderable: Renderable
  The renderable.
- lodIndex: number
  The LOD group index
- indexOffset: number
  The offset in the mesh index buffer.
- indexCount: number
  The number of indices to render.
- color: Immutable<SRGBColor>
  The optional tint color.
- OptionaldrawOperationType: EnumValue<MeshTopology, number>
  The draw operation type.
Returns any
Note
Must be called before the next call to update.

clearManual

clearManual(): void
Clears the list of manually selected elements.

Returns void

destroy

destroy(): void
Destroy the renderer and unregister it from other subsystems.

Returns void

update

update(sceneInstance, selectedObjects): void
Update the render data if needed and submit the render job to the core thread.
Parameters
- sceneInstance: SceneInstance
- selectedObjects: SceneObject[]
Returns void