Package com.jogamp.graph.ui.shapes

Class BaseButton

java.lang.Object

com.jogamp.graph.ui.Shape

com.jogamp.graph.ui.GraphShape

com.jogamp.graph.ui.shapes.BaseButton

Direct Known Subclasses:

Button, TexSeqButton

public class BaseButton
extends GraphShape

An abstract GraphUI filled base button GraphShape, usually used as a backdrop or base shape for more informative button types.

GraphUI is GPU based and resolution independent.

This button is rendered with a round oval shape by default, but can be set to any roundness or rectangular shape via {#link setCorner(float) or setPerp().

Nested Class Summary

Nested classes/interfaces inherited from class com.jogamp.graph.ui.Shape

Shape.DrawListener, Shape.EventInfo, Shape.ForwardKeyListener, Shape.ForwardMouseListener, Shape.Listener, Shape.MouseGestureAdapter, Shape.MouseGestureListener, Shape.MoveListener, Shape.PointerListener, Shape.Visitor1, Shape.Visitor2

Field Summary

Fields

Modifier and Type	Field	Description
static float	PERP_CORNER	Perpendicular corner for a rectangular shape, value 0.0f.
static float	ROUND_CORNER	Round corner, value 1.0f.

Fields inherited from class com.jogamp.graph.ui.Shape

ZAscendingComparator, ZDescendingComparator

Constructor Summary

Constructors

Constructor	Description
BaseButton(int renderModes, float width, float height)	Create a base button Graph based GLRegion UI Shape with a ROUND_CORNER.

Method Summary

Modifier and Type	Method	Description
float	getCorner()
float	getHeight()
String	getSubString()
float	getWidth()
BaseButton	setCorner(float corner)	Set corner size with range [0.01 ..
BaseButton	setPerp()	Sets a perpendicular corner.
BaseButton	setSize(float width, float height)

Methods inherited from class com.jogamp.graph.ui.GraphShape

getRegion, getRenderModes, getRenderModesReq, getSharpness, hasColorChannel, setSharpness, setTextureUnit

Methods inherited from class com.jogamp.graph.ui.Shape

addActivationListener, addKeyListener, addMouseListener, applyMatToMv, clear, destroy, draw, drawToSelect, getActiveColorMod, getAdjustedZ, getBorderColor, getBorderThickness, getBounds, getBounds, getColor, getID, getMat, getMat, getName, getPadding, getParent, getPixelPerShapeUnit, getPixelPerShapeUnit, getPixelPerShapeUnit, getPosition, getPressedColorMod, getRotation, getRotationPivot, getScale, getScaledDepth, getScaledHeight, getScaledWidth, getSurfacePort, getSurfaceSize, getSurfaceSize, getSurfaceSize, getToggleOffColorMod, getToggleOnColorMod, getTooltip, hasBorder, hasPadding, isActivable, isActive, isDiscarded, isDraggable, isFixedARatioResize, isGroup, isInteractive, isMatIdentity, isPressed, isResizable, isToggleable, isToggleOn, isVisible, markShapeDirty, markStateDirty, move, move, moveTo, moveTo, onClicked, onDraw, onHover, onMove, onToggle, receiveKeyEvents, receiveMouseEvents, removeActivationListener, removeKeyListener, removeMouseListener, removeToolTip, runSynced, scale, scale, setActivable, setActiveColorMod, setBorder, setBorderColor, setBorderColor, setColor, setColor, setDiscarded, setDragAndResizable, setDraggable, setFixedARatioResize, setID, setInteractive, setName, setPaddding, setPMVMatrix, setPMVMatrix, setPressed, setPressedColorMod, setResizable, setRotation, setRotationPivot, setRotationPivot, setScale, setScale, setToggle, setToggleable, setToggleOffColorMod, setToggleOnColorMod, setToolTip, setVisible, shapeToWinCoord, shapeToWinCoord, shapeToWinCoord, toggle, toString, updateMat, validate, validate, validate, winToShapeCoord, winToShapeCoord, winToShapeCoord

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ROUND_CORNER

public static final float ROUND_CORNER

Round corner, value 1.0f. This is the default value.

See Also:

Constant Field Values

PERP_CORNER

public static final float PERP_CORNER

Perpendicular corner for a rectangular shape, value 0.0f.

See Also:

Constant Field Values

Constructor Detail

BaseButton

public BaseButton(int renderModes,
                  float width,
                  float height)

Create a base button Graph based GLRegion UI Shape with a ROUND_CORNER.

Call {#link setCorner(float) or setPerp() to modify the corner shape.

Parameters:

renderModes - Graph's Region render modes, see create(..).

width -

height -

Method Detail

getWidth

public final float getWidth()

getHeight

public final float getHeight()

getCorner

public final float getCorner()

setCorner

public BaseButton setCorner(float corner)

Set corner size with range [0.01 .. 1.00] for round corners or `zero` for perpendicular corners.

Default is round corner, alternative a perpendicular corner for a rectangular shape is available.

Parameters:

corner - corner size with range [0.01 .. 1.00 ] for round corners or `zero` for perpendicular corners.

Returns:

this instance for chaining

See Also:

ROUND_CORNER, PERP_CORNER, setPerp()

setPerp

public BaseButton setPerp()

Sets a perpendicular corner.

Returns:

this instance for chaining

See Also:

setCorner(float)

setSize

public BaseButton setSize(float width,
                          float height)

getSubString

public String getSubString()

Overrides:

getSubString in class GraphShape