geSetHilightSetHaloParameters

geSetHilightSetHaloParameters(
h_hlSetId
g_haloPosition
g_haloType
g_haloThickNess
g_haloTransparency
[ g_drawStroke ]
)
=> t / nil

Description

Sets the halos parameters on the given highlight set in order to draw the set with halos.

Haloing objects on the screen is expensive and should not be performed on a large set of objects due to the computational and graphics system overhead. The geSetHilightSetHaloParameters and geSetHilightSetAlphaBlendingParameters functions provide a mechanism to halo objects on the screen and are intended for use by internal Cadence applications. They should be used sparingly. Do not halo a large number of objects on the screen as there will be a negative impact on performance.

Arguments

h_hlSetId	The database ID of the highlight set.
g_haloPosition	The position of the halo. Valid values: `over`, `under`
g_haloType	The halo type. Valid values: `none`, `plain`, `glow`, `fadeout`, `random`
g_haloThickNess	The halo thickness. Valid values: `normal`, `thin`, `thick`
g_haloTransparency	The transparency value. Valid values: `[0 100]`
g_drawStroke	Optional argument. The `drawStroke` parameter controls the visibility of the highlight shapes when they have a halo. Valid values: `t` or `nil`

Value Returned

`t`	Parameters of the halo are successfully set.
`nil`	The parameters are not set.

Examples

geSetHilightSetHaloParameters(hlsetId "under" "glow" "normal" 50 nil )

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