Class PenShape

Hierarchy

default
- PenShape

Constructors

constructor

new PenShape(): PenShape
Returns PenShape
Inherited from BaseCustomShape.constructor
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:52

Properties

`Protected`_bounds

_bounds: BoundingBox

`Protected`_paint

_paint: Paint

fillColor

fillColor: Color

height

height: number

`Readonly`id

id: string

locked

locked: boolean

opacity

opacity: number

points

points: Point[]

Raw input points

renderPoints

renderPoints: Point[]

Simplified / smoothed points used for rendering

rotation

rotation: number

scaleX

scaleX: number

scaleY

scaleY: number

strokeColor

strokeColor: Color

strokeWidth

strokeWidth: number

visible

visible: boolean

width

width: number

x

x: number

y

y: number

`Protected` `Static` `Readonly`BOUNDS_AFFECTING_PROPS

BOUNDS_AFFECTING_PROPS: Set<string>

Accessors

`Protected`boundsAffectingProps

get boundsAffectingProps(): Set<string>
Returns Set<string>
Inherited from BaseCustomShape.boundsAffectingProps
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:6

paint

get paint(): Paint
Returns Paint
Inherited from BaseCustomShape.paint
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:53

shapeType

get shapeType(): string
The shape type identifier for JSON serialization

Returns string
Overrides BaseCustomShape.shapeType
- Defined in packages/ui-drawingcanvas/shapes/PenShape.d.ts:14

Methods

_draw

_draw(canvas: Canvas): void
Parameters
- canvas: Canvas
Returns void
Overrides BaseCustomShape._draw
- Defined in packages/ui-drawingcanvas/shapes/PenShape.d.ts:23

`Protected`_getRawBounds

_getRawBounds(): { maxX: number; maxY: number; minX: number; minY: number }
Raw bounding box of the stored points (no translation / scaling applied).

Returns { maxX: number; maxY: number; minX: number; minY: number }
Overrides BaseCustomShape._getRawBounds
- Defined in packages/ui-drawingcanvas/shapes/PenShape.d.ts:17

`Protected`_invalidateBounds

_invalidateBounds(): void
Returns void
Inherited from BaseCustomShape._invalidateBounds
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:7

addPoint

addPoint(p: Point): void
Parameters
- p: Point
Returns void
- Defined in packages/ui-drawingcanvas/shapes/PenShape.d.ts:15

`Protected`applyPaint

applyPaint(forFill: boolean): void
Parameters
- forFill: boolean
Returns void
Inherited from BaseCustomShape.applyPaint
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:92

applyResize

applyResize(newX: number, newY: number, newW: number, newH: number): void
For PenShape, "resize" means adjusting scaleX/scaleY (plus x/y offset) so that the rendered bounds match the requested rectangle. The input coordinates come from getBounds() which includes strokeWidth/2 padding, so we strip that padding before computing scale to avoid a "jump" on first move.
Parameters
- newX: number
- newY: number
- newW: number
- newH: number
Returns void
Inherited from BaseCustomShape.applyResize
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:25

applyTranslate

applyTranslate(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from BaseCustomShape.applyTranslate
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:26

draw

draw(canvas: Canvas): void
Draw the shape on the given canvas
Parameters
- canvas: Canvas
Returns void
Inherited from BaseCustomShape.draw
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:18

drawSelectionOverlay

drawSelectionOverlay(
    canvas: Canvas,
    handleSize?: number,
    displayScale?: number,
): void
Draw selection overlay: bounding box + handles, rotated with the shape.
Parameters
- canvas: Canvas
  the canvas to draw on (already inside the shape's canvas transform)
- OptionalhandleSize: number
  handle square size in dp at 1× zoom
- OptionaldisplayScale: number
  the effective display scale (canvasScale × matrix scale). Sizes are divided by this value so that handles appear constant-size on screen regardless of zoom.
Returns void
Inherited from BaseCustomShape.drawSelectionOverlay
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:91

fromJSON

fromJSON(data: ShapeJSON): void
Parameters
- data: ShapeJSON
Returns void
Inherited from BaseCustomShape.fromJSON
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:67

`Protected`fromJSONData

fromJSONData(data: any): void
Restore shape-specific data from JSON
Parameters
- data: any
Returns void
Overrides BaseCustomShape.fromJSONData
- Defined in packages/ui-drawingcanvas/shapes/PenShape.d.ts:25

getBounds

getBounds(): BoundingBox
Return the untransformed bounding box (in local coordinates offset by x,y)

Returns BoundingBox
Inherited from BaseCustomShape.getBounds
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:16

getHandles

getHandles(displayScale: number): HandlePoint[]
Get the 8 resize handles + 1 rotation handle in canvas (world) coordinates, accounting for rotation
Parameters
- displayScale: number
Returns HandlePoint[]
Inherited from BaseCustomShape.getHandles
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:81

getTransformedBounds

getTransformedBounds(displayScale: number): BoundingBox
Get bounding box in canvas space (accounting for position, scale and rotation is simplified as AABB)
Parameters
- displayScale: number
Returns BoundingBox
Inherited from BaseCustomShape.getTransformedBounds
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:83

hitTest

hitTest(px: number, py: number): boolean
Hit-test a point (in canvas coordinates) against the shape
Parameters
- px: number
- py: number
Returns boolean
Inherited from BaseCustomShape.hitTest
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:17

notifyPropertyChange

notifyPropertyChange(propertyName: string, value: any, oldValue?: any): void
Parameters
- propertyName: string
- value: any
- OptionaloldValue: any
Returns void
Inherited from BaseCustomShape.notifyPropertyChange
- Defined in packages/ui-drawingcanvas/shapes/BaseCustomShape.d.ts:27

toJSON

toJSON(): ShapeJSON
Returns ShapeJSON
Inherited from BaseCustomShape.toJSON
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:66

`Protected`toJSONData

toJSONData(): Record<string, any>
Shape-specific extra JSON data

Returns Record<string, any>
Overrides BaseCustomShape.toJSONData
- Defined in packages/ui-drawingcanvas/shapes/PenShape.d.ts:24

`Static`rotatePoint

rotatePoint(
    px: number,
    py: number,
    cx: number,
    cy: number,
    angleDegrees: number,
): { x: number; y: number }
Rotate a point around a center by angleDegrees, returning the new world position
Parameters
- px: number
- py: number
- cx: number
- cy: number
- angleDegrees: number
Returns { x: number; y: number }
Inherited from BaseCustomShape.rotatePoint
- Defined in packages/ui-drawingcanvas/shapes/DrawableShape.d.ts:76