gov.nasa.worldwind.geom

Class Offset

java.lang.Object

gov.nasa.worldwind.geom.Offset

public class Offset
extends java.lang.Object

Specifies an offset relative to a rectangle. Used by renderable shapes.

Field Summary

Fields

Modifier and Type	Field and Description
double	x The offset in the X dimension, interpreted according to this instance's xUnits argument.
int	xUnits The units of this instance's X offset.
double	y The offset in the Y dimension, interpreted according to this instance's yUnits argument.
int	yUnits The units of this instance's Y offset.

Constructor Summary

Constructors

Constructor and Description
Offset(int xUnits, double x, int yUnits, double y) Constructs an offset instance given specified units and offsets.
Offset(Offset copy) Creates a new copy of this offset with identical property values.

Method Summary

Modifier and Type	Method and Description
static Offset	bottomCenter() This factory method returns a new offset for anchoring an image to the bottom and the center width.
static Offset	bottomLeft() This factory method returns a new offset used for anchoring an image to the bottom, left of its geographic position.
static Offset	bottomRight() This factory method returns a new offset for anchoring an image to the bottom, right of its geographic position.
static Offset	center() This factory method returns a new offset for centering an image on its geographic position.
boolean	equals(java.lang.Object o)
int	hashCode()
Vec2	offsetForSize(double width, double height, Vec2 result) Returns this offset's absolute X and Y coordinates in pixels for a rectangle of a specified size in pixels.
Offset	set(Offset offset) Sets this offset to identical property values of the specified offset.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public double x

The offset in the X dimension, interpreted according to this instance's xUnits argument.

y

public double y

The offset in the Y dimension, interpreted according to this instance's yUnits argument.

xUnits

public int xUnits

The units of this instance's X offset. See this class' constructor description for a list of the possible values.

yUnits

public int yUnits

The units of this instance's Y offset. See this class' constructor description for a list of the possible values.

Constructor Detail

Offset

public Offset(int xUnits,
              double x,
              int yUnits,
              double y)

Constructs an offset instance given specified units and offsets.

Parameters:

xUnits - The type of units specified for the X dimension. May be one of the following:

• [WorldWind.OFFSET_FRACTION]WorldWind.OFFSET_FRACTION
• [WorldWind.OFFSET_INSET_PIXELS]WorldWind.OFFSET_INSET_PIXELS
• [WorldWind.OFFSET_PIXELS]WorldWind.OFFSET_PIXELS

x - The offset in the X dimension.

yUnits - The type of units specified for the Y dimension, assuming a lower-left Y origin. May be one of the following:

• [WorldWind.OFFSET_FRACTION]WorldWind.OFFSET_FRACTION
• [WorldWind.OFFSET_INSET_PIXELS]WorldWind.OFFSET_INSET_PIXELS
• [WorldWind.OFFSET_PIXELS]WorldWind.OFFSET_PIXELS

y - The offset in the Y dimension.

Offset

public Offset(Offset copy)

Creates a new copy of this offset with identical property values.

Method Detail

center

public static Offset center()

This factory method returns a new offset for centering an image on its geographic position.

Returns:

Offset(WorldWind.OFFSET_FRACTION, 0.5, WorldWind.OFFSET_FRACTION, 0.5)

bottomLeft

public static Offset bottomLeft()

This factory method returns a new offset used for anchoring an image to the bottom, left of its geographic position.

Returns:

Offset(WorldWind.OFFSET_FRACTION, 0.0, WorldWind.OFFSET_FRACTION, 0.0)

bottomCenter

public static Offset bottomCenter()

This factory method returns a new offset for anchoring an image to the bottom and the center width.

Returns:

Offset(WorldWind.OFFSET_FRACTION, 0.5, WorldWind.OFFSET_FRACTION, 0.0)

bottomRight

public static Offset bottomRight()

This factory method returns a new offset for anchoring an image to the bottom, right of its geographic position.

Returns:

Offset(WorldWind.OFFSET_FRACTION, 1.0, WorldWind.OFFSET_FRACTION, 0.0)

set

public Offset set(Offset offset)

Sets this offset to identical property values of the specified offset.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

offsetForSize

public Vec2 offsetForSize(double width,
                          double height,
                          Vec2 result)

Returns this offset's absolute X and Y coordinates in pixels for a rectangle of a specified size in pixels. The returned offset is in pixels relative to the rectangle's origin, and is defined in the coordinate system used by the caller.

Parameters:

width - the rectangle's width in pixels

height - the rectangles height in pixels

result - a pre-allocated Vec2 in which to return the computed offset relative to the rectangle's origin

Returns:

the result argument set to the computed offset