com.codename1.ui.geom

Interface Shape

All Known Implementing Classes:

GeneralPath, Rectangle, Rectangle2D

public interface Shape

An interface that can be implemented by any class that wants to be drawable as a shape.

Shape can also be used to clip an area e.g.:

Author:

Steve Hannah

See Also:

for a concrete implementation of Shape., Graphics.drawShape(com.codename1.ui.geom.Shape, com.codename1.ui.Stroke), Graphics.fillShape(com.codename1.ui.geom.Shape)

Method Summary

Modifier and Type	Method and Description
boolean	contains(int x, int y) Checks if the shape contains the given point.
Rectangle	getBounds() Returns the bounding rectangle for the shape.
float[]	getBounds2D() Gets the bounds of the shape as a 4-element array representing the (x,y,width,height) tuple.
PathIterator	getPathIterator() Gets an iterator to walk all of the path segments of the shape.
PathIterator	getPathIterator(Transform transform) Gets an iterator where all points are transformed by the provided transform.
Shape	intersection(Rectangle rect) Returns the shape formed by the intersection of this shape and the provided rectangle.
boolean	isRectangle() Checks if this shape is a rectangle.

Method Detail

getPathIterator

PathIterator getPathIterator()

Gets an iterator to walk all of the path segments of the shape.

Returns:

A PathIterator that can iterate over the path segments of the shape.

getPathIterator

PathIterator getPathIterator(Transform transform)

Gets an iterator where all points are transformed by the provided transform.

Note: If Transform.isSupported() is false, then using this iterator will throw a Runtime Exception.

Parameters:

transform -

Returns:

A PathIterator where points are transformed by the provided transform.

getBounds

Rectangle getBounds()

Returns the bounding rectangle for the shape. This should be the smallest rectangle such that the all path segments in the shape are contained within it.

Returns:

A Rectangle that comprises the bounds of the shape.

getBounds2D

float[] getBounds2D()

Gets the bounds of the shape as a 4-element array representing the (x,y,width,height) tuple.

Returns:

[x, y, width, height] bounds of this shape.

isRectangle

boolean isRectangle()

Checks if this shape is a rectangle. A Shape is a rectangle if it is a closed quadrilateral composed of two vertical lines and two horizontal lines. If all points have integer coordinates, and this returns true, then getBounds() should return an equivalent rectangle to the shape itself.

Returns:

True if shape is a rectangle.

contains

boolean contains(int x,
                 int y)

Checks if the shape contains the given point.

Parameters:

x - The x-coordinate of the point to test.

y - The y-coordinate of the point to test.

Returns:

True if (x, y) is inside the shape.

intersection

Shape intersection(Rectangle rect)

Returns the shape formed by the intersection of this shape and the provided rectangle.

Parameters:

rect - A rectangle with which to form an intersection.

Returns:

The shape formed by intersecting the current shape with the provided rectangle.