Rectangle2D.Float (Java 2 Platform SE 5.0) (original) (raw)

java.awt.geom

Class Rectangle2D.Float

java.lang.Object extended by java.awt.geom.RectangularShape java.awt.geom.Rectangle2D java.awt.geom.Rectangle2D.Float

All Implemented Interfaces:

Shape, Cloneable

Enclosing class:

Rectangle2D

public static class Rectangle2D.Float

extends Rectangle2D

The Float class defines a rectangle specified in float coordinates.

Since:

1.2

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Rectangle2D
Rectangle2D.Double, Rectangle2D.Float

Field Summary
float	height The height of this Rectangle2D.
float	width The width of this Rectangle2D.
float	x The x coordinate of this Rectangle2D.
float	y The y coordinate of this Rectangle2D.

Fields inherited from class java.awt.geom.Rectangle2D
OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

Constructor Summary
Rectangle2D.Float() Constructs a new Rectangle2D, initialized to location (0.0, 0.0) and size (0.0, 0.0).
[Rectangle2D.Float](../../../java/awt/geom/Rectangle2D.Float.html#Rectangle2D.Float%28float, float, float, float%29)(float x, float y, float w, float h) Constructs and initializes a Rectangle2D from the specified float coordinates.

Method Summary
Rectangle2D	createIntersection(Rectangle2D r) Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specifiedRectangle2D.
Rectangle2D	createUnion(Rectangle2D r) Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.
Rectangle2D	getBounds2D() Returns the high precision bounding box of thisRectangle2D.
double	getHeight() Returns the height of this Rectangle2D in double precision.
double	getWidth() Returns the width of this Rectangle2D in double precision.
double	getX() Returns the X coordinate of this Rectangle2D in double precision.
double	getY() Returns the Y coordinate of this Rectangle2D in double precision.
boolean	isEmpty() Determines whether or not this Rectangle2D is empty.
int	[outcode](../../../java/awt/geom/Rectangle2D.Float.html#outcode%28double, double%29)(double x, double y) Determines where the specified float coordinates lie with respect to this Rectangle2D.
void	[setRect](../../../java/awt/geom/Rectangle2D.Float.html#setRect%28double, double, double, double%29)(double x, double y, double w, double h) Sets the location and size of this Rectangle2D to the specified double values.
void	[setRect](../../../java/awt/geom/Rectangle2D.Float.html#setRect%28float, float, float, float%29)(float x, float y, float w, float h) Sets the location and size of this Rectangle2D to the specified float values.
void	setRect(Rectangle2D r) Sets this Rectangle2D to be the same as the specified Rectangle2D.
String	toString() Returns the String representation of thisRectangle2D.

Methods inherited from class java.awt.geom.Rectangle2D
[add](../../../java/awt/geom/Rectangle2D.html#add%28double, double%29), add, add, [contains](../../../java/awt/geom/Rectangle2D.html#contains%28double, double%29), [contains](../../../java/awt/geom/Rectangle2D.html#contains%28double, double, double, double%29), equals, getPathIterator, [getPathIterator](../../../java/awt/geom/Rectangle2D.html#getPathIterator%28java.awt.geom.AffineTransform, double%29), hashCode, [intersect](../../../java/awt/geom/Rectangle2D.html#intersect%28java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D%29), [intersects](../../../java/awt/geom/Rectangle2D.html#intersects%28double, double, double, double%29), [intersectsLine](../../../java/awt/geom/Rectangle2D.html#intersectsLine%28double, double, double, double%29), intersectsLine, outcode, [setFrame](../../../java/awt/geom/Rectangle2D.html#setFrame%28double, double, double, double%29), [union](../../../java/awt/geom/Rectangle2D.html#union%28java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D%29)

Methods inherited from class java.awt.geom.Rectangle2D

[add](../../../java/awt/geom/Rectangle2D.html#add%28double, double%29), add, add, [contains](../../../java/awt/geom/Rectangle2D.html#contains%28double, double%29), [contains](../../../java/awt/geom/Rectangle2D.html#contains%28double, double, double, double%29), equals, getPathIterator, [getPathIterator](../../../java/awt/geom/Rectangle2D.html#getPathIterator%28java.awt.geom.AffineTransform, double%29), hashCode, [intersect](../../../java/awt/geom/Rectangle2D.html#intersect%28java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D%29), [intersects](../../../java/awt/geom/Rectangle2D.html#intersects%28double, double, double, double%29), [intersectsLine](../../../java/awt/geom/Rectangle2D.html#intersectsLine%28double, double, double, double%29), intersectsLine, outcode, [setFrame](../../../java/awt/geom/Rectangle2D.html#setFrame%28double, double, double, double%29), [union](../../../java/awt/geom/Rectangle2D.html#union%28java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D, java.awt.geom.Rectangle2D%29)

Methods inherited from class java.awt.geom.RectangularShape
clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, [setFrame](../../../java/awt/geom/RectangularShape.html#setFrame%28java.awt.geom.Point2D, java.awt.geom.Dimension2D%29), setFrame, [setFrameFromCenter](../../../java/awt/geom/RectangularShape.html#setFrameFromCenter%28double, double, double, double%29), [setFrameFromCenter](../../../java/awt/geom/RectangularShape.html#setFrameFromCenter%28java.awt.geom.Point2D, java.awt.geom.Point2D%29), [setFrameFromDiagonal](../../../java/awt/geom/RectangularShape.html#setFrameFromDiagonal%28double, double, double, double%29), [setFrameFromDiagonal](../../../java/awt/geom/RectangularShape.html#setFrameFromDiagonal%28java.awt.geom.Point2D, java.awt.geom.Point2D%29)

Methods inherited from class java.awt.geom.RectangularShape

clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, [setFrame](../../../java/awt/geom/RectangularShape.html#setFrame%28java.awt.geom.Point2D, java.awt.geom.Dimension2D%29), setFrame, [setFrameFromCenter](../../../java/awt/geom/RectangularShape.html#setFrameFromCenter%28double, double, double, double%29), [setFrameFromCenter](../../../java/awt/geom/RectangularShape.html#setFrameFromCenter%28java.awt.geom.Point2D, java.awt.geom.Point2D%29), [setFrameFromDiagonal](../../../java/awt/geom/RectangularShape.html#setFrameFromDiagonal%28double, double, double, double%29), [setFrameFromDiagonal](../../../java/awt/geom/RectangularShape.html#setFrameFromDiagonal%28java.awt.geom.Point2D, java.awt.geom.Point2D%29)

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Field Detail

x

public float x

The x coordinate of this Rectangle2D.

Since:

1.2

y

public float y

The y coordinate of this Rectangle2D.

Since:

1.2

width

public float width

The width of this Rectangle2D.

Since:

1.2

height

public float height

The height of this Rectangle2D.

Since:

1.2

Constructor Detail

Rectangle2D.Float

public Rectangle2D.Float()

Constructs a new Rectangle2D, initialized to location (0.0, 0.0) and size (0.0, 0.0).

Since:

1.2

Rectangle2D.Float

public Rectangle2D.Float(float x, float y, float w, float h)

Constructs and initializes a Rectangle2D from the specified float coordinates.

Parameters:

x, y - the coordinates of the upper left corner of the newly constructedRectangle2D

w - the width of the newly constructedRectangle2D

h - the height of the newly constructedRectangle2D

Since:

1.2

Method Detail

getX

public double getX()

Returns the X coordinate of this Rectangle2D in double precision.

Specified by:

[getX](../../../java/awt/geom/RectangularShape.html#getX%28%29) in class [RectangularShape](../../../java/awt/geom/RectangularShape.html "class in java.awt.geom")

Returns:

the X coordinate of this Rectangle2D.

Since:

1.2

getY

public double getY()

Returns the Y coordinate of this Rectangle2D in double precision.

Specified by:

[getY](../../../java/awt/geom/RectangularShape.html#getY%28%29) in class [RectangularShape](../../../java/awt/geom/RectangularShape.html "class in java.awt.geom")

Returns:

the Y coordinate of this Rectangle2D.

Since:

1.2

getWidth

public double getWidth()

Returns the width of this Rectangle2D in double precision.

Specified by:

[getWidth](../../../java/awt/geom/RectangularShape.html#getWidth%28%29) in class [RectangularShape](../../../java/awt/geom/RectangularShape.html "class in java.awt.geom")

Returns:

the width of this Rectangle2D.

Since:

1.2

getHeight

public double getHeight()

Returns the height of this Rectangle2D in double precision.

Specified by:

[getHeight](../../../java/awt/geom/RectangularShape.html#getHeight%28%29) in class [RectangularShape](../../../java/awt/geom/RectangularShape.html "class in java.awt.geom")

Returns:

the height of this Rectangle2D.

Since:

1.2

isEmpty

public boolean isEmpty()

Determines whether or not this Rectangle2D is empty.

Specified by:

[isEmpty](../../../java/awt/geom/RectangularShape.html#isEmpty%28%29) in class [RectangularShape](../../../java/awt/geom/RectangularShape.html "class in java.awt.geom")

Returns:

true if this Rectangle2D is empty; false otherwise.

Since:

1.2

setRect

public void setRect(float x, float y, float w, float h)

Sets the location and size of this Rectangle2D to the specified float values.

Parameters:

x, y - the coordinates to which to set the location of the upper left corner of thisRectangle2D

w - the value to use to set the width of thisRectangle2D

h - the value to use to set the height of thisRectangle2D

Since:

1.2

setRect

public void setRect(double x, double y, double w, double h)

Sets the location and size of this Rectangle2D to the specified double values.

Specified by:

[setRect](../../../java/awt/geom/Rectangle2D.html#setRect%28double, double, double, double%29) in class [Rectangle2D](../../../java/awt/geom/Rectangle2D.html "class in java.awt.geom")

Parameters:

x, y - the coordinates to which to set the location of the upper left corner of thisRectangle2D

w - the value to use to set the width of thisRectangle2D

h - the value to use to set the height of thisRectangle2D

Since:

1.2

setRect

public void setRect(Rectangle2D r)

Sets this Rectangle2D to be the same as the specified Rectangle2D.

Overrides:

[setRect](../../../java/awt/geom/Rectangle2D.html#setRect%28java.awt.geom.Rectangle2D%29) in class [Rectangle2D](../../../java/awt/geom/Rectangle2D.html "class in java.awt.geom")

Parameters:

r - the specified Rectangle2D

Since:

1.2

outcode

public int outcode(double x, double y)

Determines where the specified float coordinates lie with respect to this Rectangle2D. This method computes a binary OR of the appropriate mask values indicating, for each side of this Rectangle2D, whether or not the specified coordinates are on the same side of the edge as the rest of this Rectangle2D.

Specified by:

[outcode](../../../java/awt/geom/Rectangle2D.html#outcode%28double, double%29) in class [Rectangle2D](../../../java/awt/geom/Rectangle2D.html "class in java.awt.geom")

Parameters:

x, y - the specified coordinates

Returns:

the logical OR of all appropriate out codes.

Since:

1.2

getBounds2D

public Rectangle2D getBounds2D()

Returns the high precision bounding box of thisRectangle2D.

Specified by:

[getBounds2D](../../../java/awt/Shape.html#getBounds2D%28%29) in interface [Shape](../../../java/awt/Shape.html "interface in java.awt")

Overrides:

[getBounds2D](../../../java/awt/geom/Rectangle2D.html#getBounds2D%28%29) in class [Rectangle2D](../../../java/awt/geom/Rectangle2D.html "class in java.awt.geom")

Returns:

the bounding box of this Rectangle2D.

Since:

1.2

See Also:

Shape.getBounds()

createIntersection

public Rectangle2D createIntersection(Rectangle2D r)

Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specifiedRectangle2D.

Specified by:

[createIntersection](../../../java/awt/geom/Rectangle2D.html#createIntersection%28java.awt.geom.Rectangle2D%29) in class [Rectangle2D](../../../java/awt/geom/Rectangle2D.html "class in java.awt.geom")

Parameters:

r - the Rectangle2D that is intersected with this Rectangle2D

Returns:

the largest Rectangle2D contained in both the specified Rectangle2D and in this Rectangle2D.

Since:

1.2

createUnion

public Rectangle2D createUnion(Rectangle2D r)

Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.

Specified by:

[createUnion](../../../java/awt/geom/Rectangle2D.html#createUnion%28java.awt.geom.Rectangle2D%29) in class [Rectangle2D](../../../java/awt/geom/Rectangle2D.html "class in java.awt.geom")

Parameters:

r - the Rectangle2D to be combined with this Rectangle2D

Returns:

the smallest Rectangle2D containing both the specified Rectangle2D and this Rectangle2D.

Since:

1.2

toString

public String toString()

Returns the String representation of thisRectangle2D.

Overrides:

[toString](../../../java/lang/Object.html#toString%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

a String representing thisRectangle2D.

Since:

1.2

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.