new WebImage(filename)
Parameters:
Name | Type | Description |
---|---|---|
filename |
string | Filepath to the image |
- Source:
Extends
Methods
checkDimensions()
Reinforce the dimensions of the WebImage based on the image it displays.
- Source:
containsPoint(x, y) → {boolean}
Checks if the passed point is contained in the WebImage.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
- Overrides:
- Source:
Returns:
Whether the passed point is contained in the WebImage.
- Type
- boolean
draw(__graphics__)
Draws the WebImage in the canvas.
Parameters:
Name | Type | Description |
---|---|---|
__graphics__ |
CodeHSGraphics | Instance of the __graphics__ module. |
- Overrides:
- Source:
getAlpha(x, y) → {integer}
Get the alpha value at a given location in the image.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
- Source:
Returns:
An integer between 0 and 255.
- Type
- integer
getBlue(x, y) → {integer}
Get the blue value at a given location in the image.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
- Source:
Returns:
An integer between 0 and 255.
- Type
- integer
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 Thing.
- Inherited From:
- Source:
Returns:
The destination y coordinate of this Thing.
- Type
- Color
getData()
Assign the ImageData of the canvas at the position of the image,
essentially assigning the ImageData.
Read more at https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getImageData
- Source:
getGreen(x, y) → {integer}
Get the green value at a given location in the image.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
- Source:
Returns:
An integer between 0 and 255.
- Type
- integer
getHeight() → {number}
Gets the height of the WebImage.
- Source:
Returns:
Height of the WebImage.
- Type
- number
getPixel(x, y) → {array}
Gets a pixel at the given x and y coordinates.
Read more here:
https://developer.mozilla.org/en-US/docs/Web/API/ImageData/data
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
- Source:
Returns:
An array of 4 numbers representing the (r,g,b,a) values
of the pixel at that coordinate.
- Type
- array
getRed(x, y) → {integer}
Get the red value at a given location in the image.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
- Source:
Returns:
An integer between 0 and 255.
- Type
- integer
getType() → {type}
Returns the type of a Thing.
- Inherited From:
- Source:
Returns:
The type of the Thing.
- Type
- type
getWidth() → {number}
Gets the width of the WebImage.
- Source:
Returns:
Width of the WebImage.
- Type
- number
getX() → {number}
Gets the x position of the Thing.
- Inherited From:
- Source:
Returns:
The x position of the Thing.
- Type
- number
getY() → {number}
Gets the y position of the Thing.
- Inherited From:
- Source:
Returns:
The y position of the Thing.
- 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
loaded(callback)
Set a function to be called when the WebImage is loaded.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function | A function |
- Source:
move(dx, dy)
Changes the possition of a thing by a specified x and y amount.
Parameters:
Name | Type | Description |
---|---|---|
dx |
number | The resulting change in the Thing's x position. |
dy |
number | The resulting change in the Thing's y position. |
- Inherited From:
- 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:
setAlpha(x, y, val)
Set the alpha value at a given location in the image to `val`.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
val |
integer | The desired value of the alpha component at the pixel. Must be between 0 and 255. |
- Source:
setBlue(x, y, val)
Set the blue value at a given location in the image to `val`.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
val |
integer | The desired value of the blue component at the pixel. Must be between 0 and 255. |
- 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 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 Thing. |
- Inherited From:
- 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:
setGreen(x, y, val)
Set the green value at a given location in the image to `val`.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
val |
integer | The desired value of the green component at the pixel. Must be between 0 and 255. |
- Source:
setImage(filename)
Set the image of the WebImage.
Parameters:
Name | Type | Description |
---|---|---|
filename |
string | Filepath to the image |
- Source:
setPixel(x, y, component, val)
Set the `component` value at a given location in the image to `val`.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
component |
integer | Integer representing the color value to be set. R, G, B = 0, 1, 2, respectively. |
val |
integer | The desired value of the `component` at the pixel. Must be between 0 and 255. |
- Source:
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.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The destination x coordinate of this Thing. |
y |
number | The destination y coordinate of this Thing. |
- Inherited From:
- Source:
setRed(x, y, val)
Set the red value at a given location in the image to `val`.
Parameters:
Name | Type | Description |
---|---|---|
x |
number | The x coordinate of the point being tested. |
y |
number | The y coordinate of the point being tested. |
val |
integer | The desired value of the red component at the pixel. Must be between 0 and 255. |
- 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:
setSize(width, height)
Sets the size of the WebImage.
Parameters:
Name | Type | Description |
---|---|---|
width |
number | The desired width of the resulting WebImage. |
height |
number | The desired height of the resulting WebImage. |
- 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: