Class ZRectangle

Represents a helper object that can run calculations on a numeric quadrilateral.

Index

Constructors

constructor

new ZRectangle(sides: IZQuadrilateral): ZRectangle
Initializes a new instance of this object.
Parameters
- sides: IZQuadrilateral
  The numeric sides of a quadrilateral.
Returns ZRectangle
- Defined in packages/helpful-fn/src/geometry/rectangle.mts:17

Properties

bottomCenter

bottomCenter: (...args: []) => IZPoint2d = ...

Calculates the bottom center point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The bottom center point of the rectangle.

bottomLeft

bottomLeft: (...args: []) => IZPoint2d = ...

Calculates the bottom left point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The bottom left point of the rectangle.

bottomRight

bottomRight: (...args: []) => IZPoint2d = ...

Calculates the bottom right point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The bottom right point of the rectangle.

middleCenter

middleCenter: (...args: []) => IZPoint2d = ...

Calculates the middle center point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The middle center point of the rectangle.

middleLeft

middleLeft: (...args: []) => IZPoint2d = ...

Calculates the middle left point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The middle left point of the rectangle.

middleRight

middleRight: (...args: []) => IZPoint2d = ...

Calculates the middle right point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The middle right point of the rectangle.

`Readonly`sides

sides: IZQuadrilateral

The numeric sides of a quadrilateral.

topCenter

topCenter: (...args: []) => IZPoint2d = ...

Calculates the top center point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The top center point of the rectangle.

topLeft

topLeft: (...args: []) => IZPoint2d = ...

Calculates the top left point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The top left point of the rectangle.

topRight

topRight: (...args: []) => IZPoint2d = ...

Calculates the top right point of the rectangle.

Type Declaration

- (...args: []): IZPoint2d
- Parameters
  - ...args: []
  Returns IZPoint2d
  The top right point of the rectangle.

Methods

area

area(): number
Calculates the area of the rectangle.

Returns number
The numeric area of the rectangle.
- Defined in packages/helpful-fn/src/geometry/rectangle.mts:47

attach

attach(
    anchor: ZAnchor,
    candidate: IZQuadrilateral,
    candidateAnchor: ZAnchor,
): IZQuadrilateral
Takes a candidate and attaches it to this rectangle that matches the anchor points.
Parameters
- anchor: ZAnchor
  The anchor point of this rectangle.
- candidate: IZQuadrilateral
  The candidate rectangle to move
- candidateAnchor: ZAnchor
  The anchor point of the candidate rectangle.
Returns IZQuadrilateral
A new quadrilateral that has it's placement such that if candidate was moved to this resulting position, would have its candidateAnchor be in the same place as this rectangles specified anchor.
- Defined in packages/helpful-fn/src/geometry/rectangle.mts:66

height

height(): number
Calculates the height of the rectangle.

Returns number
The numeric height of the rectangle.
- Defined in packages/helpful-fn/src/geometry/rectangle.mts:36

offsetToFit

offsetToFit(candidate: IZQuadrilateral): IZQuadrilateral
Takes the candidate quadrilateral and adjusts it's coordinates to fit inside this rectangle.

This is done by shifting the rectangle left, right, up, and down to make sure it is bounded inside.

If the candidate width or height is larger than this rectangle, thus it cannot fit, then the candidate will be centered on the dimension where it is too big to fit.
Parameters
- candidate: IZQuadrilateral
  The candidate quadrilateral to fit.
Returns IZQuadrilateral
A new quadrilateral that offsets candidate so that it can fit inside this rectangle.
- Defined in packages/helpful-fn/src/geometry/rectangle.mts:104

point

point(anchor: ZAnchor): IZPoint2d
Calculates the (x, y) point given an anchor target.
Parameters
- anchor: ZAnchor
  The anchor target to calculate the point for.
Returns IZPoint2d
The numeric width of the rectangle.
- Defined in packages/helpful-fn/src/geometry/rectangle.mts:180

width

width(): number
Calculates the width of the rectangle.

Returns number
The numeric width of the rectangle.
- Defined in packages/helpful-fn/src/geometry/rectangle.mts:25

Class ZRectangle

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ZRectangle

Properties

bottomCenter

Type Declaration

Parameters

Returns IZPoint2d

bottomLeft

Type Declaration

Parameters

Returns IZPoint2d

bottomRight

Type Declaration

Parameters

Returns IZPoint2d

middleCenter

Type Declaration

Parameters

Returns IZPoint2d

middleLeft

Type Declaration

Parameters

Returns IZPoint2d

middleRight

Type Declaration

Parameters

Returns IZPoint2d

Readonlysides

topCenter

Type Declaration

Parameters

Returns IZPoint2d

topLeft

Type Declaration

Parameters

Returns IZPoint2d

topRight

Type Declaration

Parameters

Returns IZPoint2d

Methods

area

Returns number

attach

Parameters

Returns IZQuadrilateral

height

Returns number

offsetToFit

Parameters

Returns IZQuadrilateral

point

Parameters

Returns IZPoint2d

width

Returns number

Settings

On This Page

`Readonly`sides