Hilite.Settings Class
Describes how the hilite effect is applied to elements within a Viewport. The hilite effect is applied to elements contained in the IModelConnection's SelectionSet. It is designed to draw attention to those elements. The effect is produced as follows:
- All hilited elements are drawn as normal, except that their element color is mixed with the hilite color.
- The union of the regions of the screen corresponding to hilited elements is computed.
- A silhouette is drawn using the hilite color around the boundaries of the hilited region. This silhouette is visible behind other geometry.
- The hilite color is mixed with the color of each pixel within the hilited region. This enables surfaces of hilited geometry to be visible behind other geometry.
The Settings allow an application to customize how this effect is applied.
@see Viewport.hilite
Methods
| Name | Description | |
|---|---|---|
| constructor(color: ColorDef..., visibleRatio: number0.25, hiddenRatio: number0.0, silhouette: Hilite.SilhouetteSilhouette.Thin): Hilite.Settings |
Properties
| Name | Type | Description | |
|---|---|---|---|
| color Readonly | ColorDef | The color that is used to draw the outline and which is mixed with element color. | |
| hiddenRatio Readonly | number | The ratio of hilite color to screen color used when drawing the hilited region overtop of the screen contents, in the range [0, 1]. | |
| silhouette | Hilite.Silhouette | The type of outline to be drawn around the boundaries of the hilited region. | |
| visibleRatio Readonly | number | The ratio of hilite color to element color used when drawing unobscured portions of hilited geometry, in the range [0, 1]. |
Defined in
- core/common/src/Hilite.ts Line 39
Last Updated: 28 October, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.