squidpony.squidgrid.gui.gdx

Class GroupCombinedPanel<T>

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

squidpony.squidgrid.gui.gdx.GroupCombinedPanel<T>

All Implemented Interfaces:

com.badlogic.gdx.scenes.scene2d.utils.Cullable, squidpony.panel.ICombinedPanel<T>

public class GroupCombinedPanel<T>
extends com.badlogic.gdx.scenes.scene2d.Group
implements squidpony.panel.ICombinedPanel<T>

An implementation of ICombinedPanel that extends libGDX's Group. If you're a new user or need only a foreground and background, it's likely what you should use. this is a concrete implementation of ICombinedPanel that you should use if you're concretely in need of a panel to display/write to, without doing fancy GUI stuff. Because it extends libGDX's Group, it offers a lot of features.

Author:

smelC

See Also:

for a more advanced Group that supports multiple layers.

Nested Class Summary

Nested classes/interfaces inherited from interface squidpony.panel.ICombinedPanel

squidpony.panel.ICombinedPanel.Impl<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected squidpony.panel.ISquidPanel<T>	bg
protected squidpony.panel.ISquidPanel<T>	fg
protected int	gridHeight The height, in cell sizes
protected int	gridWidth The width, in cell sizes

Constructor Summary

Constructors

Constructor and Description
GroupCombinedPanel() Constructor that defer providing the backing panels.
GroupCombinedPanel(squidpony.panel.ISquidPanel<T> bg, squidpony.panel.ISquidPanel<T> fg, int gridWidth, int gridHeight)

Method Summary

Modifier and Type	Method and Description
protected void	addActors()
protected void	checkBG()
protected void	checkFG()
void	fillBG(T color)
List<squidpony.panel.ISquidPanel<?>>	getBackers()
void	put(int x, int y, char c, T foreground, T background)
void	put(int x, int y, squidpony.panel.IColoredString<? extends T> cs, T background)
void	put(int x, int y, String s, T foreground, T background)
void	putBG(int x, int y, T color)
void	putFG(int x, int y, char c)
void	putFG(int x, int y, char c, T color)
void	putFG(int x, int y, squidpony.panel.IColoredString<? extends T> cs)
void	putFG(int x, int y, String string, T foreground)
void	refresh()
void	setPanels(squidpony.panel.ISquidPanel<T> bg, squidpony.panel.ISquidPanel<T> fg) Sets the backing panels.
String	toString()

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

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

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

bg

protected squidpony.panel.ISquidPanel<T> bg

fg

protected squidpony.panel.ISquidPanel<T> fg

gridWidth

protected int gridWidth

The width, in cell sizes

gridHeight

protected int gridHeight

The height, in cell sizes

Constructor Detail

GroupCombinedPanel

public GroupCombinedPanel(squidpony.panel.ISquidPanel<T> bg,
                          squidpony.panel.ISquidPanel<T> fg,
                          int gridWidth,
                          int gridHeight)

Parameters:

bg - The backing background panel. Typically a SquidPanel from this package.

fg - The backing foreground panel. Typically a SquidPanel from this package.

gridWidth - The width of this panel, used for fillBG(Object) (so that it fills within [0, width)).

gridHeight - The height of this panel, used for fillBG(Object) (so that it fills within [0, height)).

Throws:

IllegalStateException - In various cases of errors regarding sizes of panels.

GroupCombinedPanel

public GroupCombinedPanel()

Constructor that defer providing the backing panels. Useful for subclasses that compute their size after being constructed. Use setPanels(ISquidPanel, ISquidPanel) to set the panels (required before calling any put method).

Width and height are computed using the provided panels.

Method Detail

setPanels

public void setPanels(squidpony.panel.ISquidPanel<T> bg,
                      squidpony.panel.ISquidPanel<T> fg)

Sets the backing panels.

Parameters:

bg - Typically a SquidPanel from this package.

fg - Typically a SquidPanel from this package.

putFG

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

Specified by:

putFG in interface squidpony.panel.ICombinedPanel<T>

putFG

public void putFG(int x,
                  int y,
                  char c,
                  T color)

Specified by:

putFG in interface squidpony.panel.ICombinedPanel<T>

putFG

public void putFG(int x,
                  int y,
                  String string,
                  T foreground)

Specified by:

putFG in interface squidpony.panel.ICombinedPanel<T>

putFG

public void putFG(int x,
                  int y,
                  squidpony.panel.IColoredString<? extends T> cs)

Specified by:

putFG in interface squidpony.panel.ICombinedPanel<T>

putBG

public void putBG(int x,
                  int y,
                  T color)

Specified by:

putBG in interface squidpony.panel.ICombinedPanel<T>

put

public void put(int x,
                int y,
                char c,
                T foreground,
                T background)

put

public void put(int x,
                int y,
                squidpony.panel.IColoredString<? extends T> cs,
                T background)

put

public void put(int x,
                int y,
                String s,
                T foreground,
                T background)

fillBG

public void fillBG(T color)

Specified by:

fillBG in interface squidpony.panel.ICombinedPanel<T>

refresh

public void refresh()

Specified by:

refresh in interface squidpony.panel.ICombinedPanel<T>

getBackers

public List<squidpony.panel.ISquidPanel<?>> getBackers()

Specified by:

getBackers in interface squidpony.panel.ICombinedPanel<T>

addActors

protected void addActors()

checkFG

protected void checkFG()

checkBG

protected void checkBG()

toString

public String toString()

Overrides:

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