org.openstreetmap.josm.tools

Class ImageOverlay

java.lang.Object

org.openstreetmap.josm.tools.ImageOverlay

public class ImageOverlay
extends java.lang.Object

class to describe how image overlay

Since:

8095

Field Summary

Fields

Modifier and Type	Field and Description
ImageProvider	image the image ressource to use as overlay
private double	offsetBottom offset of the image from bottom border, values between 0 and 1
private double	offsetLeft offset of the image from left border, values between 0 and 1
private double	offsetRight offset of the image from top border, values between 0 and 1
private double	offsetTop offset of the image from right border, values between 0 and 1

Constructor Summary

Constructors

Constructor and Description
ImageOverlay(ImageProvider image) Create an overlay in southeast corner.
ImageOverlay(ImageProvider image, double offsetLeft, double offsetTop, double offsetRight, double offsetBottom) Create an overlay info.

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	apply(java.awt.image.BufferedImage ground) Handle overlay.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

image

public ImageProvider image

the image ressource to use as overlay

offsetLeft

private double offsetLeft

offset of the image from left border, values between 0 and 1

offsetRight

private double offsetRight

offset of the image from top border, values between 0 and 1

offsetTop

private double offsetTop

offset of the image from right border, values between 0 and 1

offsetBottom

private double offsetBottom

offset of the image from bottom border, values between 0 and 1

Constructor Detail

ImageOverlay

public ImageOverlay(ImageProvider image,
                    double offsetLeft,
                    double offsetTop,
                    double offsetRight,
                    double offsetBottom)

Create an overlay info. All values are relative sizes between 0 and 1. Size of the image is the result of the difference between left/right and top/bottom.

Parameters:

image - imager provider for the overlay icon

offsetLeft - offset of the image from left border, values between 0 and 1, -1 for auto-calculation

offsetTop - offset of the image from top border, values between 0 and 1, -1 for auto-calculation

offsetRight - offset of the image from right border, values between 0 and 1, -1 for auto-calculation

offsetBottom - offset of the image from bottom border, values between 0 and 1, -1 for auto-calculation

Since:

8095

ImageOverlay

public ImageOverlay(ImageProvider image)

Create an overlay in southeast corner. All values are relative sizes between 0 and 1. Size of the image is the result of the difference between left/right and top/bottom. Right and bottom values are set to 1.

Parameters:

image - imager provider for the overlay icon

Since:

8095

See Also:

ImageOverlay(ImageProvider, double, double, double, double)

Method Detail

apply

public java.awt.image.BufferedImage apply(java.awt.image.BufferedImage ground)

Handle overlay. The image passed as argument is modified!

Parameters:

ground - the base image for the overlay (gets modified!)

Returns:

the modified image (same as argument)

Since:

8095