eve.ui.game

Class AniImage

java.lang.Object

eve.fx.ImageObject

eve.fx.Drawing

eve.fx.AnimatedDrawing

eve.ui.game.AniImage

All Implemented Interfaces:

Drawable, IImage, ImageMaker, OnScreenImage, ImageData

public class AniImage
extends AnimatedDrawing

Author:

Michael L Brereton

Field Summary

Fields

Modifier and Type	Field and Description
Rect	limits Gets the bounds of the hot area.
Point	relativeToOrigin

Fields inherited from class eve.fx.Drawing

AlwaysOnTop, CompletelyIn, freeImageWithDrawing, HasBorder, HasChanged, HasMoved, hotArea, hotPolygon, image, InUse, IsAnimated, IsEmpty, IsInvisible, IsLocked, IsMoveable, IsNotHot, IsNotStill, IsPrepared, IsPreparing, KeepOnScreen, lastDrawn, location, MouseMustBeOver, properties, RelativeToOrigin

Fields inherited from class eve.fx.ImageObject

background, height, width

Fields inherited from interface eve.sys.ImageData

CREATE_OPTION_DONT_SCALE_UP, CREATE_OPTION_IGNORE_ALPHA, CREATE_OPTION_KEEP_ASPECT_RATIO, CREATE_OPTION_ROUGH_SCALING, SCAN_LINE_BYTE_ARRAY, SCAN_LINE_INT_ARRAY, TYPE_ARGB, TYPE_GRAY_SCALE_16, TYPE_GRAY_SCALE_2, TYPE_GRAY_SCALE_256, TYPE_GRAY_SCALE_4, TYPE_INDEXED_16, TYPE_INDEXED_2, TYPE_INDEXED_256, TYPE_INDEXED_4, TYPE_MASK, TYPE_MONO, TYPE_RGB, TYPE_UNKNOWN

Fields inherited from interface eve.fx.Drawable

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
AniImage()
AniImage(ImageData image)
AniImage(ImageData image, Object maskObject)
AniImage(String imageName)
AniImage(String imageName, Object maskObject)

Method Summary

Modifier and Type	Method and Description
ImageMover	animateMoveTo(int destinationX, int destinationY, int timeToMoveInMillis) Move this AniImage to a new location, moving it on screen within a certain time period.
boolean	canGo(Point where)
void	change(IImage newImage) Changes the image.
void	changeBounds(int x, int y, int width, int height) Change any aspect of the bounds of the image.
void	changed() Marks the image as having been changed in some way.
Mosaic	getMosaic()
Rect	getMovedBounds()
Object	getNew()
boolean	isCompletelyWithin(AniImage other) Returns if this AniImage is completely within the other AniImage.
boolean	isDraggedOver(AniImage draggingOver, Point mouseLocation)
boolean	isIn(Point p)
boolean	isTouching(AniImage other) Returns if this AniImage is touching the other AniImage.
boolean	isWithin(AniImage other) Returns if this AniImage is "within" the other AniImage - where "within" is "touching" if CompletelyIn property is not set, otherwise it is "isCompletelyWithin".
void	move(int x, int y) Moves the image.
void	resize(int width, int height) Resize the image.
void	setLocation(int x, int y) This resets the location of the image.
void	translate(int dx, int dy) Translates the image.
void	updated() Marks the image as not having been changed.

Methods inherited from class eve.fx.AnimatedDrawing

changeRefresher, getRefresher, newRefresher, refresh, refresh, setRefresher, startAnimate, stopAnimate

Methods inherited from class eve.fx.Drawing

compareTo, copyFrom, doDraw, draw, draw, drawBorder, drawn, free, getBackground, getCopy, getDim, getHotArea, getImage, getImageScanLines, getLocation, getPixels, getSize, getUnusedColor, isWriteableImage, onHotArea, setHotAreaInImage, setImage, setImageScanLines, setPixels, setRect, setSize, usesAlpha

Methods inherited from class eve.fx.ImageObject

createImageFor, draw, draw, freeImage, getCompatibleImagePoints, getDPI, getHeight, getImageColorTable, getImageData, getImageHeight, getImageScanLineLength, getImageScanLineType, getImageType, getImageWidth, getNativeDrawable, getPixelsUsingScanLines, getScanLinesUsingPixels, getWidth, isReadableImage, scanLinesComplete, setPixelsUsingScanLines, setScanLinePixels, setScanLinesUsingPixels

Methods inherited from class java.lang.Object

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

Methods inherited from interface eve.fx.IImage

getBackground, usesAlpha

Methods inherited from interface eve.sys.ImageData

freeImage, getImageColorTable, getImageHeight, getImageScanLineLength, getImageScanLines, getImageScanLineType, getImageType, getImageWidth, getPixels, isReadableImage, isWriteableImage, setImageScanLines, setPixels

Methods inherited from interface eve.fx.Drawable

draw, draw, draw, free, getHeight, getWidth

Field Detail

limits

public Rect limits

Gets the bounds of the hot area.

relativeToOrigin

public Point relativeToOrigin

Constructor Detail

AniImage

public AniImage()

AniImage

public AniImage(String imageName)

Parameters:

imageName -

maskImageName -

AniImage

public AniImage(ImageData image)

AniImage

public AniImage(String imageName,
                Object maskObject)

Parameters:

imageName -

maskImageName -

AniImage

public AniImage(ImageData image,
                Object maskObject)

Parameters:

image -

background -

Method Detail

getNew

public Object getNew()

Overrides:

getNew in class Drawing

canGo

public boolean canGo(Point where)

isTouching

public boolean isTouching(AniImage other)

Returns if this AniImage is touching the other AniImage.

isCompletelyWithin

public final boolean isCompletelyWithin(AniImage other)

Returns if this AniImage is completely within the other AniImage.

isWithin

public final boolean isWithin(AniImage other)

Returns if this AniImage is "within" the other AniImage - where "within" is "touching" if CompletelyIn property is not set, otherwise it is "isCompletelyWithin".

isIn

public final boolean isIn(Point p)

isDraggedOver

public final boolean isDraggedOver(AniImage draggingOver,
                                   Point mouseLocation)

changed

public void changed()

Marks the image as having been changed in some way. This will cause the image to be refreshed when calling updateImage()/updateImages()

updated

public void updated()

Marks the image as not having been changed.

move

public void move(int x,
                 int y)

Moves the image. If the new location is different to the current location then the HasMoved bit in properties will be set. It will NOT clear this bit if the image actually has not moved. This bit must be cleared manually.

change

public void change(IImage newImage)

Changes the image. If it has changed then HasChanged will be set in the properties. If it has not changed there is no effect on this bit.

resize

public void resize(int width,
                   int height)

Resize the image. Do not do this while the image is being displayed. It should be used before adding the image to the mosaic if for example the image is a buffer which is larger than actually needed.

changeBounds

public void changeBounds(int x,
                         int y,
                         int width,
                         int height)

Change any aspect of the bounds of the image. The next time refresh() is called the area where the image was and the area where it is now will be refreshed.

Parameters:

x -

y -

width -

height -

translate

public void translate(int dx,
                      int dy)

Translates the image. The variable previous will hold a list of the locations of the image before it was moved. If the new location is different to the current location then the HasMoved bit in properties will be set. It will NOT clear this bit if the image actually has not moved. This bit must be cleared manually.

setLocation

public void setLocation(int x,
                        int y)

This resets the location of the image. The HasMoved bit in properties will be cleared.

Overrides:

setLocation in class Drawing

getMovedBounds

public Rect getMovedBounds()

getMosaic

public Mosaic getMosaic()

animateMoveTo

public ImageMover animateMoveTo(int destinationX,
                                int destinationY,
                                int timeToMoveInMillis)

Move this AniImage to a new location, moving it on screen within a certain time period. This returns an ImageMover which is a Task object (an asynchronous task). You must call startTask() on it to start the move and you can call waitUntilStopped() on the returned Handle to wait until the move is complete. You can also call stop() on the Handle to abort the move and there are other options you can change as well.

Parameters:

destinationX - The destination X position.

destinationY - The destination Y position.

timeToMoveInMillis - How long to take to move it in milliseconds.

Returns:

An ImageMover object which you must call start() on