HighlightHelper

class cee.ug.HighlightHelper()

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

Constructors

• constructor

Methods

• add
• clearAll
• remove
• setMultiHighlight
• toggle

---

Constructors

HighlightHelper.constructor(model)

Arguments:

• model (RemoteModel) – None

Creates a new highlight helper for the given model.

Return type:HighlightHelper

Methods

add

HighlightHelper.add(objectType, objectId, geometryIndex)

Arguments:

• objectType (ObjectType) – None
• objectId (number) – None
• geometryIndex (number) – None

Highlights the given object.

Return type:void

clearAll

HighlightHelper.clearAll()

Removes highlighting from all objects.

Return type:void

remove

HighlightHelper.remove(objectType, objectId, geometryIndex)

Arguments:

• objectType (ObjectType) – None
• objectId (number) – None
• geometryIndex (number) – None

Removes highlighting from the given object.

Return type:void

setMultiHighlight

HighlightHelper.setMultiHighlight(multiHighlight)

Arguments:

• multiHighlight (boolean) – None

Toggles whether multiple objects can be highlighted simultaneously.

Return type:void

toggle

HighlightHelper.toggle(objectType, objectId, geometryIndex)

Arguments:

• objectType (ObjectType) – None
• objectId (number) – None
• geometryIndex (number) – None

Toggles whether the given object is highlighted.

Return type:void