BrushOverlayUtil

Extends OverlayUtil<TLBrushOverlay>.

Overlay util for the selection brush rectangle.

class BrushOverlayUtil extends OverlayUtil<TLBrushOverlay> {}

Constructs a new instance of the OverlayUtil class

Parameters

Editor;

Properties

static type: string;

editor: Editor;

options: BrushOverlayUtilOptions;

Methods

Create a new overlay util class with the given options merged in.

static configure<T extends TLOverlayUtilConstructor<any>>(
  this: T,
  options: T extends new (...args: any[]) => {
    options: infer Options;
  }
    ? Partial<Options>
    : never,
): T;

Example

const MyBrush = BrushOverlayUtil.configure({ fill: "rgba(0,0,255,0.1)" });

Parameters

T;

T extends new (...args: any[]) => {
  options: infer Options;
}
  ? Partial<Options>
  : never;

Returns

T;

Returns the cursor type to show when hovering this overlay.

getCursor(_overlay: T): TLCursorType | undefined;

Parameters

T;

Returns

TLCursorType | undefined;

Returns hit-test geometry for an overlay instance, in page coordinates. Return null for non-interactive overlays (e.g. snap indicators, scribbles).

getGeometry(_overlay: T): Geometry2d | null;

Parameters

T;

Returns

Geometry2d | null;

getOverlays(): TLBrushOverlay[];

isActive(): boolean;

Called when the user points down on this overlay, before the default routing runs. Acts as an interrupt: define it to take over the event.

Return false to continue with the default behavior (e.g. the built-in rotate/resize handle transitions or shape-handle dispatch). Return true — or nothing at all — to skip the default. In other words, once you override this method you own the event unless you explicitly opt back in by returning false.

onPointerDown?(overlay: T, info: TLPointerEventInfo): boolean | void;

Parameters

T;

TLPointerEventInfo;

Returns

boolean | void;

render(ctx: CanvasRenderingContext2D, overlays: TLBrushOverlay[]): void;

Parameters

CanvasRenderingContext2D;

TLBrushOverlay[];

Returns

void;

renderMinimap(
  ctx: CanvasRenderingContext2D,
  overlays: TLBrushOverlay[],
  zoom: number,
): void;

Parameters

CanvasRenderingContext2D;

TLBrushOverlay[];

number;

Returns

void;