icy.type.dimension

Class Dimension2D

java.lang.Object

java.awt.geom.Dimension2D

icy.type.dimension.Dimension2D

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Dimension2D.Double, Dimension2D.Float

public abstract class Dimension2D
extends java.awt.geom.Dimension2D

The Dimension2D class is to encapsulate a 2D dimension (X,Y).

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dimension2D.Double
static class	Dimension2D.Float

Constructor Summary

Constructors

Constructor and Description
Dimension2D()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.awt.Dimension	getDimInt() Returns an integer Dimension that encloses the double Dimension2D.
double	getSizeX() Returns the size of the X dimension in double precision.
double	getSizeY() Returns the size of the Y dimension in double precision.
abstract boolean	isInfiniteX() Returns true if the X dimension should be considered as infinite.
abstract boolean	isInfiniteY() Returns true if the Y dimension should be considered as infinite.
abstract void	setSize(double sizeX, double sizeY) Sets the size of this Dimension2D object.
abstract void	setSizeX(double value) Sets the size of the X dimension of this Dimension2D in double precision.
abstract void	setSizeY(double value) Sets the size of the Y dimension of this Dimension2D in double precision.
java.lang.String	toString()

Methods inherited from class java.awt.geom.Dimension2D

clone, getHeight, getWidth, setSize

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Dimension2D

public Dimension2D()

Method Detail

getSizeX

public double getSizeX()

Returns the size of the X dimension in double precision.
Same as Dimension2D.getWidth()

Returns:

the size of the X dimension.

See Also:

Dimension2D.getWidth()

getSizeY

public double getSizeY()

Returns the size of the Y dimension in double precision.
Same as Dimension2D.getHeight()

Returns:

the size of the Y dimension.

See Also:

Dimension2D.getHeight()

setSizeX

public abstract void setSizeX(double value)

Sets the size of the X dimension of this Dimension2D in double precision.

setSizeY

public abstract void setSizeY(double value)

Sets the size of the Y dimension of this Dimension2D in double precision.

setSize

public abstract void setSize(double sizeX,
           double sizeY)

Sets the size of this Dimension2D object.

Specified by:

setSize in class java.awt.geom.Dimension2D

Parameters:

sizeX - the new size for the X dimension

sizeY - the new size for the Y dimension

getDimInt

public java.awt.Dimension getDimInt()

Returns an integer Dimension that encloses the double Dimension2D.
The returned Dimension might also fail to completely enclose the original double Dimension2D if it overflows the limited range of the integer data type.

Returns:

an integer Dimension that completely encloses the actual double Dimension2D.

isInfiniteX

public abstract boolean isInfiniteX()

Returns true if the X dimension should be considered as infinite.

isInfiniteY

public abstract boolean isInfiniteY()

Returns true if the Y dimension should be considered as infinite.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object