Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

geAddHilightFig

geAddHilightFig( 
g_hlSetId 
d_figId 
[ g_drawAll ] 
[ l_hierPath ]
[ l_vertex ]
)
=> g_hlObjectId / nil 

Description

Adds a figure to a highlight set.

If g_drawAll is t, and the figure is an instance, all figures in the master of the instance are drawn.

Arguments

g_hlSetId

Database ID of the highlight set.

d_figId

Database ID of the figure added to the highlight set.

g_drawAll

Specifies whether all figures in the instance are drawn.
Valid Values: t, nil

l_hierPath

Specifies the hierarchal path of a figure. This option is used to highlight figures located inside the hierarchy. The format used for this option is a list of list (dbInst memInst row column).

l_vertex

Specifies the Boolean list of vertices of the figure to highlight. This option can be used to partially highlight a figure.

Value Returned

g_hlObjectId

The figure is added to the set.

nil

The figure is not added to the set.

Examples

The following example adds fig3 to the highlight set set1 and does not draw the objects. Returns the object ID of fig3.

geAddHilightFig( set1 fig3 nil )

The following example adds instId to the highlight set set1 and highlights the objects inside instId.

geAddHilightFig(set1 instId t)

The following example adds figId to the highlight set set1, located in the hierarchy at the given hierpath, inst1/inst2.

geAddHilightFig(set1 figId nil list(list(inst1 0 0 0) list(inst2 0 0 0)))

The following example adds rect to the highlight set set1, but only highlights vertices 2 and 3.

geAddHilightFig(set1 rect nil nil list(nil t t nil))

Related Topics

Highlight Functions


Return to top
 ⠀
X