de.verygame.surface.scene2d.widget

Class Switch

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

de.verygame.surface.scene2d.widget.Panel

de.verygame.surface.scene2d.widget.Switch

All Implemented Interfaces:

com.badlogic.gdx.scenes.scene2d.utils.Cullable, com.badlogic.gdx.scenes.scene2d.utils.Layout

public class Switch
extends Panel

Base class for switches.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Switch.InputHandler
protected static class	Switch.LogicalState
static class	Switch.SwitchState
static class	Switch.SwitchStyle

Field Summary

Fields

Modifier and Type	Field and Description
protected Modifier	animationModifier Modifier used to interpolate switch movement.
protected float	borderValue Height of the top/bottom border
protected float	borderValueLeft Left border for the switchSprite.
protected float	borderValueRight Right border for the switchSprite.
protected Switch.LogicalState	inputState State of the touch gesture.
protected Switch.SwitchState	state State of the switch Switch.SwitchState.
protected com.badlogic.gdx.scenes.scene2d.ui.Image	stateRect For displaying a bar.
protected com.badlogic.gdx.scenes.scene2d.ui.Image	switchSprite Moveable part of the switch.

Constructor Summary

Constructors

Constructor and Description
Switch(com.badlogic.gdx.scenes.scene2d.utils.Drawable background, com.badlogic.gdx.scenes.scene2d.utils.Drawable button, com.badlogic.gdx.scenes.scene2d.utils.Drawable whitePixel, com.badlogic.gdx.graphics.Color state) Crreates a switch.
Switch(com.badlogic.gdx.scenes.scene2d.ui.Skin skin, com.badlogic.gdx.scenes.scene2d.utils.Drawable background)
Switch(Switch.SwitchStyle style, com.badlogic.gdx.scenes.scene2d.utils.Drawable background)

Method Summary

Modifier and Type	Method and Description
void	act(float secondsElapsed)
boolean	isOn() Returns true if the current state is SwitchState.ON.
protected void	setBorderValueLeft(float borderValueLeft) Setter for borderValueLeft.
protected void	setBorderValueRight(float borderValueRight) Setter for borderValueRight.
void	setHeight(float height)
void	setWidth(float width)
protected void	switchState() Switches the state, depending on the current state.
void	switchToState(boolean state) Switches to the given state.
void	switchToState(Switch.SwitchState switchState) Switches to the given state.
void	updateBackground(com.badlogic.gdx.scenes.scene2d.utils.Drawable background) Convenience method to apply a new background.
void	updateButton(com.badlogic.gdx.scenes.scene2d.utils.Drawable button) Convenience method to apply a new button image.
void	updatePixel(com.badlogic.gdx.scenes.scene2d.utils.Drawable whitePixel) Convenience method to apply a new image.

Methods inherited from class de.verygame.surface.scene2d.widget.Panel

draw, setAlpha, setBackground, setXPadding, setYPadding

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

childrenChanged, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, invalidate, invalidateHierarchy, layout, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

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

addActor, addActorAfter, addActorAt, addActorBefore, applyTransform, applyTransform, 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, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setX, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

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

Field Detail

switchSprite

protected com.badlogic.gdx.scenes.scene2d.ui.Image switchSprite

Moveable part of the switch.

stateRect

protected com.badlogic.gdx.scenes.scene2d.ui.Image stateRect

For displaying a bar.

state

protected Switch.SwitchState state

State of the switch Switch.SwitchState.

inputState

protected Switch.LogicalState inputState

State of the touch gesture.

animationModifier

protected Modifier animationModifier

Modifier used to interpolate switch movement.

borderValueLeft

protected float borderValueLeft

Left border for the switchSprite.

borderValueRight

protected float borderValueRight

Right border for the switchSprite.

borderValue

protected float borderValue

Height of the top/bottom border

Constructor Detail

Switch

public Switch(com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
              com.badlogic.gdx.scenes.scene2d.utils.Drawable background)

Switch

public Switch(Switch.SwitchStyle style,
              com.badlogic.gdx.scenes.scene2d.utils.Drawable background)

Switch

public Switch(com.badlogic.gdx.scenes.scene2d.utils.Drawable background,
              com.badlogic.gdx.scenes.scene2d.utils.Drawable button,
              com.badlogic.gdx.scenes.scene2d.utils.Drawable whitePixel,
              com.badlogic.gdx.graphics.Color state)

Crreates a switch.

Parameters:

background - background of the switch

button - the moveable button of the switch

Method Detail

updateBackground

public void updateBackground(com.badlogic.gdx.scenes.scene2d.utils.Drawable background)

Convenience method to apply a new background.

Parameters:

background - background image

updateButton

public void updateButton(com.badlogic.gdx.scenes.scene2d.utils.Drawable button)

Convenience method to apply a new button image.

Parameters:

button - new button image

updatePixel

public void updatePixel(com.badlogic.gdx.scenes.scene2d.utils.Drawable whitePixel)

Convenience method to apply a new image.

Parameters:

whitePixel - new drawable

isOn

public boolean isOn()

Returns true if the current state is SwitchState.ON.

Returns:

false if the current state is SwitchState.OFF

setBorderValueRight

protected void setBorderValueRight(float borderValueRight)

Setter for borderValueRight.

Parameters:

borderValueRight - right border for switchSprite

setBorderValueLeft

protected void setBorderValueLeft(float borderValueLeft)

Setter for borderValueLeft.

Parameters:

borderValueLeft - left border for switchSprite.

switchToState

public void switchToState(boolean state)

Switches to the given state.

Parameters:

state - as boolean

switchToState

public void switchToState(Switch.SwitchState switchState)

Switches to the given state.

Parameters:

switchState - Switch.SwitchState

switchState

protected void switchState()

Switches the state, depending on the current state.

act

public void act(float secondsElapsed)

Overrides:

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

setHeight

public void setHeight(float height)

Overrides:

setHeight in class com.badlogic.gdx.scenes.scene2d.Actor

setWidth

public void setWidth(float width)

Overrides:

setWidth in class com.badlogic.gdx.scenes.scene2d.Actor