new Polygon()
- Source:
Extends
Methods
addPoint(x, y)
Adds a vertex to the polygon.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
x |
number
|
The x coordinate of the desired new vertex. |
y |
number
|
The y coordinate of the desired new vertex. |
containsPoint(x, y) → {boolean}
Checks if the passed point is contained in the polygon.
- Overrides:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
x |
number
|
The x coordinate of the point being tested. |
y |
number
|
The y coordinate of the point being tested. |
Returns:
- Type:
-
boolean
Whether the passed point is contained in the polygon.
draw(__graphics__)
Draws the polygon in the canvas.
- Overrides:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
__graphics__ |
CodeHSGraphics
|
Instance of the __graphics__ module. |
getBorderWidth() → {number}
Gets the width of the Thing's border.
- Inherited From:
- Source:
Returns:
- Type:
-
number
The width of the Thing's border.
getHeight() → {number}
Gets the height of the rectangle.
- Source:
Returns:
- Type:
-
number
Height of the rectangle.
getType() → {type}
Returns the type of a Thing.
- Inherited From:
- Source:
Returns:
- Type:
-
type
The type of the Thing.
getWidth() → {number}
Gets the width of the rectangle.
- Source:
Returns:
- Type:
-
number
Width of the rectangle.
getX() → {number}
Gets the x position of the Thing.
- Inherited From:
- Source:
Returns:
- Type:
-
number
The x position of the Thing.
getY() → {number}
Gets the y position of the Thing.
- Inherited From:
- Source:
Returns:
- Type:
-
number
The y position of the Thing.
hasBorder() → {boolean}
Returns if a Thing has a border.
- Inherited From:
- Source:
Returns:
- Type:
-
boolean
True if the Thing has a border.
isFilled() → {boolean}
Returns if a Thing is filled.
- Inherited From:
- Source:
Returns:
- Type:
-
boolean
True if the Thing is filled.
move(dx, dy)
Moves the entire polygon.
- Overrides:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
dx |
number
|
The change in x coordinate of all starting and ending points. |
dy |
number
|
The change in y coordinate of all starting and ending points. |
rotate(degrees, angleUnit)
Rotates a Thing an additional amount of degrees.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
degrees |
number
|
The degrees to rotate degrees. |
angleUnit |
number
|
Whether it is degrees or radians. Defaults to degrees. |
setBorder(hasBorder)
Sets a Thing object to filled.
Throws an error if an argument is not passed.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
hasBorder |
bool
|
A boolean of whether or not Thing has a border. |
setBorderColor(color)
Sets the border color of a Thing.
Throws an error if there are fewer than 1 params or if
the param is undefined.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
color |
Color
|
The resulting color of the Thing's border. |
setBorderWidth(width)
Sets the width of a Thing's border.
Throws an error if there is not 1 argument.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
width |
number
|
The resulting width of the Thing's border. |
setColor(color)
Sets the color of a Thing.
Throws an error if there are fewer than 1 params or if
the param is undefined.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
color |
Color
|
The resulting color of Thing. |
setFilled(filled)
Sets a Thing object to filled.
Throws an error if an argument is not passed.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
filled |
bool
|
A boolean of whether or not Thing is filled. |
setPosition(x, y)
Sets the position of a Thing.
Throws an error if there are fewer than 2 params or if
they are not numbers.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
x |
number
|
The destination x coordinate of this Thing. |
y |
number
|
The destination y coordinate of this Thing. |
setRotation(degrees, angleUnit)
Sets the rotation of a Thing in degrees.
Throws an error if there are fewer than 1 params or if they
are not numbers.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
degrees |
number
|
The degrees to rotate degrees. |
angleUnit |
number
|
Whether it is degrees or radians. Defaults to degrees. |
setType(type)
Sets a Thing object's type.
Questionable of whether or not this method is used.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
type |
type
|
A type to set the Thing to. |