acm.graphics

Class GLineGroup

java.lang.Object

acm.graphics.GObject

acm.graphics.GLineGroup

All Implemented Interfaces:

GScalable, Serializable, Cloneable, Iterable<GPoint>

public class GLineGroup
extends GObject
implements Iterable<GPoint>

A line group represents a collection of points that form line segments. A line group can be drawn on the screen and looks similar to a collection of GLine objects positioned one after another.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GLineGroup() Creates a new line group that does not contain any points.

Method Summary

Modifier and Type	Method and Description
void	add(double x, double y) Adds a point with the given coordinates to this line group.
void	add(GPoint point) Adds the given point to this line group.
void	clear() Removes all points from this line group.
boolean	contains(double x, double y) Returns true if any of the line segments in this line group touch the given point.
GRectangle	getBounds() Returns a bounding rectangle that tightly contains this line group.
boolean	isEmpty() Returns true if there are no points in this line group.
Iterator<GPoint>	iterator() Returns an Iterator for examining the points in this line group.
protected void	paint2d(Graphics2D g) Paints the group of lines on the screen.
String	paramString() Returns a string indicating the parameters of this object.
void	remove(double x, double y) Removes the given point from this line group, if it is part of the line group.
void	remove(GPoint point) Removes the given point from this line group, if it is part of the line group.
void	setLocation(double x, double y) Sets the line group's top/left corner to the given x/y pair.
int	size() Returns the number of points that have been added to the line group.
void	translate(double dx, double dy) Shifts every point in this line group by the given amounts.

Methods inherited from class acm.graphics.GObject

addActionListener, addMouseListener, addMouseMotionListener, areMouseListenersEnabled, clone, colorName, colorName, colorNameFriendly, contains, createTransformedGraphics, fireActionEvent, fireActionEvent, fireMouseListeners, getBottomY, getCenterLocation, getCenterX, getCenterY, getColor, getComponent, getHeight, getLineWidth, getLocation, getMatrix, getObjectColor, getParent, getRightX, getSize, getWidth, getX, getY, intersects, isAntiAliasing, isVisible, move, movePolar, paint, pause, removeActionListener, removeMouseListener, removeMouseMotionListener, repaint, rotate, scale, scale, sendBackward, sendForward, sendToBack, sendToFront, setAntiAliasing, setBottomY, setCenterLocation, setCenterLocation, setCenterX, setCenterY, setColor, setLineWidth, setLocation, setParent, setRightX, setVisible, setX, setY, start, start, toString, updateEnabledList

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GLineGroup

public GLineGroup()

Creates a new line group that does not contain any points.

Method Detail

add

public void add(double x,
                double y)

Adds a point with the given coordinates to this line group.

add

public void add(GPoint point)

Adds the given point to this line group.

Parameters:

point - the point to add

clear

public void clear()

Removes all points from this line group.

contains

public boolean contains(double x,
                        double y)

Returns true if any of the line segments in this line group touch the given point.

Overrides:

contains in class GObject

Parameters:

x - The x-coordinate of the point being tested

y - The y-coordinate of the point being tested

Returns:

true if the point (x, y) is inside the object, and false otherwise

getBounds

public GRectangle getBounds()

Returns a bounding rectangle that tightly contains this line group. The rectangle's min x/y are the minimum x/y values of any point in the line group, and the rectangle's max x/y are the maximum x/y values of any point in the line group.

Specified by:

getBounds in class GObject

Returns:

The bounding box for this object

isEmpty

public boolean isEmpty()

Returns true if there are no points in this line group.

iterator

public Iterator<GPoint> iterator()

Returns an Iterator for examining the points in this line group.

Specified by:

iterator in interface Iterable<GPoint>

paint2d

protected void paint2d(Graphics2D g)

Paints the group of lines on the screen.

Specified by:

paint2d in class GObject

Parameters:

g - The graphics context into which the painting is done

paramString

public String paramString()

Returns a string indicating the parameters of this object.

Overrides:

paramString in class GObject

Noshow:

remove

public void remove(double x,
                   double y)

Removes the given point from this line group, if it is part of the line group.

remove

public void remove(GPoint point)

Removes the given point from this line group, if it is part of the line group.

setLocation

public void setLocation(double x,
                        double y)

Sets the line group's top/left corner to the given x/y pair. Initially every line group has a top/left corner at (0, 0), regardless of any points that may have been added to it.

Overrides:

setLocation in class GObject

Parameters:

x - The new x-coordinate for the object

y - The new y-coordinate for the object

size

public int size()

Returns the number of points that have been added to the line group.

Returns:

translate

public void translate(double dx,
                      double dy)

Shifts every point in this line group by the given amounts.