Class: Shape

Constructor

(abstract) new Shape(pos)

Shape constructor

Parameters:

Name	Type	Description
`pos`	module:AWT.Point	The top-left coordinates of this Shape

Source: AWT.js, line 825

Members

pos :module:AWT.Point

The current position of the shape

Type:

module:AWT.Point

Source: AWT.js, line 1020

type :string

Shape type id

Type:

string

Source: AWT.js, line 1015

type :string

The type of shape (Rectangle, ellipse, path...)

Type:

string

Source: AWT.js, line 1025

Methods

clip(ctx, fillRuleopt) → {external:CanvasRenderingContext2D}

Creates a clipping region on the specified HTML canvas 2D rendering context

Parameters:

Name	Type	Attributes	Default	Description
`ctx`	external:CanvasRenderingContext2D			The rendering context
`fillRule`	string	<optional>	'nonzero'	Can be 'nonzero' (default when not set) or 'evenodd'

Source: AWT.js, line 962

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

contains(_p) → {boolean}

Checks if the provided module:AWT.Point is inside this shape.

Parameters:

Name	Type	Description
`_p`	module:AWT.Point	The point to check

Source: AWT.js, line 897

Returns:

Type:: boolean

equals(p) → {boolean}

Checks if two shapes are equivalent.

Parameters:

Name	Type	Description
`p`	module:AWT.Shape	The Shape to compare against

Source: AWT.js, line 867

Returns:

Type:: boolean

fill(ctx, dirtyRegionopt) → {external:CanvasRenderingContext2D}

Fills the Shape with the current style in the provided HTML canvas context

Parameters:

Name	Type	Attributes	Description
`ctx`	external:CanvasRenderingContext2D		The canvas 2D rendering context where to fill this shape.
`dirtyRegion`	module:AWT.Rectangle	<optional>	The context region to be updated. Used as clipping region when drawing.

Source: AWT.js, line 919

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

getBounds() → {module:AWT.Rectangle}

Gets the enclosing Rectangle of this Shape.

Source: AWT.js, line 858

Returns:

Type:: module:AWT.Rectangle

getShape(rect) → {module:AWT.Shape}

Gets a clone of this shape moved to the pos component of the rectangle and scaled
by its dim value.

Parameters:

Name	Type	Description
`rect`	module:AWT.Rectangle	The rectangle to be taken as a base for moving and scaling this shape.

Source: AWT.js, line 888

Returns:

Type:: module:AWT.Shape

intersects(_r) → {boolean}

Checks if the provided Rectangle r intersects with this shape.

Parameters:

Name	Type	Description
`_r`	module:AWT.Rectangle

Source: AWT.js, line 907

Returns:

Type:: boolean

isRect() → {boolean}

Shorthand method for determining if a Shape is an Rectangle

Source: AWT.js, line 972

Returns:

Type:: boolean

moveBy(delta) → {module:AWT.Shape}

Shifts the shape a specified amount in horizontal and vertical directions

Parameters:

Name	Type	Description
`delta`	Point \| Dimension	The amount to shift the Shape

Source: AWT.js, line 839

Returns:

Type:: module:AWT.Shape

moveTo(newPos) → {module:AWT.Shape}

Moves this shape to a new position

Parameters:

Name	Type	Description
`newPos`	module:AWT.Point	The new position of the shape

Source: AWT.js, line 849

Returns:

Type:: module:AWT.Shape

preparePath(ctx) → {external:CanvasRenderingContext2D}

Prepares an HTML canvas 2D rendering context with a path that can be used to stroke a line,
to fill a surface or to define a clipping region.

Parameters:

Name	Type	Description
`ctx`	external:CanvasRenderingContext2D

Source: AWT.js, line 951

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

scaleBy(_delta) → {module:AWT.Shape}

Multiplies the dimension of the Shape by the specified delta amount.

Parameters:

Name	Type	Description
`_delta`	Point \| Dimension	Object containing the X and Y ratio to be scaled.

Source: AWT.js, line 876

Returns:

Type:: module:AWT.Shape

setAttributes(data) → {module:AWT.Shape}

Reads the properties of this Shape from a data object

Parameters:

Name	Type	Description
`data`	object	The data object to be parsed

Source: AWT.js, line 989

Returns:

Type:: module:AWT.Shape

stroke(ctx) → {external:CanvasRenderingContext2D}

Draws this shape in the provided HTML canvas 2D rendering context.

Parameters:

Name	Type	Description
`ctx`	external:CanvasRenderingContext2D	The canvas 2D rendering context where to draw the shape.

Source: AWT.js, line 939

Returns:

The provided rendering context

Type:: external:CanvasRenderingContext2D

toString() → {string}

Overwrites the original 'Object.toString' method with a more descriptive text

Source: AWT.js, line 980

Returns:

Type:: string

(static) buildShape(data) → {module:AWT.Shape}

Builds a shape based on the provided data object.
Data should contain a 'type' member, specifying the type of shape requested ('rect', 'ellipse', 'rectangle' or 'path')

Parameters:

Name	Type	Description
`data`	object	Specific data for this shape

Source: AWT.js, line 1005

Returns:

Type:: module:AWT.Shape