squidpony.squidgrid.gui.gdx

Class SquidPanel

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

squidpony.squidgrid.gui.gdx.SquidPanel

All Implemented Interfaces:

com.badlogic.gdx.scenes.scene2d.utils.Cullable, squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

public class SquidPanel
extends com.badlogic.gdx.scenes.scene2d.Group
implements squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

Displays text and images in a grid pattern. Supports basic animations. Grid width and height settings are in terms of number of cells. Cell width and height are in terms of number of pixels. When text is placed, the background color is set separately from the foreground character. When moved, only the foreground character is moved.

Author:

Eben Howard - http://squidpony.com - howard@squidpony.com

Field Summary

Fields

Modifier and Type	Field and Description
float	DEFAULT_ANIMATION_DURATION

Constructor Summary

Constructors

Constructor and Description
SquidPanel(int gridWidth, int gridHeight) Creates a bare-bones panel with all default values for text rendering.
SquidPanel(int gridWidth, int gridHeight, int cellWidth, int cellHeight) Creates a panel with the given grid and cell size.
SquidPanel(int gridWidth, int gridHeight, TextCellFactory factory) Builds a panel with the given grid size and all other parameters determined by the factory.

Method Summary

Modifier and Type	Method and Description
AnimatedEntity	animateActor(int x, int y, boolean doubleWidth, boolean stretch, com.badlogic.gdx.graphics.g2d.TextureRegion texture) Create an AnimatedEntity at position x, y, using a TextureRegion with no color modifications, which, if and only if stretch is true, will be stretched to fit one cell, or two cells if doubleWidth is true.
AnimatedEntity	animateActor(int x, int y, boolean doubleWidth, boolean stretch, com.badlogic.gdx.graphics.g2d.TextureRegion texture, com.badlogic.gdx.graphics.Color color) Create an AnimatedEntity at position x, y, using a TextureRegion with the given color, which, if and only if stretch is true, will be stretched to fit one cell, or two cells if doubleWidth is true.
AnimatedEntity	animateActor(int x, int y, boolean doubleWidth, char c, com.badlogic.gdx.graphics.Color color) Create an AnimatedEntity at position x, y, using the char c in the given color.
AnimatedEntity	animateActor(int x, int y, boolean doubleWidth, String s, com.badlogic.gdx.graphics.Color color) Create an AnimatedEntity at position x, y, using the String s in the given color.
AnimatedEntity	animateActor(int x, int y, boolean doubleWidth, com.badlogic.gdx.graphics.g2d.TextureRegion texture) Create an AnimatedEntity at position x, y, using a TextureRegion with no color modifications, which will be stretched to fit one cell, or two cells if doubleWidth is true.
AnimatedEntity	animateActor(int x, int y, boolean doubleWidth, com.badlogic.gdx.graphics.g2d.TextureRegion texture, com.badlogic.gdx.graphics.Color color) Create an AnimatedEntity at position x, y, using a TextureRegion with the given color, which will be stretched to fit one cell, or two cells if doubleWidth is true.
AnimatedEntity	animateActor(int x, int y, char c, com.badlogic.gdx.graphics.Color color) Create an AnimatedEntity at position x, y, using the char c in the given color.
AnimatedEntity	animateActor(int x, int y, char c, int index, ArrayList<com.badlogic.gdx.graphics.Color> palette) Create an AnimatedEntity at position x, y, using the char c with a color looked up by index in palette.
AnimatedEntity	animateActor(int x, int y, String s, com.badlogic.gdx.graphics.Color color) Create an AnimatedEntity at position x, y, using the String s in the given color.
AnimatedEntity	animateActor(int x, int y, String s, int index, ArrayList<com.badlogic.gdx.graphics.Color> palette) Create an AnimatedEntity at position x, y, using the String s with a color looked up by index in palette.
AnimatedEntity	animateActor(int x, int y, com.badlogic.gdx.graphics.g2d.TextureRegion texture) Create an AnimatedEntity at position x, y, using a TextureRegion with no color modifications, which will be stretched to fit one cell.
AnimatedEntity	animateActor(int x, int y, com.badlogic.gdx.graphics.g2d.TextureRegion texture, com.badlogic.gdx.graphics.Color color) Create an AnimatedEntity at position x, y, using a TextureRegion with the given color, which will be stretched to fit one cell.
void	bump(AnimatedEntity ae, squidpony.squidgrid.Direction direction, float duration) Start a bumping animation in the given direction that will last duration seconds.
void	bump(squidpony.squidmath.Coord location, squidpony.squidgrid.Direction direction) Starts a bumping animation in the direction provided.
void	bump(int x, int y, squidpony.squidgrid.Direction direction) Starts a bumping animation in the direction provided.
void	bump(int x, int y, squidpony.squidgrid.Direction direction, float duration) Start a bumping animation in the given direction that will last duration seconds.
int	cellHeight()
com.badlogic.gdx.scenes.scene2d.Actor	cellToActor(int x, int y) Created an Actor from the contents of the given x,y position on the grid.
com.badlogic.gdx.scenes.scene2d.Actor	cellToActor(int x, int y, boolean doubleWidth) Created an Actor from the contents of the given x,y position on the grid.
int	cellWidth()
void	clear(int x, int y)
void	draw(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha)
void	drawActor(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha, AnimatedEntity ae) Draws one AnimatedEntity, specifically the Actor it contains.
void	erase() Erases the entire panel, leaving only a transparent space.
LinkedHashSet<AnimatedEntity>	getAnimatedEntities()
AnimatedEntity	getAnimatedEntityByCell(int x, int y)
squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>	getBacker()
com.badlogic.gdx.graphics.Color	getDefaultForegroundColor()
int	gridHeight()
int	gridWidth()
boolean	hasActiveAnimations() Returns true if there are animations running when this method is called.
void	placeVerticalString(int xOffset, int yOffset, String string, boolean vertical) Puts the given string horizontally with the first character at the given offset.
void	put(char[][] chars) Places the given characters into the grid starting at 0,0.
void	put(char[][] chars, com.badlogic.gdx.graphics.Color[][] foregrounds)
void	put(char[][] chars, int[][] indices, ArrayList<com.badlogic.gdx.graphics.Color> palette)
void	put(int x, int y, char c)
void	put(int xOffset, int yOffset, char[][] chars)
void	put(int xOffset, int yOffset, char[][] chars, com.badlogic.gdx.graphics.Color foreground)
void	put(int xOffset, int yOffset, char[][] chars, com.badlogic.gdx.graphics.Color[][] foregrounds)
void	put(int xOffset, int yOffset, char[][] chars, int[][] indices, ArrayList<com.badlogic.gdx.graphics.Color> palette)
void	put(int x, int y, char c, com.badlogic.gdx.graphics.Color color) Takes a unicode codepoint for input.
void	put(int x, int y, char c, int index, ArrayList<com.badlogic.gdx.graphics.Color> palette)
void	put(int x, int y, com.badlogic.gdx.graphics.Color color)
void	put(int xOffset, int yOffset, com.badlogic.gdx.graphics.Color[][] foregrounds)
void	put(int xOffset, int yOffset, squidpony.panel.IColoredString<? extends com.badlogic.gdx.graphics.Color> cs)
void	put(int x, int y, int code) Takes a unicode codepoint for input.
void	put(int xOffset, int yOffset, int[][] indices, ArrayList<com.badlogic.gdx.graphics.Color> palette)
void	put(int x, int y, int index, ArrayList<com.badlogic.gdx.graphics.Color> palette)
void	put(int x, int y, int c, com.badlogic.gdx.graphics.Color color)
void	put(int xOffset, int yOffset, String string) Puts the given string horizontally with the first character at the given offset.
void	put(int xOffset, int yOffset, String string, com.badlogic.gdx.graphics.Color foreground)
void	put(int xOffset, int yOffset, String string, com.badlogic.gdx.graphics.Color foreground, boolean vertical) Puts the given string horizontally with the first character at the given offset.
void	recallActor(com.badlogic.gdx.scenes.scene2d.Actor a)
void	recallActor(AnimatedEntity ae)
void	refresh()
void	setDefaultForeground(com.badlogic.gdx.graphics.Color defaultForeground)
void	slide(AnimatedEntity ae, int newX, int newY, float duration) Start a movement animation for the object at the grid location x, y and moves it to newX, newY over a number of seconds given by duration (often 0.12f or somewhere around there).
void	slide(squidpony.squidmath.Coord start, squidpony.squidmath.Coord end) Starts a movement animation for the object at the given grid location at the default speed.
void	slide(squidpony.squidmath.Coord start, squidpony.squidmath.Coord end, float duration) Starts a sliding movement animation for the object at the given location at the provided speed.
void	slide(squidpony.squidmath.Coord start, squidpony.squidgrid.Direction direction) Starts a movement animation for the object at the given grid location at the default speed for one grid square in the direction provided.
void	slide(int x, int y, int newX, int newY, float duration) Start a movement animation for the object at the grid location x, y and moves it to newX, newY over a number of seconds given by duration (often 0.12f or somewhere around there).
void	tint(AnimatedEntity ae, com.badlogic.gdx.graphics.Color color, float duration) Starts an wiggling animation for the object at the given location for the given duration in seconds.
void	tint(int x, int y, com.badlogic.gdx.graphics.Color color, float duration) Starts an wiggling animation for the object at the given location for the given duration in seconds.
void	wiggle(AnimatedEntity ae, float duration) Starts an wiggling animation for the object at the given location for the given duration in seconds.
void	wiggle(int x, int y, float duration) Starts an wiggling animation for the object at the given location for the given duration in seconds.

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group

act, addActor, addActorAfter, addActorAt, addActorBefore, applyTransform, applyTransform, childrenChanged, clear, clearChildren, computeTransform, debugAll, drawChildren, drawDebug, drawDebugChildren, findActor, getChildren, getCullingArea, hasChildren, hit, isTransform, localToDescendantCoordinates, removeActor, removeActor, resetTransform, resetTransform, setCullingArea, setDebug, setStage, setTransform, swapActor, swapActor, toString

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebugBounds, fire, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasParent, isAscendantOf, isDescendantOf, isTouchable, isVisible, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setY, setZIndex, sizeBy, sizeBy, sizeChanged, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ANIMATION_DURATION

public float DEFAULT_ANIMATION_DURATION

Constructor Detail

SquidPanel

public SquidPanel(int gridWidth,
                  int gridHeight)

Creates a bare-bones panel with all default values for text rendering.

Parameters:

gridWidth - the number of cells horizontally

gridHeight - the number of cells vertically

SquidPanel

public SquidPanel(int gridWidth,
                  int gridHeight,
                  int cellWidth,
                  int cellHeight)

Creates a panel with the given grid and cell size. Uses a default square font.

Parameters:

gridWidth - the number of cells horizontally

gridHeight - the number of cells vertically

cellWidth - the number of horizontal pixels in each cell

cellHeight - the number of vertical pixels in each cell

SquidPanel

public SquidPanel(int gridWidth,
                  int gridHeight,
                  TextCellFactory factory)

Builds a panel with the given grid size and all other parameters determined by the factory. Even if sprite images are being used, a TextCellFactory is still needed to perform sizing and other utility functions. If the TextCellFactory has not yet been initialized, then it will be sized at 12x12 px per cell. If it is null then a default one will be created and initialized.

Parameters:

gridWidth - the number of cells horizontally

gridHeight - the number of cells vertically

factory - the factory to use for cell rendering

Method Detail

put

public void put(char[][] chars)

Places the given characters into the grid starting at 0,0.

Parameters:

chars -

put

public void put(char[][] chars,
                com.badlogic.gdx.graphics.Color[][] foregrounds)

Specified by:

put in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

put

public void put(char[][] chars,
                int[][] indices,
                ArrayList<com.badlogic.gdx.graphics.Color> palette)

put

public void put(int xOffset,
                int yOffset,
                char[][] chars)

put

public void put(int xOffset,
                int yOffset,
                char[][] chars,
                com.badlogic.gdx.graphics.Color[][] foregrounds)

put

public void put(int xOffset,
                int yOffset,
                char[][] chars,
                int[][] indices,
                ArrayList<com.badlogic.gdx.graphics.Color> palette)

put

public void put(int xOffset,
                int yOffset,
                com.badlogic.gdx.graphics.Color[][] foregrounds)

put

public void put(int xOffset,
                int yOffset,
                int[][] indices,
                ArrayList<com.badlogic.gdx.graphics.Color> palette)

put

public void put(int xOffset,
                int yOffset,
                char[][] chars,
                com.badlogic.gdx.graphics.Color foreground)

put

public void put(int xOffset,
                int yOffset,
                String string)

Puts the given string horizontally with the first character at the given offset. Does not word wrap. Characters that are not renderable (due to being at negative offsets or offsets greater than the grid size) will not be shown but will not cause any malfunctions. Will use the default color for this component to draw the characters.

Parameters:

xOffset - the x coordinate of the first character

yOffset - the y coordinate of the first character

string - the characters to be displayed

put

public void put(int xOffset,
                int yOffset,
                squidpony.panel.IColoredString<? extends com.badlogic.gdx.graphics.Color> cs)

Specified by:

put in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

put

public void put(int xOffset,
                int yOffset,
                String string,
                com.badlogic.gdx.graphics.Color foreground)

Specified by:

put in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

placeVerticalString

public void placeVerticalString(int xOffset,
                                int yOffset,
                                String string,
                                boolean vertical)

Puts the given string horizontally with the first character at the given offset. Does not word wrap. Characters that are not renderable (due to being at negative offsets or offsets greater than the grid size) will not be shown but will not cause any malfunctions. Will use the default color for this component to draw the characters.

Parameters:

xOffset - the x coordinate of the first character

yOffset - the y coordinate of the first character

string - the characters to be displayed

vertical - true if the text should be written vertically, from top to bottom

put

public void put(int xOffset,
                int yOffset,
                String string,
                com.badlogic.gdx.graphics.Color foreground,
                boolean vertical)

Puts the given string horizontally with the first character at the given offset. Does not word wrap. Characters that are not renderable (due to being at negative offsets or offsets greater than the grid size) will not be shown but will not cause any malfunctions.

Parameters:

xOffset - the x coordinate of the first character

yOffset - the y coordinate of the first character

string - the characters to be displayed

foreground - the color to draw the characters

vertical - true if the text should be written vertically, from top to bottom

erase

public void erase()

Erases the entire panel, leaving only a transparent space.

clear

public void clear(int x,
                  int y)

Specified by:

clear in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

put

public void put(int x,
                int y,
                com.badlogic.gdx.graphics.Color color)

Specified by:

put in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

put

public void put(int x,
                int y,
                char c)

Specified by:

put in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

put

public void put(int x,
                int y,
                int code)

Takes a unicode codepoint for input.

Parameters:

x -

y -

code -

put

public void put(int x,
                int y,
                int c,
                com.badlogic.gdx.graphics.Color color)

put

public void put(int x,
                int y,
                int index,
                ArrayList<com.badlogic.gdx.graphics.Color> palette)

put

public void put(int x,
                int y,
                char c,
                int index,
                ArrayList<com.badlogic.gdx.graphics.Color> palette)

put

public void put(int x,
                int y,
                char c,
                com.badlogic.gdx.graphics.Color color)

Takes a unicode codepoint for input.

Specified by:

put in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

Parameters:

x -

y -

c -

color -

cellWidth

public int cellWidth()

cellHeight

public int cellHeight()

gridHeight

public int gridHeight()

Specified by:

gridHeight in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

gridWidth

public int gridWidth()

Specified by:

gridWidth in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

draw

public void draw(com.badlogic.gdx.graphics.g2d.Batch batch,
                 float parentAlpha)

Overrides:

draw in class com.badlogic.gdx.scenes.scene2d.Group

drawActor

public void drawActor(com.badlogic.gdx.graphics.g2d.Batch batch,
                      float parentAlpha,
                      AnimatedEntity ae)

Draws one AnimatedEntity, specifically the Actor it contains. Batch must be between start() and end()

Parameters:

batch - Must have start() called already but not stop() yet during this frame.

parentAlpha - This can be assumed to be 1.0f if you don't know it

ae - The AnimatedEntity to draw; the position to draw ae is stored inside it.

setDefaultForeground

public void setDefaultForeground(com.badlogic.gdx.graphics.Color defaultForeground)

Specified by:

setDefaultForeground in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

getDefaultForegroundColor

public com.badlogic.gdx.graphics.Color getDefaultForegroundColor()

Specified by:

getDefaultForegroundColor in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

getAnimatedEntityByCell

public AnimatedEntity getAnimatedEntityByCell(int x,
                                              int y)

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   char c,
                                   com.badlogic.gdx.graphics.Color color)

Create an AnimatedEntity at position x, y, using the char c in the given color.

Parameters:

x -

y -

c -

color -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   boolean doubleWidth,
                                   char c,
                                   com.badlogic.gdx.graphics.Color color)

Create an AnimatedEntity at position x, y, using the char c in the given color. If doubleWidth is true, treats the char c as the left char to be placed in a grid of 2-char cells.

Parameters:

x -

y -

doubleWidth -

c -

color -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   String s,
                                   com.badlogic.gdx.graphics.Color color)

Create an AnimatedEntity at position x, y, using the String s in the given color.

Parameters:

x -

y -

s -

color -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   boolean doubleWidth,
                                   String s,
                                   com.badlogic.gdx.graphics.Color color)

Create an AnimatedEntity at position x, y, using the String s in the given color. If doubleWidth is true, treats the String s as starting in the left cell of a pair to be placed in a grid of 2-char cells.

Parameters:

x -

y -

doubleWidth -

s -

color -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   char c,
                                   int index,
                                   ArrayList<com.badlogic.gdx.graphics.Color> palette)

Create an AnimatedEntity at position x, y, using the char c with a color looked up by index in palette.

Parameters:

x -

y -

c -

index -

palette -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   String s,
                                   int index,
                                   ArrayList<com.badlogic.gdx.graphics.Color> palette)

Create an AnimatedEntity at position x, y, using the String s with a color looked up by index in palette.

Parameters:

x -

y -

s -

index -

palette -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   com.badlogic.gdx.graphics.g2d.TextureRegion texture)

Create an AnimatedEntity at position x, y, using a TextureRegion with no color modifications, which will be stretched to fit one cell.

Parameters:

x -

y -

texture -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   com.badlogic.gdx.graphics.g2d.TextureRegion texture,
                                   com.badlogic.gdx.graphics.Color color)

Create an AnimatedEntity at position x, y, using a TextureRegion with the given color, which will be stretched to fit one cell.

Parameters:

x -

y -

texture -

color -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   boolean doubleWidth,
                                   com.badlogic.gdx.graphics.g2d.TextureRegion texture)

Create an AnimatedEntity at position x, y, using a TextureRegion with no color modifications, which will be stretched to fit one cell, or two cells if doubleWidth is true.

Parameters:

x -

y -

doubleWidth -

texture -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   boolean doubleWidth,
                                   com.badlogic.gdx.graphics.g2d.TextureRegion texture,
                                   com.badlogic.gdx.graphics.Color color)

Create an AnimatedEntity at position x, y, using a TextureRegion with the given color, which will be stretched to fit one cell, or two cells if doubleWidth is true.

Parameters:

x -

y -

doubleWidth -

texture -

color -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   boolean doubleWidth,
                                   boolean stretch,
                                   com.badlogic.gdx.graphics.g2d.TextureRegion texture)

Create an AnimatedEntity at position x, y, using a TextureRegion with no color modifications, which, if and only if stretch is true, will be stretched to fit one cell, or two cells if doubleWidth is true. If stretch is false, this will preserve the existing size of texture.

Parameters:

x -

y -

doubleWidth -

stretch -

texture -

Returns:

animateActor

public AnimatedEntity animateActor(int x,
                                   int y,
                                   boolean doubleWidth,
                                   boolean stretch,
                                   com.badlogic.gdx.graphics.g2d.TextureRegion texture,
                                   com.badlogic.gdx.graphics.Color color)

Create an AnimatedEntity at position x, y, using a TextureRegion with the given color, which, if and only if stretch is true, will be stretched to fit one cell, or two cells if doubleWidth is true. If stretch is false, this will preserve the existing size of texture.

Parameters:

x -

y -

doubleWidth -

stretch -

texture -

color -

Returns:

cellToActor

public com.badlogic.gdx.scenes.scene2d.Actor cellToActor(int x,
                                                         int y)

Created an Actor from the contents of the given x,y position on the grid.

Parameters:

x -

y -

Returns:

cellToActor

public com.badlogic.gdx.scenes.scene2d.Actor cellToActor(int x,
                                                         int y,
                                                         boolean doubleWidth)

Created an Actor from the contents of the given x,y position on the grid.

Parameters:

x -

y -

doubleWidth -

Returns:

recallActor

public void recallActor(com.badlogic.gdx.scenes.scene2d.Actor a)

recallActor

public void recallActor(AnimatedEntity ae)

bump

public void bump(AnimatedEntity ae,
                 squidpony.squidgrid.Direction direction,
                 float duration)

Start a bumping animation in the given direction that will last duration seconds.

Parameters:

ae - an AnimatedEntity returned by animateActor()

direction -

duration - a float, measured in seconds, for how long the animation should last; commonly 0.12f

bump

public void bump(int x,
                 int y,
                 squidpony.squidgrid.Direction direction,
                 float duration)

Start a bumping animation in the given direction that will last duration seconds.

Parameters:

x -

y -

direction -

duration - a float, measured in seconds, for how long the animation should last; commonly 0.12f

bump

public void bump(int x,
                 int y,
                 squidpony.squidgrid.Direction direction)

Starts a bumping animation in the direction provided.

Parameters:

x -

y -

direction -

bump

public void bump(squidpony.squidmath.Coord location,
                 squidpony.squidgrid.Direction direction)

Starts a bumping animation in the direction provided.

Parameters:

location -

direction -

slide

public void slide(AnimatedEntity ae,
                  int newX,
                  int newY,
                  float duration)

Start a movement animation for the object at the grid location x, y and moves it to newX, newY over a number of seconds given by duration (often 0.12f or somewhere around there).

Parameters:

ae - an AnimatedEntity returned by animateActor()

newX -

newY -

duration -

slide

public void slide(int x,
                  int y,
                  int newX,
                  int newY,
                  float duration)

Start a movement animation for the object at the grid location x, y and moves it to newX, newY over a number of seconds given by duration (often 0.12f or somewhere around there).

Parameters:

x -

y -

newX -

newY -

duration -

slide

public void slide(squidpony.squidmath.Coord start,
                  squidpony.squidmath.Coord end)

Starts a movement animation for the object at the given grid location at the default speed.

Parameters:

start -

end -

slide

public void slide(squidpony.squidmath.Coord start,
                  squidpony.squidgrid.Direction direction)

Starts a movement animation for the object at the given grid location at the default speed for one grid square in the direction provided.

Parameters:

start -

direction -

slide

public void slide(squidpony.squidmath.Coord start,
                  squidpony.squidmath.Coord end,
                  float duration)

Starts a sliding movement animation for the object at the given location at the provided speed. The duration is how many seconds should pass for the entire animation.

Parameters:

start -

end -

duration -

wiggle

public void wiggle(AnimatedEntity ae,
                   float duration)

Starts an wiggling animation for the object at the given location for the given duration in seconds.

Parameters:

ae - an AnimatedEntity returned by animateActor()

duration -

wiggle

public void wiggle(int x,
                   int y,
                   float duration)

Starts an wiggling animation for the object at the given location for the given duration in seconds.

Parameters:

x -

y -

duration -

tint

public void tint(AnimatedEntity ae,
                 com.badlogic.gdx.graphics.Color color,
                 float duration)

Starts an wiggling animation for the object at the given location for the given duration in seconds.

Parameters:

ae - an AnimatedEntity returned by animateActor()

color -

duration -

tint

public void tint(int x,
                 int y,
                 com.badlogic.gdx.graphics.Color color,
                 float duration)

Starts an wiggling animation for the object at the given location for the given duration in seconds.

Parameters:

x -

y -

color -

duration -

hasActiveAnimations

public boolean hasActiveAnimations()

Returns true if there are animations running when this method is called.

Returns:

getAnimatedEntities

public LinkedHashSet<AnimatedEntity> getAnimatedEntities()

refresh

public void refresh()

Specified by:

refresh in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>

getBacker

public squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color> getBacker()

Specified by:

getBacker in interface squidpony.panel.ISquidPanel<com.badlogic.gdx.graphics.Color>