org.xith3d.ui.hud
Class HUDFactory

java.lang.Object
  org.xith3d.ui.hud.HUDFactory

public final class HUDFactory
extends java.lang.Object

This class contains (static) factory methods for the HUD.

Method Summary

static HUD	createAndInitialize(RenderableSceneGraph sg, float resX) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(RenderableSceneGraph sg, float resX, float resY) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(RenderableSceneGraph sg, float resX, float resY, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(RenderableSceneGraph sg, float resX, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(RenderableSceneGraph sg, org.openmali.vecmath2.Tuple2f resolution) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(RenderableSceneGraph sg, org.openmali.vecmath2.Tuple2f resolution, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, int canvasWidth, int canvasHeight, float resX) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, int canvasWidth, int canvasHeight, float resX, float resY) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, int canvasWidth, int canvasHeight, float resX, float resY, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, int canvasWidth, int canvasHeight, float resX, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, int canvasWidth, int canvasHeight, org.openmali.vecmath2.Tuple2f resolution) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, int canvasWidth, int canvasHeight, org.openmali.vecmath2.Tuple2f resolution, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, org.openmali.types.twodee.Sized2iRO canvas, float resX) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, org.openmali.types.twodee.Sized2iRO canvas, float resX, float resY) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, org.openmali.types.twodee.Sized2iRO canvas, float resX, float resY, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, org.openmali.types.twodee.Sized2iRO canvas, float resX, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, org.openmali.types.twodee.Sized2iRO canvas, org.openmali.vecmath2.Tuple2f resolution) Creates and returns a new HUD instance with the given resolution.
static HUD	createAndInitialize(SceneGraph sg, org.openmali.types.twodee.Sized2iRO canvas, org.openmali.vecmath2.Tuple2f resolution, org.jagatoo.input.devices.Keyboard keyboard, org.jagatoo.input.devices.Mouse mouse) Creates and returns a new HUD instance with the given resolution.

Methods inherited from class java.lang.Object

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

Method Detail

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      int canvasWidth,
                                      int canvasHeight,
                                      org.openmali.vecmath2.Tuple2f resolution)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at with PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvasWidth - the width of the Canvas3D to take the resolution and aspect from

canvasHeight - the width of the Canvas3D to take the resolution and aspect from

resolution - resolution for this HUD

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      org.openmali.types.twodee.Sized2iRO canvas,
                                      org.openmali.vecmath2.Tuple2f resolution)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at with PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvas - a Canvas3D instance to take the aspect ratio from

resolution - resolution for this HUD

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      int canvasWidth,
                                      int canvasHeight,
                                      float resX,
                                      float resY)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvasWidth - the width of the Canvas3D to take the resolution and aspect from

canvasHeight - the width of the Canvas3D to take the resolution and aspect from

resX - width of the resolution for this HUD

resY - height of the resolution for this HUD

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      int canvasWidth,
                                      int canvasHeight,
                                      float resX)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvasWidth - the width of the Canvas3D to take the resolution and aspect from

canvasHeight - the width of the Canvas3D to take the resolution and aspect from

resX - the x-resolution of the coordinate system. The y-resolution is calculateed by (resX / canvasAspect).

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      org.openmali.types.twodee.Sized2iRO canvas,
                                      float resX,
                                      float resY)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvas - a Canvas3D instance to take the aspect ratio from

resX - width of the resolution for this HUD

resY - height of the resolution for this HUD

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      org.openmali.types.twodee.Sized2iRO canvas,
                                      float resX)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvas - a Canvas3D instance to take the aspect ratio from

resX - the x-resolution of the coordinate system. The y-resolution is calculateed by (resX / canvasAspect).

rl - a RenderLoop instance with registered Mouse- and Keyboards

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(RenderableSceneGraph sg,
                                      org.openmali.vecmath2.Tuple2f resolution)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - a RenderableSceneGraph implementation

resolution - resolution for this HUD

rl - a RenderLoop instance with registered Mouse- and Keyboards

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(RenderableSceneGraph sg,
                                      float resX,
                                      float resY)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - a RenderableSceneGraph instance

resX - width of the resolution for this HUD

resY - height of the resolution for this HUD

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(RenderableSceneGraph sg,
                                      float resX)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the RenderLoop for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - a RenderableSceneGraph instance

resX - the x-resolution of the coordinate system. The y-resolution is calculateed by (resX / canvasAspect).

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      int canvasWidth,
                                      int canvasHeight,
                                      org.openmali.vecmath2.Tuple2f resolution,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvasWidth - the width of the Canvas3D to take the resolution and aspect from

canvasHeight - the width of the Canvas3D to take the resolution and aspect from

resolution - resolution for this HUD

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      org.openmali.types.twodee.Sized2iRO canvas,
                                      org.openmali.vecmath2.Tuple2f resolution,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvas - a Canvas3D instance to take the aspect ratio from

resolution - resolution for this HUD

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      int canvasWidth,
                                      int canvasHeight,
                                      float resX,
                                      float resY,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvasWidth - the width of the Canvas3D to take the resolution and aspect from

canvasHeight - the width of the Canvas3D to take the resolution and aspect from

resX - height of the resolution for this HUD

resY - width of the resolution for this HUD

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      int canvasWidth,
                                      int canvasHeight,
                                      float resX,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvasWidth - the width of the Canvas3D to take the resolution and aspect from

canvasHeight - the width of the Canvas3D to take the resolution and aspect from

resX - the x-resolution of the coordinate system. The y-resolution is calculateed by (resX / canvasAspect).

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      org.openmali.types.twodee.Sized2iRO canvas,
                                      float resX,
                                      float resY,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvas - a Canvas3D instance to take the aspect ratio from

resY - width of the resolution for this HUD

resX - height of the resolution for this HUD

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(SceneGraph sg,
                                      org.openmali.types.twodee.Sized2iRO canvas,
                                      float resX,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - SceneGraph implementation (like Xith3DEnvironment) to add The HUD to

canvas - a Canvas3D instance to take the aspect ratio from

resX - the x-resolution of the coordinate system. The y-resolution is calculateed by (resX / canvasAspect).

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(RenderableSceneGraph sg,
                                      org.openmali.vecmath2.Tuple2f resolution,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - a RenderableSceneGraph instance

resolution - resolution for this HUD

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(RenderableSceneGraph sg,
                                      float resX,
                                      float resY,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - a RenderableSceneGraph instance

resX - width of the resolution for this HUD

resY - height of the resolution for this HUD

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance

createAndInitialize

public static HUD createAndInitialize(RenderableSceneGraph sg,
                                      float resX,
                                      org.jagatoo.input.devices.Keyboard keyboard,
                                      org.jagatoo.input.devices.Mouse mouse)

• Creates and returns a new HUD instance with the given resolution.
• Links the HUD with the Keyboard- and Mouse for input events.
• Adds the HUD to the environment at CLOSEST and PARALLEL_PROJECTION

Parameters:

sg - a RenderableSceneGraph instance

resX - the x-resolution of the coordinate system. The y-resolution is calculateed by (resX / canvasAspect).

keyboard - an instance of Keyboard to link with the hud for keyboard events

mouse - an instance of Mouse to link with the hud for mouse events

Returns:

the new HUD instance