sk.upjs.jpaz2

Class ImageShape

java.lang.Object

sk.upjs.jpaz2.ImageShape

All Implemented Interfaces:

TurtleShape

Direct Known Subclasses:

ImageTurtleShape

public class ImageShape
extends Object
implements TurtleShape

The painter of a turtle shape based on an image.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageShape.Builder The builder of ImageShape class instances.

Constructor Summary

Constructors

Constructor and Description
ImageShape(File imageFile) Constructs a turtle shape from an image file.
ImageShape(File imageFile, double xCenter, double yCenter) Constructs a turtle shape from an image file.
ImageShape(String imageLocation) Constructs a turtle shape from image at a specified location.
ImageShape(String imageLocation, double xCenter, double yCenter) Constructs a turtle shape from image at a specified location.
ImageShape(String packageName, String fileName) Constructs a turtle shape from an image resource located in specified package and a given filename.The center of the shape is set to the center of the image.
ImageShape(URL imageURL) Constructs a turtle shape from an image.
ImageShape(URL imageURL, double xCenter, double yCenter) Constructs a turtle shape from an image.

Method Summary

Modifier and Type	Method and Description
Point2D	getCenter() Returns coordinates of the shape center.
int	getFrameCount() Returns immutable number of animation frames defined for each view of the shape.
long	getFrameDuration() Returns immutable animation delay (time period between animation frames) in milliseconds.
int	getHeight() Returns the height of each frame in this shape.
int	getViewCount() Returns immutable number of views provided by the shape.
int	getWidth() Returns the width of each frame in this shape.
double	getXCenter() Returns the X-coordinate of the shape center.
double	getYCenter() Returns the Y-coordinate of the shape center.
boolean	isPointOfShape(Turtle t, double x, double y) Returns whether a given point is internal point of current turtle's shape.
void	paintTurtle(Turtle t, Graphics2D g) Paints shape of a turtle to a given graphics.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageShape

public ImageShape(URL imageURL,
                  double xCenter,
                  double yCenter)

Constructs a turtle shape from an image.

Parameters:

imageURL - the URL of an image with the shape

xCenter - the X-coordinate of the shape center

yCenter - the Y-coordinate of the shape center

ImageShape

public ImageShape(URL imageURL)

Constructs a turtle shape from an image. The center of the shape is set to the center of the image.

Parameters:

imageURL - the URL of an image with the shape

ImageShape

public ImageShape(File imageFile,
                  double xCenter,
                  double yCenter)

Constructs a turtle shape from an image file.

Parameters:

imageFile - file with image for the shape

xCenter - the X-coordinate of the shape center

yCenter - the Y-coordinate of the shape center

ImageShape

public ImageShape(File imageFile)

Constructs a turtle shape from an image file. The center of the shape is set to the center of the image.

Parameters:

imageFile - file with the image for the shape

ImageShape

public ImageShape(String imageLocation,
                  double xCenter,
                  double yCenter)

Constructs a turtle shape from image at a specified location. If location string starts with /, it is first considered to be a resource location. If resource localization failed, location string is considered as a file name.

Parameters:

imageLocation - the string with location of an image (file or resource)

xCenter - the X-coordinate of the shape center

yCenter - the Y-coordinate of the shape center

ImageShape

public ImageShape(String imageLocation)

Constructs a turtle shape from image at a specified location. If location string starts with /, it is first considered to be a resource location. If resource localization failed, location string is considered as a file name. The center of the shape is set to the center of the image.

Parameters:

imageLocation - the string with location of an image (file or resource)

ImageShape

public ImageShape(String packageName,
                  String fileName)

Constructs a turtle shape from an image resource located in specified package and a given filename.The center of the shape is set to the center of the image.

Parameters:

packageName - the package where resource file is searched

fileName - the filename (in the package given by parameter packageName)

Method Detail

getWidth

public int getWidth()

Returns the width of each frame in this shape.

Returns:

the width of the shape.

getHeight

public int getHeight()

Returns the height of each frame in this shape.

Returns:

the height of the shape.

getCenter

public Point2D getCenter()

Returns coordinates of the shape center.

Returns:

coordinates of the shape center.

getXCenter

public double getXCenter()

Returns the X-coordinate of the shape center.

Returns:

the X-coordinate of the shape center.

getYCenter

public double getYCenter()

Returns the Y-coordinate of the shape center.

Returns:

the Y-coordinate of the shape center.

paintTurtle

public void paintTurtle(Turtle t,
                        Graphics2D g)

Paints shape of a turtle to a given graphics.

Specified by:

paintTurtle in interface TurtleShape

Parameters:

t - the turtle whose shape is drawn.

g - the graphic where the shape is drawn.

getViewCount

public int getViewCount()

Description copied from interface: TurtleShape

Returns immutable number of views provided by the shape. A shape can provided more views on the shape, e.g. depending on current direction of the turtle. Each shape must define at least one view.

Specified by:

getViewCount in interface TurtleShape

Returns:

the number of views on the shape

getFrameCount

public int getFrameCount()

Description copied from interface: TurtleShape

Returns immutable number of animation frames defined for each view of the shape. A view on a shape can consist of several frames. They are used to animate shapes. All views have the same number of frames. Each view must provide at least one animation frame.

Specified by:

getFrameCount in interface TurtleShape

Returns:

the number of animation frames

isPointOfShape

public boolean isPointOfShape(Turtle t,
                              double x,
                              double y)

Description copied from interface: TurtleShape

Returns whether a given point is internal point of current turtle's shape.

Specified by:

isPointOfShape in interface TurtleShape

Parameters:

t - the turtle whose shape is considered

x - the x coordinate of point

y - the y coordinate of point

Returns:

true, if the point [x, y] is an internal point of turtle's shape, false otherwise

getFrameDuration

public long getFrameDuration()

Description copied from interface: TurtleShape

Returns immutable animation delay (time period between animation frames) in milliseconds.

Specified by:

getFrameDuration in interface TurtleShape

Returns:

preferred animation delay in milliseconds