ElementHighlighter

class cee.usg.ElementHighlighter()

Helper class for highlighting elements

The class makes it easy to highlight an element by adding a tessellation of the element to a markup model, as well as creating a label with the element id/index.

Constructors

constructor

Methods

addElementHighlight
addElementLabel

Constructors

ElementHighlighter.constructor(usgModel, markupModel)

Arguments:

usgModel (UnstructGridModel) – None
markupModel (MarkupModel) – None

Setup the object with the unstruct grid model with the FEA model, and the Markup Model which will receive the highlight parts constructed from the usgModel.

Return type:: ElementHighlighter

Methods

addElementHighlight

ElementHighlighter.addElementHighlight(surfaceColor, state, partIndex, elementIndex)

Arguments:

surfaceColor (Color3) – None
state (State) – None
partIndex (number) – None
elementIndex (number) – None

Add a part with the tessellation of the given element as a surface with the given color. The part will use eye lift to not interfere with the usg model.

See example image above for how it will look

Return type:: boolean

ElementHighlighter.addElementHighlight(surfaceColor, hitItem)

Arguments:

surfaceColor (Color3) – None
hitItem (HitItem) – None

Return type:

boolean

addElementLabel

ElementHighlighter.addElementLabel(state, partIndex, elementIndex, label)

Arguments:

state (State) – None
partIndex (number) – None
elementIndex (number) – None
label (string) – None

Add an element label based on either a hit item or specified by state, part and element index.

See example image above for how it will look

Return type:: boolean

ElementHighlighter.addElementLabel(hitItem)

Arguments:

hitItem (HitItem) – None

Return type:

boolean