new Line(x1, y1, x2, y2)
Parameters:
Name | Type | Description |
---|---|---|
x1 |
number | x coordinate of starting point of line. |
y1 |
number | y coordinate of starting point of line. |
x2 |
number | x coordinate of end point of line. |
y2 |
number | y coordinate of end point of line. |
- Source:
Extends
Methods
containsPoint(x, y)
Checks if a given point is contained in the line.
Will always be false, just written as an override.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | x coordinate of the point being tested. |
y |
number | y coordinate of the point being tested. |
- Overrides:
- Source:
draw(__graphics__)
Draws the line in the canvas.
Parameters:
Name | Type | Description |
---|---|---|
__graphics__ |
CodeHSGraphics | Instance of the __graphics__ module. |
- Overrides:
- Source:
getBorderColor() → {Color}
Gets the border color of a Thing.
- Inherited From:
- Source:
Returns:
The color of the Thing's border.
- Type
- Color
getBorderWidth() → {number}
Gets the width of the Thing's border.
- Inherited From:
- Source:
Returns:
The width of the Thing's border.
- Type
- number
getColor() → {Color}
Gets the color of a line.
- Overrides:
- Source:
Returns:
Color of the line.
- Type
- Color
getEndX() → {number}
Gets the x coordinate of the Line's end point.
- Source:
Returns:
The x coordinate of the Line's end point.
- Type
- number
getEndY() → {number}
Gets the y coordinate of the Line's end point.
- Source:
Returns:
The y coordinate of the Line's end point.
- Type
- number
getHeight() → {number}
Returns the height of the line.
- Source:
Returns:
The width of the line.
- Type
- number
getStartX() → {number}
Gets the x coordinate of the Line's start point.
- Source:
Returns:
The x coordinate of the Line's start point.
- Type
- number
getStartY() → {number}
Gets the y coordinate of the Line's start point.
- Source:
Returns:
The y coordinate of the Line's start point.
- Type
- number
getType() → {type}
Returns the type of a Thing.
- Inherited From:
- Source:
Returns:
The type of the Thing.
- Type
- type
getWidth() → {number}
Returns the width of the line.
- Source:
Returns:
The width of the line.
- Type
- number
getX() → {number}
Gets the x coordinate of the Line's start point.
- Overrides:
- Source:
Returns:
The x coordinate of the Line's start point.
- Type
- number
getY() → {number}
Gets the y coordinate of the Line's start point.
- Overrides:
- Source:
Returns:
The y coordinate of the Line's start point.
- Type
- number
hasBorder() → {boolean}
Returns if a Thing has a border.
- Inherited From:
- Source:
Returns:
True if the Thing has a border.
- Type
- boolean
isFilled() → {boolean}
Returns if a Thing is filled.
- Inherited From:
- Source:
Returns:
True if the Thing is filled.
- Type
- boolean
move(dx, dy)
Moves the entire line.
Parameters:
Name | Type | Description |
---|---|---|
dx |
number | The change in x coordinate of both starting and ending points. |
dy |
number | The change in y coordinate of both starting and ending points. |
- Overrides:
- Source:
rotate(degrees, angleUnit)
Rotates a Thing an additional amount of degrees.
Parameters:
Name | Type | Description |
---|---|---|
degrees |
number | The degrees to rotate degrees. |
angleUnit |
number | Whether it is degrees or radians. Defaults to degrees. |
- Inherited From:
- Source:
setBorder(hasBorder)
Sets a Thing object to filled.
Throws an error if an argument is not passed.
Parameters:
Name | Type | Description |
---|---|---|
hasBorder |
bool | A boolean of whether or not Thing has a border. |
- Inherited From:
- Source:
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.
Parameters:
Name | Type | Description |
---|---|---|
color |
Color | The resulting color of the Thing's border. |
- Inherited From:
- Source:
setBorderWidth(width)
Sets the width of a Thing's border.
Throws an error if there is not 1 argument.
Parameters:
Name | Type | Description |
---|---|---|
width |
number | The resulting width of the Thing's border. |
- Inherited From:
- Source:
setColor(color)
Sets the color of a line.
Parameters:
Name | Type | Description |
---|---|---|
color |
Color | Sets the color of the line. |
- Overrides:
- Source:
setEndpoint(x, y)
Sets the *ending* point of the line.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the resulting ending point. |
y |
number | The y coordinate of the resulting ending point. |
- Source:
setFilled(filled)
Sets a Thing object to filled.
Throws an error if an argument is not passed.
Parameters:
Name | Type | Description |
---|---|---|
filled |
bool | A boolean of whether or not Thing is filled. |
- Inherited From:
- Source:
setLineWidth(width)
Sets the width of the line.
Parameters:
Name | Type | Description |
---|---|---|
width |
number | The resulting width of the line. |
- Source:
setPosition(x, y)
Sets the *starting* point of the line.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the resulting starting point. |
y |
number | The y coordinate of the resulting starting point. |
- Overrides:
- Source:
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.
Parameters:
Name | Type | Description |
---|---|---|
degrees |
number | The degrees to rotate degrees. |
angleUnit |
number | Whether it is degrees or radians. Defaults to degrees. |
- Inherited From:
- Source:
setStartpoint(x, y)
Sets the *starting* point of the line.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the resulting ending point. |
y |
number | The y coordinate of the resulting ending point. |
- Source:
setType(type)
Sets a Thing object's type.
Questionable of whether or not this method is used.
Parameters:
Name | Type | Description |
---|---|---|
type |
type | A type to set the Thing to. |
- Inherited From:
- Source: