org.xith3d.ui.hud.widgets
Class Widget3D

java.lang.Object
  org.xith3d.ui.hud.base.WidgetBase
      org.xith3d.ui.hud.base.RectangularWidget
          org.xith3d.ui.hud.widgets.Widget3D

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, BorderSettable, Widget

public class Widget3D
extends RectangularWidget
implements BorderSettable

The Widget3D is connected to a RenderPass and controls its Viewport, so that it always covers the Widgets (inner) area.

Note, that it doesn't care about the z-order (z-index). The RenderPass is rendered in the order, that is defined by the RenderPasses' list.

If you're using a FirstPersonInputHandler, you should apply a view-transform (see RenderPassConfig.setViewTransform(org.xith3d.scenegraph.Transform3D)) to the RenderPassConfig, so that the FirstPersonInputHandler doesn't affect the "nested" RenderPass.

Nested Class Summary

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

Widget.DescriptionBase

Field Summary

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

containerListeners, transformGroup, translation, Z_INDEX_UNIT, Z_INDEX_UNIT_ASSEMBLER

Constructor Summary

Widget3D(float width, float height, RenderPassConfig rpConfig)
Creates a new Widget3D.

Method Summary

Border	getBorder()
RenderPassConfig	getRenderPassConfig()
float	getTransparency()
protected void	init() This method is called when the WidgetContainer is set.
void	setBorder(Border.Description borderDesc) Creates a new Border from the given Border.Desctiption and invokes setBorder(Border).
void	setBorder(Border border) Sets the Border to use for this BorderSettable Widget.
boolean	setLocation(float locX, float locY, boolean forced)
boolean	setSize(float width, float height, boolean forced)

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

getPickHeight, getPickSGZPosition, getPickWidth, pick

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, setName, setPickable, 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

Constructor Detail

Widget3D

public Widget3D(float width,
                float height,
                RenderPassConfig rpConfig)

Creates a new Widget3D.

Parameters:

width -

height -

rpConfig -

Method Detail

getRenderPassConfig

public final RenderPassConfig getRenderPassConfig()

Returns:

the attached RenderPassConfig.

getTransparency

public final float getTransparency()

Specified by:

getTransparency in interface Widget

Returns:

the whole Widget's Transparency.

setBorder

public void setBorder(Border border)

Sets the Border to use for this BorderSettable Widget.

Specified by:

setBorder in interface BorderSettable

Parameters:

border - the new Border (null for no border)

setBorder

public void setBorder(Border.Description borderDesc)

Creates a new Border from the given Border.Desctiption and invokes setBorder(Border).

Specified by:

setBorder in interface BorderSettable

Parameters:

borderDesc - the Border.Description to create the new Border from (null for no border)

See Also:

BorderSettable.setBorder(Border)

getBorder

public final Border getBorder()

Specified by:

getBorder in interface BorderSettable

Returns:

the Border used for this BorderSettable Widget

setLocation

public boolean setLocation(float locX,
                           float locY,
                           boolean forced)

Overrides:

setLocation in class WidgetBase

setSize

public boolean setSize(float width,
                       float height,
                       boolean forced)

Overrides:

setSize in class WidgetBase

init

protected void init()

This method is called when the WidgetContainer is set.

Specified by:

init in class WidgetBase