org.xith3d.ui.hud.widgets
Class QuadDivider

java.lang.Object
  org.xith3d.ui.hud.base.WidgetBase
      org.xith3d.ui.hud.widgets.QuadDivider

All Implemented Interfaces:

org.jagatoo.datatypes.NamableObject, org.jagatoo.datatypes.NamedObject, org.openmali.types.twodee.Positioned2f, org.openmali.types.twodee.Positioned2fRO, org.openmali.types.twodee.Sized2f, org.openmali.types.twodee.Sized2fRO, Widget

public class QuadDivider
extends WidgetBase

The QuadDivider is used to resize four Widgets in north-west, north-east, south-west and south-east.

Nested Class Summary

static class

QuadDivider.QuadPanels

Nested classes/interfaces inherited from interface org.xith3d.ui.hud.base.Widget

Widget.DescriptionBase

Field Summary

static float

DIVIDER_WIDTH

Fields inherited from class org.xith3d.ui.hud.base.WidgetBase

containerListeners, transformGroup, translation, Z_INDEX_UNIT, Z_INDEX_UNIT_ASSEMBLER

Constructor Summary

QuadDivider(float width, float height)

QuadDivider(float width, float height, org.openmali.vecmath2.Colorf dividerColor)

Method Summary

void	addQuadDividerListener(QuadDividerListener l) Adds a new QuadDividerListener.
float	getBottomHeight()
float	getBottomTop()
float	getLeftWidth()
QuadDivider.QuadPanels	getPanelUnderMouse(int canvasX, int canvasY) Returns a constant indicating the "panel" under the mouse cursor.
float	getRightLeft()
float	getRightWidth()
float	getTopHeight()
float	getTransparency()
protected void	init() This method is called when the WidgetContainer is set.
HUDPickResult	pick(int canvasX, int canvasY, HUDPickResult.HUDPickReason pickReason, org.jagatoo.input.devices.components.MouseButton button, long when, long meta, int flags) Tests whether a Widget is under the cursor and runs the approriate methods if true.
void	removeQuadDividerListener(QuadDividerListener l) Removes a QuadDividerListener.
void	setDividerColor(org.openmali.vecmath2.Colorf color)
void	setHorizontalDividerTop(float horizTop) Sets the top-position of the horizontal divider.
void	setVerticalDividerLeft(float vertLeft) Sets the left-position of the vertical diviver.
protected void	updatePanelSizes()

Methods inherited from class org.xith3d.ui.hud.base.WidgetBase

addContainerListener, addFocusListener, addInputListener, addLocationListener, addSizeListener, addVisibilityListener, detach, detach, getAspect, getAssembly, getCachedToolTipWidget, getContainer, getContextMenu, getCursor, getHeight, getHUD, getInheritedCursor, getLeft, getLocation, getName, getSGNode, getSGZPosition, getSize, getToolTip, getTop, getUserObject, getWidgetAssembler, getWidth, getZIndex, hasFocus, hasFocus, hasToolTip, isClickable, isDraggable, isFocussable, isInitialized, isInitializing, isPickable, isVisible, onAddedToContainer, onAddedToHUD, onControllerAxisChanged, onControllerButtonPressed, onControllerButtonReleased, onDetached, onFocusGained, onFocusLost, onInputStateChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseButtonPressed, onMouseButtonReleased, onMouseEntered, onMouseLeft, onMouseMoved, onMouseStopped, onMouseUnbound, onMouseWheelMoved, onRemovedFromContainer, pickWidgetAssembler, removeContainerListener, removeFocusListener, removeInputListener, removeLocationListener, removeSizeListener, removeVisibilityListener, requestFocus, setAssembly, setCachedToolTipWidget, setClickable, setContainer, setContextMenu, setCursor, setDraggable, setFocussable, setHeight, setLocation, setLocation, setLocation, setName, setPickable, setSize, setSize, setSize, setSize, setToolTip, setTransparency, setUserObject, setVisible, setWidth, setZIndex, toString, update, updateTranslation

Methods inherited from class java.lang.Object

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

Field Detail

DIVIDER_WIDTH

public static final float DIVIDER_WIDTH

See Also:

Constant Field Values

Constructor Detail

QuadDivider

public QuadDivider(float width,
                   float height,
                   org.openmali.vecmath2.Colorf dividerColor)

QuadDivider

public QuadDivider(float width,
                   float height)

Method Detail

updatePanelSizes

protected void updatePanelSizes()

setDividerColor

public void setDividerColor(org.openmali.vecmath2.Colorf color)

setVerticalDividerLeft

public void setVerticalDividerLeft(float vertLeft)

Sets the left-position of the vertical diviver.

Parameters:

vertLeft -

setHorizontalDividerTop

public void setHorizontalDividerTop(float horizTop)

Sets the top-position of the horizontal divider.

Parameters:

horizTop -

getLeftWidth

public final float getLeftWidth()

Returns:

the width of the left-hand panels.

getRightWidth

public final float getRightWidth()

Returns:

the width of the right-hand panels.

getTopHeight

public final float getTopHeight()

Returns:

the height of the top panels.

getBottomHeight

public final float getBottomHeight()

Returns:

the height of the bottom panels.

getRightLeft

public final float getRightLeft()

Returns:

the left-position of the right-hand panels.

getBottomTop

public final float getBottomTop()

Returns:

the top-position of the bottom panels.

getPanelUnderMouse

public QuadDivider.QuadPanels getPanelUnderMouse(int canvasX,
                                                 int canvasY)

Returns a constant indicating the "panel" under the mouse cursor.

Parameters:

canvasX -

canvasY -

Returns:

the "panel". (or null, if the widget has not yet been initialized or the mouse is not over one of the panels)

getTransparency

public float getTransparency()

Returns:

the whole Widget's Transparency.

addQuadDividerListener

public void addQuadDividerListener(QuadDividerListener l)

Adds a new QuadDividerListener.

Parameters:

l -

removeQuadDividerListener

public void removeQuadDividerListener(QuadDividerListener l)

Removes a QuadDividerListener.

Parameters:

l -

pick

public HUDPickResult pick(int canvasX,
                          int canvasY,
                          HUDPickResult.HUDPickReason pickReason,
                          org.jagatoo.input.devices.components.MouseButton button,
                          long when,
                          long meta,
                          int flags)

Tests whether a Widget is under the cursor and runs the approriate methods if true.

Parameters:

canvasX - the x position of the mouse on the Canvas3D

canvasY - the y position of the mouse on the Canvas3D

pickReason - the action which caused this pick operation

button - the mouse-button, that caused the picking

when - the timestamp of the picking

meta - this could be either the lastPressTime, lastReleaseTime, buttonsState mask or the page-move-boolean. (depends on the pickReason)

Returns:

an instance of HUDPickResult holding the picked Widget and absolute and relative picking positions or null.

init

protected void init()

This method is called when the WidgetContainer is set.

Specified by:

init in class WidgetBase