Group2d • tldraw SDK

Table of contents

Properties
- children
- ignoredChildren
Methods

Public class

Signature

class Group2d extends Geometry2d {}

References

Geometry2d

Source

packages/editor/src/lib/primitives/geometry/Group2d.ts

Constructor

Public constructor

Constructs a new instance of the Group2d class

Parameters

Name	Description
`config`	`Omit< Geometry2dOptions, 'isClosed' \| 'isFilled' > & { children: Geometry2d[] }`

References

Geometry2d

Properties

`children`

Public property

Signature

children: Geometry2d[]

References

Geometry2d

`ignoredChildren`

Public property

Signature

ignoredChildren: Geometry2d[]

References

Geometry2d

Methods

`distanceToPoint()`

Public method

Signature

distanceToPoint(point: Vec, hitInside?: boolean): number

Parameters

Name	Description
`point`	`Vec`
`hitInside`	`boolean`

Returns

number

References

Vec

`getArea()`

Public method

Signature

getArea(): number

`getVertices()`

Public method

Signature

getVertices(): Vec[]

References

Vec

`hitTestLineSegment()`

Public method

Signature

hitTestLineSegment(A: Vec, B: Vec, zoom: number): boolean

Parameters

Name	Description
`A`	`Vec`
`B`	`Vec`
`zoom`	`number`

Returns

boolean

References

Vec

`hitTestPoint()`

Public method

Signature

hitTestPoint(point: Vec, margin: number, hitInside: boolean): boolean

Parameters

Name	Description
`point`	`Vec`
`margin`	`number`
`hitInside`	`boolean`

Returns

boolean

References

Vec

`nearestPoint()`

Public method

Signature

nearestPoint(point: Vec): Vec

Parameters

Name	Description
`point`	`Vec`

Returns

Vec

References

Vec

`toSimpleSvgPath()`

Public method

Signature

toSimpleSvgPath(): string

GRID_STEPS GroupShapeUtil