princeton.introcs

Class Draw

java.lang.Object

princeton.introcs.Draw

All Implemented Interfaces:

ActionListener, KeyListener, MouseListener, MouseMotionListener, EventListener

public final class Draw
extends Object
implements ActionListener, MouseListener, MouseMotionListener, KeyListener

Draw. This class provides a basic capability for creating drawings with your programs. It uses a simple graphics model that allows you to create drawings consisting of points, lines, and curves in a window on your computer and to save the drawings to a file. This is the object-oriented version of standard draw; it supports multiple indepedent drawing windows.

For additional documentation, see Section 3.1 of Introduction to Programming in Java: An Interdisciplinary Approach by Robert Sedgewick and Kevin Wayne.

Field Summary

Fields

Modifier and Type	Field and Description
static Color	BLACK
static Color	BLUE
static Color	BOOK_BLUE Shade of blue used in Introduction to Programming in Java.
static Color	BOOK_RED Shade of red used in Algorithms 4th edition.
static Color	CYAN
static Color	DARK_GRAY
static Color	GRAY
static Color	GREEN
static Color	LIGHT_GRAY
static Color	MAGENTA
static Color	ORANGE
static Color	PINK
static Color	RED
static Color	WHITE
static Color	YELLOW

Constructor Summary

Constructors

Constructor and Description
Draw() Create an empty drawing object.
Draw(String name) Create an empty drawing object with the given name.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) This method cannot be called directly.
void	arc(double x, double y, double r, double angle1, double angle2) Draw an arc of radius r, centered on (x, y), from angle1 to angle2 (in degrees).
void	circle(double x, double y, double r) Draw a circle of radius r, centered on (x, y).
void	clear() Clear the screen to the default color (white).
void	clear(Color color) Clear the screen to the given color.
void	ellipse(double x, double y, double semiMajorAxis, double semiMinorAxis) Draw an ellipse with given semimajor and semiminor axes, centered on (x, y).
void	filledCircle(double x, double y, double r) Draw filled circle of radius r, centered on (x, y).
void	filledEllipse(double x, double y, double semiMajorAxis, double semiMinorAxis) Draw an ellipse with given semimajor and semiminor axes, centered on (x, y).
void	filledPolygon(double[] x, double[] y) Draw a filled polygon with the given (x[i], y[i]) coordinates.
void	filledRectangle(double x, double y, double halfWidth, double halfHeight) Draw a filled rectangle of given half width and half height, centered on (x, y).
void	filledSquare(double x, double y, double r) Draw a filled square of side length 2r, centered on (x, y).
Font	getFont() Get the current font.
Color	getPenColor() Get the current pen color.
double	getPenRadius() Get the current pen radius.
boolean	hasNextKeyTyped() Has the user typed a key?
void	keyPressed(KeyEvent e) This method cannot be called directly.
void	keyReleased(KeyEvent e) This method cannot be called directly.
void	keyTyped(KeyEvent e) This method cannot be called directly.
void	line(double x0, double y0, double x1, double y1) Draw a line from (x0, y0) to (x1, y1).
static void	main(String[] args) Test client.
void	mouseClicked(MouseEvent e) This method cannot be called directly.
void	mouseDragged(MouseEvent e) This method cannot be called directly.
void	mouseEntered(MouseEvent e) This method cannot be called directly.
void	mouseExited(MouseEvent e) This method cannot be called directly.
void	mouseMoved(MouseEvent e) This method cannot be called directly.
boolean	mousePressed() Is the mouse being pressed?
void	mousePressed(MouseEvent e) This method cannot be called directly.
void	mouseReleased(MouseEvent e) This method cannot be called directly.
double	mouseX() What is the x-coordinate of the mouse?
double	mouseY() What is the y-coordinate of the mouse?
char	nextKeyTyped() What is the next key that was typed by the user?
void	picture(double x, double y, String s) Draw picture (gif, jpg, or png) centered on (x, y).
void	picture(double x, double y, String s, double degrees) Draw picture (gif, jpg, or png) centered on (x, y), rotated given number of degrees
void	picture(double x, double y, String s, double w, double h) Draw picture (gif, jpg, or png) centered on (x, y), rescaled to w-by-h.
void	picture(double x, double y, String s, double w, double h, double degrees) Draw picture (gif, jpg, or png) centered on (x, y), rotated given number of degrees, rescaled to w-by-h.
void	point(double x, double y) Draw a point at (x, y).
void	polygon(double[] x, double[] y) Draw a polygon with the given (x[i], y[i]) coordinates.
void	rectangle(double x, double y, double halfWidth, double halfHeight) Draw a rectangle of given half width and half height, centered on (x, y).
void	save(String filename) Save to file - suffix must be png, jpg, or gif.
void	setCanvasSize(int w, int h) Set the window size to w-by-h pixels.
void	setFont() Set the font to the default font (sans serif, 16 point).
void	setFont(Font f) Set the font to the given value.
void	setLocationOnScreen(int x, int y) Set the upper-left hand corner of the drawing window to be (x, y), where (0, 0) is upper left.
void	setPenColor() Set the pen color to the default color (black).
void	setPenColor(Color color) Set the pen color to the given color.
void	setPenRadius() Set the pen size to the default (.002).
void	setPenRadius(double r) Set the radius of the pen to the given size.
void	setXscale() Set the x-scale to be the default (between 0.0 and 1.0).
void	setXscale(double min, double max) Set the x-scale (a 10% border is added to the values)
void	setYscale() Set the y-scale to be the default (between 0.0 and 1.0).
void	setYscale(double min, double max) Set the y-scale (a 10% border is added to the values).
void	show() Display on-screen and turn off animation mode: subsequent calls to drawing methods such as line(), circle(), and square() will be displayed on screen when called.
void	show(int t) Display on screen, pause for t milliseconds, and turn on animation mode: subsequent calls to drawing methods such as line(), circle(), and square() will not be displayed on screen until the next call to show().
void	square(double x, double y, double r) Draw a square of side length 2r, centered on (x, y).
void	text(double x, double y, String s) Write the given text string in the current font, centered on (x, y).
void	text(double x, double y, String s, double degrees) Write the given text string in the current font, centered on (x, y) and rotated by the specified number of degrees
void	textLeft(double x, double y, String s) Write the given text string in the current font, left-aligned at (x, y).

Methods inherited from class java.lang.Object

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

Field Detail

BLACK

public static final Color BLACK

BLUE

public static final Color BLUE

CYAN

public static final Color CYAN

DARK_GRAY

public static final Color DARK_GRAY

GRAY

public static final Color GRAY

GREEN

public static final Color GREEN

LIGHT_GRAY

public static final Color LIGHT_GRAY

MAGENTA

public static final Color MAGENTA

ORANGE

public static final Color ORANGE

PINK

public static final Color PINK

RED

public static final Color RED

WHITE

public static final Color WHITE

YELLOW

public static final Color YELLOW

BOOK_BLUE

public static final Color BOOK_BLUE

Shade of blue used in Introduction to Programming in Java. The RGB values are (9, 90, 266).

BOOK_RED

public static final Color BOOK_RED

Shade of red used in Algorithms 4th edition. The RGB values are (173, 32, 24).

Constructor Detail

Draw

public Draw(String name)

Create an empty drawing object with the given name.

Parameters:

name - the title of the drawing window.

Draw

public Draw()

Create an empty drawing object.

Method Detail

setLocationOnScreen

public void setLocationOnScreen(int x,
                       int y)

Set the upper-left hand corner of the drawing window to be (x, y), where (0, 0) is upper left.

Parameters:

x - the number of pixels from the left

y - the number of pixels from the top

Throws:

a - RunTimeException if the width or height is 0 or negative

setCanvasSize

public void setCanvasSize(int w,
                 int h)

Set the window size to w-by-h pixels.

Parameters:

w - the width as a number of pixels

h - the height as a number of pixels

Throws:

a - RunTimeException if the width or height is 0 or negative

setXscale

public void setXscale()

Set the x-scale to be the default (between 0.0 and 1.0).

setYscale

public void setYscale()

Set the y-scale to be the default (between 0.0 and 1.0).

setXscale

public void setXscale(double min,
             double max)

Set the x-scale (a 10% border is added to the values)

Parameters:

min - the minimum value of the x-scale

max - the maximum value of the x-scale

setYscale

public void setYscale(double min,
             double max)

Set the y-scale (a 10% border is added to the values).

Parameters:

min - the minimum value of the y-scale

max - the maximum value of the y-scale

clear

public void clear()

Clear the screen to the default color (white).

clear

public void clear(Color color)

Clear the screen to the given color.

Parameters:

color - the Color to make the background

getPenRadius

public double getPenRadius()

Get the current pen radius.

setPenRadius

public void setPenRadius()

Set the pen size to the default (.002).

setPenRadius

public void setPenRadius(double r)

Set the radius of the pen to the given size.

Parameters:

r - the radius of the pen

Throws:

RuntimeException - if r is negative

getPenColor

public Color getPenColor()

Get the current pen color.

setPenColor

public void setPenColor()

Set the pen color to the default color (black).

setPenColor

public void setPenColor(Color color)

Set the pen color to the given color.

Parameters:

color - the Color to make the pen

getFont

public Font getFont()

Get the current font.

setFont

public void setFont()

Set the font to the default font (sans serif, 16 point).

setFont

public void setFont(Font f)

Set the font to the given value.

Parameters:

f - the font to make text

line

public void line(double x0,
        double y0,
        double x1,
        double y1)

Draw a line from (x0, y0) to (x1, y1).

Parameters:

x0 - the x-coordinate of the starting point

y0 - the y-coordinate of the starting point

x1 - the x-coordinate of the destination point

y1 - the y-coordinate of the destination point

point

public void point(double x,
         double y)

Draw a point at (x, y).

Parameters:

x - the x-coordinate of the point

y - the y-coordinate of the point

circle

public void circle(double x,
          double y,
          double r)

Draw a circle of radius r, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the circle

y - the y-coordinate of the center of the circle

r - the radius of the circle

Throws:

RuntimeException - if the radius of the circle is negative

filledCircle

public void filledCircle(double x,
                double y,
                double r)

Draw filled circle of radius r, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the circle

y - the y-coordinate of the center of the circle

r - the radius of the circle

Throws:

RuntimeException - if the radius of the circle is negative

ellipse

public void ellipse(double x,
           double y,
           double semiMajorAxis,
           double semiMinorAxis)

Draw an ellipse with given semimajor and semiminor axes, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the ellipse

y - the y-coordinate of the center of the ellipse

semiMajorAxis - is the semimajor axis of the ellipse

semiMinorAxis - is the semiminor axis of the ellipse

Throws:

RuntimeException - if either of the axes are negative

filledEllipse

public void filledEllipse(double x,
                 double y,
                 double semiMajorAxis,
                 double semiMinorAxis)

Draw an ellipse with given semimajor and semiminor axes, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the ellipse

y - the y-coordinate of the center of the ellipse

semiMajorAxis - is the semimajor axis of the ellipse

semiMinorAxis - is the semiminor axis of the ellipse

Throws:

RuntimeException - if either of the axes are negative

arc

public void arc(double x,
       double y,
       double r,
       double angle1,
       double angle2)

Draw an arc of radius r, centered on (x, y), from angle1 to angle2 (in degrees).

Parameters:

x - the x-coordinate of the center of the circle

y - the y-coordinate of the center of the circle

r - the radius of the circle

angle1 - the starting angle. 0 would mean an arc beginning at 3 o'clock.

angle2 - the angle at the end of the arc. For example, if you want a 90 degree arc, then angle2 should be angle1 + 90.

Throws:

RuntimeException - if the radius of the circle is negative

square

public void square(double x,
          double y,
          double r)

Draw a square of side length 2r, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the square

y - the y-coordinate of the center of the square

r - radius is half the length of any side of the square

Throws:

RuntimeException - if r is negative

filledSquare

public void filledSquare(double x,
                double y,
                double r)

Draw a filled square of side length 2r, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the square

y - the y-coordinate of the center of the square

r - radius is half the length of any side of the square

Throws:

RuntimeException - if r is negative

rectangle

public void rectangle(double x,
             double y,
             double halfWidth,
             double halfHeight)

Draw a rectangle of given half width and half height, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the rectangle

y - the y-coordinate of the center of the rectangle

halfWidth - is half the width of the rectangle

halfHeight - is half the height of the rectangle

Throws:

RuntimeException - if halfWidth or halfHeight is negative

filledRectangle

public void filledRectangle(double x,
                   double y,
                   double halfWidth,
                   double halfHeight)

Draw a filled rectangle of given half width and half height, centered on (x, y).

Parameters:

x - the x-coordinate of the center of the rectangle

y - the y-coordinate of the center of the rectangle

halfWidth - is half the width of the rectangle

halfHeight - is half the height of the rectangle

Throws:

RuntimeException - if halfWidth or halfHeight is negative

polygon

public void polygon(double[] x,
           double[] y)

Draw a polygon with the given (x[i], y[i]) coordinates.

Parameters:

x - an array of all the x-coordindates of the polygon

y - an array of all the y-coordindates of the polygon

filledPolygon

public void filledPolygon(double[] x,
                 double[] y)

Draw a filled polygon with the given (x[i], y[i]) coordinates.

Parameters:

x - an array of all the x-coordindates of the polygon

y - an array of all the y-coordindates of the polygon

picture

public void picture(double x,
           double y,
           String s)

Draw picture (gif, jpg, or png) centered on (x, y).

Parameters:

x - the center x-coordinate of the image

y - the center y-coordinate of the image

s - the name of the image/picture, e.g., "ball.gif"

Throws:

RuntimeException - if the image is corrupt

picture

public void picture(double x,
           double y,
           String s,
           double degrees)

Draw picture (gif, jpg, or png) centered on (x, y), rotated given number of degrees

Parameters:

x - the center x-coordinate of the image

y - the center y-coordinate of the image

s - the name of the image/picture, e.g., "ball.gif"

degrees - is the number of degrees to rotate counterclockwise

Throws:

RuntimeException - if the image is corrupt

picture

public void picture(double x,
           double y,
           String s,
           double w,
           double h)

Draw picture (gif, jpg, or png) centered on (x, y), rescaled to w-by-h.

Parameters:

x - the center x coordinate of the image

y - the center y coordinate of the image

s - the name of the image/picture, e.g., "ball.gif"

w - the width of the image

h - the height of the image

Throws:

RuntimeException - if the image is corrupt

picture

public void picture(double x,
           double y,
           String s,
           double w,
           double h,
           double degrees)

Draw picture (gif, jpg, or png) centered on (x, y), rotated given number of degrees, rescaled to w-by-h.

Parameters:

x - the center x-coordinate of the image

y - the center y-coordinate of the image

s - the name of the image/picture, e.g., "ball.gif"

w - the width of the image

h - the height of the image

degrees - is the number of degrees to rotate counterclockwise

Throws:

RuntimeException - if the image is corrupt

text

public void text(double x,
        double y,
        String s)

Write the given text string in the current font, centered on (x, y).

Parameters:

x - the center x-coordinate of the text

y - the center y-coordinate of the text

s - the text

text

public void text(double x,
        double y,
        String s,
        double degrees)

Write the given text string in the current font, centered on (x, y) and rotated by the specified number of degrees

Parameters:

x - the center x-coordinate of the text

y - the center y-coordinate of the text

s - the text

degrees - is the number of degrees to rotate counterclockwise

textLeft

public void textLeft(double x,
            double y,
            String s)

Write the given text string in the current font, left-aligned at (x, y).

Parameters:

x - the x-coordinate of the text

y - the y-coordinate of the text

s - the text

show

public void show(int t)

Display on screen, pause for t milliseconds, and turn on animation mode: subsequent calls to drawing methods such as line(), circle(), and square() will not be displayed on screen until the next call to show(). This is useful for producing animations (clear the screen, draw a bunch of shapes, display on screen for a fixed amount of time, and repeat). It also speeds up drawing a huge number of shapes (call show(0) to defer drawing on screen, draw the shapes, and call show(0) to display them all on screen at once).

Parameters:

t - number of milliseconds

show

public void show()

Display on-screen and turn off animation mode: subsequent calls to drawing methods such as line(), circle(), and square() will be displayed on screen when called. This is the default.

save

public void save(String filename)

Save to file - suffix must be png, jpg, or gif.

Parameters:

filename - the name of the file with one of the required suffixes

actionPerformed

public void actionPerformed(ActionEvent e)

This method cannot be called directly.

Specified by:

actionPerformed in interface ActionListener

mousePressed

public boolean mousePressed()

Is the mouse being pressed?

Returns:

true or false

mouseX

public double mouseX()

What is the x-coordinate of the mouse?

Returns:

the value of the x-coordinate of the mouse

mouseY

public double mouseY()

What is the y-coordinate of the mouse?

Returns:

the value of the y-coordinate of the mouse

mouseClicked

public void mouseClicked(MouseEvent e)

This method cannot be called directly.

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

This method cannot be called directly.

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

This method cannot be called directly.

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

This method cannot be called directly.

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

This method cannot be called directly.

Specified by:

mouseReleased in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

This method cannot be called directly.

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

This method cannot be called directly.

Specified by:

mouseMoved in interface MouseMotionListener

hasNextKeyTyped

public boolean hasNextKeyTyped()

Has the user typed a key?

Returns:

true if the user has typed a key, false otherwise

nextKeyTyped

public char nextKeyTyped()

What is the next key that was typed by the user?

Returns:

the next key typed

keyTyped

public void keyTyped(KeyEvent e)

This method cannot be called directly.

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent e)

This method cannot be called directly.

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

This method cannot be called directly.

Specified by:

keyReleased in interface KeyListener

main

public static void main(String[] args)

Test client.