com.github.wuic.engine

Class Region

java.lang.Object

java.awt.geom.Dimension2D

java.awt.Dimension

com.github.wuic.engine.Region

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Dimension>

public class Region
extends Dimension
implements Comparable<Dimension>

Represents a region to use when need to specify a sprite.

Since:

0.2.0

Version:

1.4

Author:

Guillaume DROUET

See Also:

Serialized Form

Field Summary

Fields inherited from class java.awt.Dimension

height, width

Constructor Summary

Constructors

Constructor and Description
Region(int x, int y, Dimension d) Builds a new region.
Region(int x, int y, int w, int h) Builds a new region.
Region(Region other) Builds a region with the area represented by the given region.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Dimension other) Compares this region to another dimension.
boolean	equals(Object other)
int	getxPosition() Gets the x position.
int	getyPosition() Gets the y position.
int	hashCode()

Methods inherited from class java.awt.Dimension

getHeight, getSize, getWidth, setSize, setSize, setSize, toString

Methods inherited from class java.awt.geom.Dimension2D

clone, setSize

Methods inherited from class java.lang.Object

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

Constructor Detail

Region

public Region(int x,
      int y,
      int w,
      int h)

Builds a new region.

Parameters:

x - the x position

y - the y position

w - the width

h - the height

Region

public Region(int x,
      int y,
      Dimension d)

Builds a new region.

Parameters:

x - the x position

y - the y position

d - the region's dimensions

Region

public Region(Region other)

Builds a region with the area represented by the given region.

Parameters:

other - the given region

Method Detail

getxPosition

public int getxPosition()

Gets the x position.

Returns:

the x position

getyPosition

public int getyPosition()

Gets the y position.

Returns:

the y position

compareTo

public int compareTo(Dimension other)

Compares this region to another dimension.

This region is bigger than the compared dimension if and only if its width AND its height are bigger than the other one.

Specified by:

compareTo in interface Comparable<Dimension>

Parameters:

other - the other dimension

Returns:

a positive, zero or negative value indicating the result of comparison

equals

public boolean equals(Object other)

Overrides:

equals in class Dimension

hashCode

public int hashCode()

Overrides:

hashCode in class Dimension