RemoteModelHighlightHelper

class cee.ug.RemoteModelHighlightHelper()

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

Constructors

• constructor

Methods

• add

• clearAll

• remove

• setMultiHighlight

• toggle

---

Constructors

constructor

cee.ug.RemoteModelHighlightHelper.constructor(model)

Creates a new highlight helper for the given model.

Arguments

• model (cee.ug.RemoteModel) –

Return type

cee.ug.RemoteModelHighlightHelper

Methods

add

cee.ug.RemoteModelHighlightHelper.add(objectType, objectId, geometryIndex)

Highlights the given object.

Arguments

• objectType (cee.ug.ObjectType) –

• objectId (number) –

• geometryIndex (number) –

Return type

void

clearAll

cee.ug.RemoteModelHighlightHelper.clearAll()

Removes highlighting from all objects.

Return type

void

remove

cee.ug.RemoteModelHighlightHelper.remove(objectType, objectId, geometryIndex)

Removes highlighting from the given object.

Arguments

• objectType (cee.ug.ObjectType) –

• objectId (number) –

• geometryIndex (number) –

Return type

void

setMultiHighlight

cee.ug.RemoteModelHighlightHelper.setMultiHighlight(multiHighlight)

Toggles whether multiple objects can be highlighted simultaneously.

Arguments

• multiHighlight (boolean) –

Return type

void

toggle

cee.ug.RemoteModelHighlightHelper.toggle(objectType, objectId, geometryIndex)

Toggles whether the given object is highlighted.

Arguments

• objectType (cee.ug.ObjectType) –

• objectId (number) –

• geometryIndex (number) –

Return type

void