Constructor
new Rectangle(pos, dimopt, wopt, hopt)
Rectangle constructor
| Name | Type | Attributes | Description |
|---|---|---|---|
pos | Point | | ||
dim | Dimension | | <optional> | |
w | number | <optional> | |
h | number | <optional> |
<p>// Calling Rectangle() with different sets of parameters<br>
// A Point and a Dimension:<br>
new Rectangle(pos, dim)<br>
// Another Rectangle, to be cloned:<br>
new Rectangle(rect)<br>
// Two Point objects containing the coordinates of upper-left and lower-right vertexs:<br>
new Rectangle(p0, p1)<br>
// An array of four numbers with the coordinates of the same vertexs:<br>
new Rectangle([x0, y0, x1, y1])<br>
// Four single numbers, meaning the same coordinates as above:<br>
new Rectangle(x0, y0, x1, y1)</p>Extends
Members
dim :module:AWT.Dimension
The Dimension of the Rectangle
pos :module:AWT.Point
The current position of the shape
- Overrides
type :string
Shape type id
- string
- Overrides
Methods
add(shape) → {module:AWT.Rectangle}
Adds the boundaries of another shape to the current one
| Name | Type | Description |
|---|---|---|
shape | module:AWT. | The |
- Type:
- module:AWT.
Rectangle
clip(ctx, fillRuleopt) → {external:CanvasRenderingContext2D}
Creates a clipping region on the specified HTML canvas 2D rendering context
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
ctx | external:CanvasRenderingContext2D | The rendering context | ||
fillRule | string | <optional> | 'nonzero' | Can be 'nonzero' (default when not set) or 'evenodd' |
- Overrides
- The provided rendering context
clone() → {module:AWT.Rectangle}
Clones this Rectangle
- Type:
- module:AWT.
Rectangle
contains(_p) → {boolean}
Checks if the provided module:AWT.Point is inside this shape.
| Name | Type | Description |
|---|---|---|
_p | module:AWT. | The point to check |
- Overrides
- Type:
- boolean
equals(r) → {boolean}
Checks if two shapes are equivalent.
| Name | Type | Description |
|---|---|---|
r | module:AWT. | The Shape to compare against |
- Overrides
- Type:
- boolean
fill(ctx, dirtyRegionopt) → {external:CanvasRenderingContext2D}
Fills the Shape with the current style in the provided HTML canvas context
| Name | Type | Attributes | Description |
|---|---|---|---|
ctx | external:CanvasRenderingContext2D | The canvas 2D rendering context where to fill this shape. | |
dirtyRegion | module:AWT. | <optional> | The context region to be updated. Used as clipping |
- Overrides
- The provided rendering context
getAttributes() → {object}
Gets a object with the basic attributes needed to rebuild this instance excluding functions,
parent references, constants and also attributes retaining the default value.
The resulting object is commonly usued to serialize elements in JSON format.
- The resulting object, with minimal attrributes
- Type:
- object
getBounds() → {module:AWT.Rectangle}
Gets the enclosing Rectangle of this Shape.
- Overrides
- Type:
- module:AWT.
Rectangle
getCoords() → {string}
Gets a string with the co-ordinates of the upper-left and lower-right vertexs of this rectangle,
(with values rounded to int)
- Type:
- string
getOppositeVertex() → {module:AWT.Point}
Gets the module:AWT.Point corresponding to the lower-right vertex of the Rectangle.
- Type:
- module:AWT.
Point
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.
| Name | Type | Description |
|---|---|---|
rect | module:AWT. | The rectangle to be taken as a base for moving and scaling |
- Overrides
- Type:
- module:AWT.
Shape
grow(dx, dy) → {module:AWT.Rectangle}
Expands the boundaries of this shape. This affects the current position and dimension.
| Name | Type | Description |
|---|---|---|
dx | number | The amount to grow (or decrease) in horizontal direction |
dy | number | The amount to grow (or decrease) in vertical direction |
- Type:
- module:AWT.
Rectangle
intersects(_r) → {boolean}
Checks if the provided Rectangle r intersects with this shape.
| Name | Type | Description |
|---|---|---|
_r | module:AWT. |
- Overrides
- Type:
- boolean
isRect() → {boolean}
Shorthand method for determining if a Shape is an Rectangle
- Overrides
- Type:
- boolean
moveBy(delta) → {module:AWT.Shape}
Shifts the shape a specified amount in horizontal and vertical directions
| Name | Type | Description |
|---|---|---|
delta | Point | | The amount to shift the Shape |
- Overrides
- Type:
- module:AWT.
Shape
moveTo(newPos) → {module:AWT.Shape}
Moves this shape to a new position
| Name | Type | Description |
|---|---|---|
newPos | module:AWT. | The new position of the shape |
- Overrides
- 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.
| Name | Type | Description |
|---|---|---|
ctx | external:CanvasRenderingContext2D |
- Overrides
- The provided rendering context
scaleBy(delta) → {module:AWT.Rectangle}
Multiplies the dimension of the Shape by the specified delta amount.
| Name | Type | Description |
|---|---|---|
delta | Point | | Object containing the X and Y ratio to be scaled. |
- Overrides
- Type:
- module:AWT.
Rectangle
setAttributes(data) → {module:AWT.Rectangle}
Reads the properties of this Rectangle from a data object
| Name | Type | Description |
|---|---|---|
data | object | The data object to be parsed |
- Overrides
- Type:
- module:AWT.
Rectangle
setBounds(rect) → {module:AWT.Rectangle}
Sets this Rectangle the position and dimension of another one
| Name | Type | Description |
|---|---|---|
rect | module:AWT. |
- Type:
- module:AWT.
Rectangle
stroke(ctx) → {external:CanvasRenderingContext2D}
Draws this shape in the provided HTML canvas 2D rendering context.
| Name | Type | Description |
|---|---|---|
ctx | external:CanvasRenderingContext2D | The canvas 2D rendering context where to draw the shape. |
- Overrides
- The provided rendering context
toString() → {string}
Overwrites the original 'Object.toString' method with a more descriptive text
- Overrides
- Type:
- string