Represents a canvas for drawing to a map. Each canvas is associated with a specific MapRenderer and represents that renderer’s layer on the map.
Functions:
| Name | Description |
|---|---|
drawImage | Draw an image to the map. The image will be clipped if necessary. |
getBasePixel | Get a pixel from the layers below this canvas. |
getBasePixelColor | Get a pixel from the layers below this canvas. |
getMapView | Get the map this canvas is attached to. |
getPixel | Get a pixel from the canvas. |
getPixelColor | Get a pixel from the canvas. |
setPixel | Draw a pixel to the canvas. |
setPixelColor | Draw a pixel to the canvas. |
void drawImage(int x, int y, const Image &image)Draw an image to the map. The image will be clipped if necessary.
Parameters:
xThe x coordinate of the image.yThe y coordinate of the image.imageThe Image to draw.
int getBasePixel(int x, int y) constGet a pixel from the layers below this canvas.
Parameters:
xThe x coordinate, from 0 to 127.yThe y coordinate, from 0 to 127.
Returns:
The color.
Color getBasePixelColor(int x, int y) constGet a pixel from the layers below this canvas.
Parameters:
xThe x coordinate, from 0 to 127.yThe y coordinate, from 0 to 127.
Returns:
The color.
MapView &getMapView() constGet the map this canvas is attached to.
Returns:
The MapView this canvas is attached to.
int getPixel(int x, int y) constGet a pixel from the canvas.
Parameters:
xThe x coordinate, from 0 to 127.yThe y coordinate, from 0 to 127.
Returns:
The color.
std::optional<Color> getPixelColor(int x, int y) constGet a pixel from the canvas.
If no color is set at the given position for this canvas, then std::nullopt is returned and the color returned by getBasePixelColor() is shown on the map.
Parameters:
xThe x coordinate, from 0 to 127.yThe y coordinate, from 0 to 127.
Returns:
The color, or std::nullopt if no color is set.
void setPixel(int x, int y, int color)Draw a pixel to the canvas.
Parameters:
xThe x coordinate, from 0 to 127.yThe y coordinate, from 0 to 127.colorThe color.
void setPixelColor(int x, int y, std::optional<Color> color)Draw a pixel to the canvas.
If std::nullopt is used as color, then the color returned by getBasePixelColor() is shown on the map.
Parameters:
xThe x coordinate, from 0 to 127.yThe y coordinate, from 0 to 127.colorThe color, or std::nullopt for base color.