HighlightHelper

class cee.ug.HighlightHelper()

Helper class for highlighting objects in a RemoteModel based on picking information.

Index

Constructors

• constructor

Methods

• add
• clearAll
• remove
• setMultiHighlight
• toggle

Constructors

cee.ug.HighlightHelper.constructor()

HighlightHelper(model: RemoteModel): HighlightHelper

Creates a new highlight helper for the given model.

Parameters

model: RemoteModel

Returns: HighlightHelper

Methods

cee.ug.HighlightHelper.add()

add(objectType: ObjectType, objectId: number, geometryIndex: number): void

Highlights the given object.

Parameters

objectType: ObjectType

objectId: number

geometryIndex: number

Returns: void

cee.ug.HighlightHelper.clearAll()

clearAll(): void

Removes highlighting from all objects.

Returns: void

cee.ug.HighlightHelper.remove()

remove(objectType: ObjectType, objectId: number, geometryIndex: number): void

Removes highlighting from the given object.

Parameters

objectType: ObjectType

objectId: number

geometryIndex: number

Returns: void

cee.ug.HighlightHelper.setMultiHighlight()

setMultiHighlight(multiHighlight: boolean): void

Toggles whether multiple objects can be highlighted simultaneously.

Parameters

multiHighlight: boolean

Returns: void

cee.ug.HighlightHelper.toggle()

toggle(objectType: ObjectType, objectId: number, geometryIndex: number): void

Toggles whether the given object is highlighted.

Parameters

objectType: ObjectType

objectId: number

geometryIndex: number

Returns: void