acm.graphics.G3DRect Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javakarel Show documentation
Show all versions of javakarel Show documentation
This the original Stanford Karel for Java, packaged for Maven. ACM Library is included. See also https://cs.stanford.edu/people/eroberts/karel-the-robot-learns-java.pdf
The newest version!
/*
* @(#)G3DRect.java 1.99.1 08/12/08
*/
// ************************************************************************
// * Copyright (c) 2008 by the Association for Computing Machinery *
// * *
// * The Java Task Force seeks to impose few restrictions on the use of *
// * these packages so that users have as much freedom as possible to *
// * use this software in constructive ways and can make the benefits of *
// * that work available to others. In view of the legal complexities *
// * of software development, however, it is essential for the ACM to *
// * maintain its copyright to guard against attempts by others to *
// * claim ownership rights. The full text of the JTF Software License *
// * is available at the following URL: *
// * *
// * http://www.acm.org/jtf/jtf-software-license.pdf *
// * *
// ************************************************************************
// REVISION HISTORY
//
// -- V2.0 --
// Feature enhancement 26-May-08 (ESR)
// 1. Added support for serialization.
// 2. Revised bounding box calculation to conform to Java standard.
package acm.graphics;
import java.awt.*;
/* Class: G3DRect */
/**
* The G3DRect class is used to represent a rectangle whose
* borders are drawn to create a three-dimensional effect. The
* G3DRect class is a subclass of
* GRect, and therefore
* implements all the methods defined for that class. In addition, the
* G3DRect class supports the following methods:
*
*
* void setRaised(boolean raised)
* Sets the G3DRect to appear
* raised or lowered as specified by the parameter
* boolean isRaised()
* Returns true if this
* G3DRect is raised.
* The appearance of a G3DRect object depends on the system on
* which it is displayed and is typically more effective if the
* G3DRect is filled.
*
*/
public class G3DRect extends GRect {
/* Constructor: G3DRect(width, height) */
/**
* Constructs a new 3D rectangle with the specified width and height,
* positioned at the origin.
*
* Example: G3DRect grect = new G3DRect(width, height);
* @param width The width of the rectangle in pixels
* @param height The height of the rectangle in pixels
*/
public G3DRect(double width, double height) {
this(0, 0, width, height, false);
}
/* Constructor: G3DRect(x, y, width, height) */
/**
* Constructs a new 3D rectangle with the specified bounds.
*
* Example: G3DRect grect = new G3DRect(x, y, width, height);
* @param x The x-coordinate of the upper left corner
* @param y The y-coordinate of the upper left corner
* @param width The width of the rectangle in pixels
* @param height The height of the rectangle in pixels
*/
public G3DRect(double x, double y, double width, double height) {
this(x, y, width, height, false);
}
/* Constructor: G3DRect(x, y, width, height, raised) */
/**
* Constructs a new 3D rectangle with the specified bounds which is
* raised if the final parameter is true.
*
* Example: G3DRect grect = new G3DRect(x, y, width, height, raised);
* @param x The x-coordinate of the upper left corner
* @param y The y-coordinate of the upper left corner
* @param width The width of the rectangle in pixels
* @param height The height of the rectangle in pixels
* @param raised true if this rectangle should appear raised
*/
public G3DRect(double x, double y, double width, double height, boolean raised) {
super(x, y, width, height);
isRaised = raised;
}
/* Method: paint(g) */
/**
* Implements the paint operation for this graphical object. This method
* is not called directly by clients.
*
*/
public void paint(Graphics g) {
Rectangle r = getAWTBounds();
if (isFilled()) {
g.setColor(getFillColor());
g.fill3DRect(r.x, r.y, r.width, r.height, isRaised);
g.setColor(getColor());
}
g.draw3DRect(r.x, r.y, r.width, r.height, isRaised);
}
/* Inherited method: setLocation(x, y) */
/**
* @inherited GObject#void setLocation(double x, double y)
* Sets the location of this object to the point (x, y).
*/
/* Inherited method: setLocation(pt) */
/**
* @inherited GObject#void setLocation(GPoint pt)
* Sets the location of this object to the specified point.
*/
/* Inherited method: getLocation() */
/**
* @inherited GObject#GPoint getLocation()
* Returns the location of this object as a GPoint.
*/
/* Inherited method: getX() */
/**
* @inherited GObject#double getX()
* Returns the x-coordinate of the object.
*/
/* Inherited method: getY() */
/**
* @inherited GObject#double getY()
* Returns the y-coordinate of the object.
*/
/* Inherited method: move(dx, dy) */
/**
* @inherited GObject#void move(double dx, double dy)
* Moves the object on the screen using the displacements dx and dy.
*/
/* Inherited method: movePolar(r, theta) */
/**
* @inherited GObject#void movePolar(double r, double theta)
* Moves the object using displacements given in polar coordinates.
*/
/* Inherited method: scale(sx, sy) */
/**
* @inherited GObject#void scale(double sx, double sy)
* Scales the object on the screen by the scale factors sx and sy.
*/
/* Inherited method: scale(sf) */
/**
* @inherited GObject#void scale(double sf)
* Scales the object on the screen by the scale factor sf, which applies
* in both dimensions.
*/
/* Inherited method: setSize(width, height) */
/**
* @inherited GObject#void setSize(double width, double height)
* Changes the size of this object to the specified width and height.
*/
/* Inherited method: setBounds(size) */
/**
* @inherited GRect#void setBounds(GDimension size)
* Changes the size of this object as specified.
*/
/* Inherited method: getSize() */
/**
* @inherited GObject#GDimension getSize()
* Returns the size of the bounding box for this object.
*/
/* Inherited method: getWidth() */
/**
* @inherited GObject#double getWidth()
* Returns the width of this object, which is defined to be
* the width of the bounding box.
*/
/* Inherited method: getHeight() */
/**
* @inherited GObject#double getHeight()
* Returns the height of this object, which is defined to be
* the height of the bounding box.
*/
/* Inherited method: setBounds(x, y, width, height) */
/**
* @inherited GRect#void setBounds(double x, double y, double width, double height)
* Changes the bounds of this object to the specified parameters.
*/
/* Inherited method: setBounds(bounds) */
/**
* @inherited GRect#void setBounds(GRectangle bounds)
* Changes the bounds of this object as specified.
*/
/* Inherited method: getBounds() */
/**
* @inherited GObject#GRectangle getBounds()
* Returns the bounding box for this object.
*/
/* Inherited method: contains(x, y) */
/**
* @inherited GObject#boolean contains(double x, double y)
* Checks to see whether a point is inside the object.
*/
/* Inherited method: contains(pt) */
/**
* @inherited GObject#boolean contains(GPoint pt)
* Checks to see whether a point is inside the object.
*/
/* Inherited method: sendToFront() */
/**
* @inherited GObject#void sendToFront()
* Moves this object to the front of the display in the z dimension.
*/
/* Inherited method: sendToBack() */
/**
* @inherited GObject#void sendToBack()
* Moves this object to the back of the display in the z dimension.
*/
/* Inherited method: sendForward() */
/**
* @inherited GObject#void sendForward()
* Moves this object one step toward the front in the z dimension.
*/
/* Inherited method: sendBackward() */
/**
* @inherited GObject#void sendBackward()
* Moves this object one step toward the back in the z dimension.
*/
/* Inherited method: setColor(color) */
/**
* @inherited GObject#void setColor(Color color)
* Sets the color used to display this object.
*/
/* Inherited method: getColor() */
/**
* @inherited GObject#Color getColor()
* Returns the color used to display this object.
*/
/* Inherited method: setFillColor(color) */
/**
* @inherited GObject#void setFillColor(Color color)
* Sets the color used to display the filled region of this object.
*/
/* Inherited method: getFillColor() */
/**
* @inherited GObject#Color getFillColor()
* Returns the color used to display the filled region of this object.
*/
/* Inherited method: setFilled(fill) */
/**
* @inherited GObject#void setFilled(boolean fill)
* Sets whether this object is filled.
*/
/* Inherited method: isFilled() */
/**
* @inherited GObject#boolean isFilled()
* Returns whether this object is filled.
*/
/* Inherited method: setVisible(visible) */
/**
* @inherited GObject#void setVisible(boolean visible)
* Sets whether this object is visible.
*/
/* Inherited method: isVisible() */
/**
* @inherited GObject#boolean isVisible()
* Checks to see whether this object is visible.
*/
/* Inherited method: addMouseListener(listener) */
/**
* @inherited GObject#void addMouseListener(MouseListener listener)
* Adds a mouse listener to this graphical object.
*/
/* Inherited method: removeMouseListener(listener) */
/**
* @inherited GObject#void removeMouseListener(MouseListener listener)
* Removes a mouse listener from this graphical object.
*/
/* Inherited method: addMouseMotionListener(listener) */
/**
* @inherited GObject#void addMouseMotionListener(MouseMotionListener listener)
* Adds a mouse motion listener to this graphical object.
*/
/* Inherited method: removeMouseMotionListener(listener) */
/**
* @inherited GObject#void removeMouseMotionListener(MouseMotionListener listener)
* Removes a mouse motion listener from this graphical object.
*/
/* Method: setRaised(raised) */
/**
* Sets whether this object appears raised.
*
* Example: grect.setRaised(raised);
* @param raised true if the object appears raised, false otherwise
*/
public void setRaised(boolean raised) {
isRaised = raised;
}
/* Method: isRaised() */
/**
* Tests whether this object appears raised.
*
* Example: if (grect.isRaised()) . . .
* @return true if the object appears raised, false otherwise
*/
public boolean isRaised() {
return isRaised;
}
/* Private instance variables */
private boolean isRaised;
/* Serial version UID */
/**
* The serialization code for this class. This value should be incremented
* whenever you change the structure of this class in an incompatible way,
* typically by adding a new instance variable.
*/
static final long serialVersionUID = 1L;
}