Package com.j3d.engine.math.convert

Class Offset

java.lang.Object

com.yetnt.utils.tuple.Pair<Integer,Integer>

com.yetnt.utils.tuple.SamePair<Integer>

com.j3d.engine.math.convert.Offset

public class Offset
extends SamePair<Integer>

A simple immutable class which stores an X and Y offset when converting between ScreenPoint and CartesianPoint using their offset overloads.

Author:

Lehlogonolo Poole

See Also:

• ConversionWithOffset
• ScreenPoint.toPoint(ConversionWithOffset)
• CartesianPoint.toScreen(ConversionWithOffset)

Field Summary

Fields

Modifier and Type	Field	Description
static final Offset	ZERO	A constant identical to instantiating the class with 0 as both values.

Fields inherited from class com.yetnt.utils.tuple.Pair

first, second

Constructor Summary

Constructors

Constructor	Description
Offset(int x, int y)	Default Constructor
Offset(SamePair<Integer> samePair)	Constructor from a same pair of integers

Method Summary

Modifier and Type	Method	Description
static <T extends Integer> Offset	fromMutablePair(MutablePair<T,T> mutablePair)	Creates an Offset immutable class from a MutablePair who's types are both Integer
int	getXOffset()	Returns the X offset
int	getYOffset()	Returns the Y offset

Methods inherited from class com.yetnt.utils.tuple.SamePair

from, map, mapTo

Methods inherited from class com.yetnt.utils.tuple.Pair

equals, getFirst, getSecond, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ZERO

public static final Offset ZERO

A constant identical to instantiating the class with 0 as both values.

Constructor Details

Offset

public Offset(int x,
 int y)

Default Constructor

Parameters:

x - The X offset

y - The Y offset

Offset

public Offset(SamePair<Integer> samePair)

Constructor from a same pair of integers

Parameters:

samePair - The same pair

Method Details

getXOffset

public int getXOffset()

Returns the X offset

Returns:

The X offset component

getYOffset

public int getYOffset()

Returns the Y offset

Returns:

The Y offset component

fromMutablePair

public static <T extends Integer> Offset fromMutablePair(MutablePair<T,T> mutablePair)

Creates an Offset immutable class from a MutablePair who's types are both Integer

Type Parameters:

T - The type held by the MutablePair, in this case it has to be an Integer

Parameters:

mutablePair - The mutable pair of integers

Returns:

A new immutable Offset instance