com.github.brunothg.game.engine.d2.object.sprite

Class SpriteSceneObject

java.lang.Object

com.github.brunothg.game.engine.d2.object.SceneObject

com.github.brunothg.game.engine.d2.object.sprite.SpriteSceneObject

Direct Known Subclasses:

Sprite2DSceneObject

public class SpriteSceneObject
extends SceneObject

Animates a sprite. Every row is treated as a single animation and can be switched.

Author:

Marvin Bruns

Field Summary

Fields inherited from class com.github.brunothg.game.engine.d2.object.SceneObject

ORIGIN_TOP_LEFT

Constructor Summary

Constructors

Constructor and Description
SpriteSceneObject(Sprite sprite, long defaultTime) Create an SpriteSceneObject from a sprite with equal time for every frame.
SpriteSceneObject(Sprite sprite, long defaultTime, long[][] time) Create an SpriteSceneObject from a sprite with full frames per row.
SpriteSceneObject(Sprite sprite, long defaultTime, long[][] time, int[] frames) Create an SpriteSceneObject from a sprite.

Method Summary

Modifier and Type	Method and Description
int	getAnimationFrame() Get the frame of the current row in animation
int	getAnimationRow() Get the current row used for animation
int	getAnimationRowCount() Get the number of rows in this animation
protected int	getFrameCount(int row) Number of used frames of a row
Point	getOrigin() The origin of this SceneObject.
protected Sprite	getSprite()
int	getTileHeight() Get the height of one frame of the underlying sprite.
Size	getTileSize() Get the size of one frame of the underlying sprite.
int	getTileWidth() Get the width of one frame of the underlying sprite.
protected long	getTime(int row, int frame) Animation time for a frame
protected void	paint(Graphics2D g, long elapsedTime) Paint this SceneObject.
protected void	recalculateFrame(long elapsedTime) Recalculates the current visible frame depending on the elapsed time.
void	resetAnimation() Resets actual animation.
void	setAnimationFrame(int frame) Set the frame of the current row in animation.
void	setAnimationRow(int row) Change animation row and reset the animation.
void	setAnimationRow(int row, boolean reset) Change animation row.

Methods inherited from class com.github.brunothg.game.engine.d2.object.SceneObject

collides, collidesBoundingBox, collidesExactly, consumes, consumesBoundingBox, consumesExactly, getHeight, getPosition, getPreciseHeight, getPreciseWidth, getPreciseX, getPreciseY, getRectangle, getRenderingOptions, getSize, getTopLeftPosition, getWidth, getX, getY, isDrawBoundingBox, paintAbsoluteOnScene, paintOnScene, paintOnScene, paintOnScene, paintOnScene, setDrawBoundingBox, setPosition, setPosition, setRenderingOptions, setSize, setSize, setTopLeftPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

SpriteSceneObject

public SpriteSceneObject(Sprite sprite,
                         long defaultTime,
                         long[][] time,
                         int[] frames)

Create an SpriteSceneObject from a sprite. Only one row will be used for animation. The row used for this animation can be changed.

Parameters:

sprite - The animated sprite

defaultTime - Nanosecond for animation used if no individual time is provided

time - Time for every frame. Long[row][frame]. Zero means stable image, it won't be animated.

frames - An array containing the number of frames used for every row. If negative or too high the sprite's maximum frame number is used.

SpriteSceneObject

public SpriteSceneObject(Sprite sprite,
                         long defaultTime,
                         long[][] time)

Create an SpriteSceneObject from a sprite with full frames per row.

Parameters:

sprite - The animated sprite

defaultTime - Time for each frame where not specified

time - individual time for every frame

See Also:

SpriteSceneObject(Sprite, long, long[][], int[])

SpriteSceneObject

public SpriteSceneObject(Sprite sprite,
                         long defaultTime)

Create an SpriteSceneObject from a sprite with equal time for every frame.

Parameters:

sprite - The animated sprite

defaultTime - Time for each frame

See Also:

SpriteSceneObject(Sprite, long, long[][])

Method Detail

setAnimationRow

public void setAnimationRow(int row,
                            boolean reset)

Change animation row.

Parameters:

row - The row of the sprite used for animation

reset - if true animation will be

See Also:

resetAnimation()

setAnimationRow

public void setAnimationRow(int row)

Change animation row and reset the animation.

Parameters:

row - The row of the sprite used for animation

See Also:

setAnimationRow(int, boolean)

getAnimationRow

public int getAnimationRow()

Get the current row used for animation

Returns:

The row used for animation

getAnimationRowCount

public int getAnimationRowCount()

Get the number of rows in this animation

Returns:

Number of animation rows

getAnimationFrame

public int getAnimationFrame()

Get the frame of the current row in animation

Returns:

Current animated frame in row

setAnimationFrame

public void setAnimationFrame(int frame)

Set the frame of the current row in animation. If it is greater than the available frames the next frame in animation is chosen. Remember, that this will it will take affect when the animation is painted the next time. So if the next frame is this which should be painted you might set to the frame before.

Parameters:

frame - The current animated frame in row

resetAnimation

public void resetAnimation()

Resets actual animation. The first frame in actual row will be painted next time.

getTileHeight

public int getTileHeight()

Get the height of one frame of the underlying sprite.

Returns:

Height of one original frame

getTileWidth

public int getTileWidth()

Get the width of one frame of the underlying sprite.

Returns:

Width of one original frame

getTileSize

public Size getTileSize()

Get the size of one frame of the underlying sprite.

Returns:

Dimension of one original frame

paint

protected void paint(Graphics2D g,
                     long elapsedTime)

Description copied from class: SceneObject

Paint this SceneObject. This method maybe called for collision testing with an elapsed time of zero. For correct collision the SceneObject it is important, that the object is drawn in it's actual state.

Specified by:

paint in class SceneObject

Parameters:

g - Graphics Object for painting

elapsedTime - Elapsed time since the last call to this method

recalculateFrame

protected void recalculateFrame(long elapsedTime)

Recalculates the current visible frame depending on the elapsed time. Row restarts if it reaches end an the last frame has a time > 0.

getTime

protected long getTime(int row,
                       int frame)

Animation time for a frame

getFrameCount

protected int getFrameCount(int row)

Number of used frames of a row

getSprite

protected Sprite getSprite()

getOrigin

public Point getOrigin()

Description copied from class: SceneObject

The origin of this SceneObject. This object's position will be translated to it's origin. The default implementation returns SceneObject.ORIGIN_TOP_LEFT

Overrides:

getOrigin in class SceneObject

Returns:

The origin of this ScreenObject