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.

None

Constructors

cee.usg.ElementHighlighter.constructor()
ElementHighlighter(usgModel: UnstructGridModel, markupModel: MarkupModel): ElementHighlighter

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.

Parameters

usgModel: UnstructGridModel

markupModel: MarkupModel

Returns: ElementHighlighter

Methods

cee.usg.ElementHighlighter.addElementHighlight()
addElementHighlight(surfaceColor: Color3, state: State, partIndex: number, elementIndex: number): boolean

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

Parameters

surfaceColor: Color3

state: State

partIndex: number

elementIndex: number

Returns: boolean

addElementHighlight(surfaceColor: Color3, hitItem: HitItem): boolean

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

Parameters

surfaceColor: Color3

hitItem: HitItem

Returns: boolean

cee.usg.ElementHighlighter.addElementLabel()
addElementLabel(state: State, partIndex: number, elementIndex: number, label: string): boolean

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

Parameters

state: State

partIndex: number

elementIndex: number

label: string

Returns: boolean

addElementLabel(hitItem: HitItem): boolean

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

Parameters

hitItem: HitItem

Returns: boolean