Decorator Interface
Interface for drawing "decorations" into, or on top of, the active Viewports. Decorators generate Decorations.
Implemented by
Methods
| Name | Description | |
|---|---|---|
| decorate(context: DecorateContext): void | Implement this method to add Decorations into the supplied DecorateContext. | |
| getDecorationGeometry(hit: HitDetail): GeometryStreamProps | undefined Optional | If Decorator.testDecorationHit returned true, implement this method to return the snappable geometry for this Decorator. | |
| getDecorationToolTip(hit: HitDetail): Promise<HTMLElement | string> Optional | If Decorator.testDecorationHit returned true, implement this method to return the tooltip message for this Decorator. | |
| onDecorationButtonEvent(hit: HitDetail, ev: BeButtonEvent): Promise<EventHandled> Optional | If Decorator.testDecorationHit returned true, implement this method to handle a button event for this Decorator. | |
| testDecorationHit(id: string): boolean Optional | If the Decorator.decorate method created pickable graphics, return true if the supplied Id is from this Decorator. |
Defined in
Last Updated: 08 January, 2020