Model.hm_highlightmark

Model.hm_highlightmark(collection, highlight, panelSensitive=0)

Control the highlighting of a collection of entities.

Parameters:

• collection (Collection) – The collection containing the input entities to control the highlighting for.

• highlight (hwString) –

  The state of the highlighting. Valid values are:

  l, low or lowlight - set to low (gray) highlighting

  n, norm or normal - set to normal (no) highlighting

  h, high or highlight - set to high (white) highlighting

• panelSensitive (int) – Deprecated. Always set to 0.

Returns:

• hwReturnStatus - Status object

Example

Display elements with ID 10, 11, and 12 in a low state

import hm
import hm.entities as ent

model = hm.Model()

elem_collection = hm.Collection(model, ent.Element, [10, 11, 12])

model.hm_highlightmark(collection=elem_collection, highlight="low")