Package heronarts.glx.ui

Class UI3dContext

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI3dContext

All Implemented Interfaces:

UILayer, UITabFocus, LXLoopTask, LXSerializable

Direct Known Subclasses:

UIPreviewWindow

public class UI3dContext
extends UIObject
implements LXSerializable, UILayer, UITabFocus

This is a layer that contains a 3d scene with a camera. Mouse movements control the camera, and the scene can contain components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UI3dContext.Camera
static enum	UI3dContext.MouseMode	Mode of mouse interaction
static interface	UI3dContext.MovementListener
static enum	UI3dContext.ProjectionMode

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final BooleanParameter	animation	Whether to animate between camera positions
final UIInputBox.ProgressIndicator	animationProgress
final BoundedParameter	animationTime	Animation time
final UI3dContext.Camera	camera
final MutableParameter	cameraAcceleration	Acceleration used to change camera radius (zoom)
final MutableParameter	cameraVelocity	Max velocity used to damp changes to radius (zoom)
final UI3dContext.Camera[]	cue
final BoundedParameter	depth	Depth of perspective field, exponential factor of radius by exp(10, Depth)
final ObjectParameter<UI3dContext.Camera>	focusCamera
EnumParameter<UI3dContext.MouseMode>	mouseMode	Mouse interaction mode
static final int	NUM_CAMERA_POSITIONS
final BoundedParameter	perspective	Perspective of view
final EnumParameter<UI3dContext.ProjectionMode>	projection	Projection mode
final MutableParameter	rotationAcceleration	Acceleration used to change rotation (theta/phi)
final MutableParameter	rotationVelocity	Max velocity used to damp changes to rotation (theta/phi)
protected final View	view

Fields inherited from class heronarts.glx.ui.UIObject

children, hasFocus, visible

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UI3dContext(UI ui, float x, float y, float w, float h)

Method Summary

Modifier and Type	Method	Description
final UI3dContext	addComponent(UI3dComponent component)	Adds a component to the layer
final void	addMovementListener(UI3dContext.MovementListener listener)
UI3dContext	clearCamera(int index)	Clears the camera stored at the given index
void	dispose()
final void	draw(UI ui, View view)
org.joml.Vector3f	getCenter()	Gets the center position of the scene
org.joml.Vector3f	getEye()	Gets the latest computed eye position
float	getHeight()
org.joml.Matrix4f	getProjectionMatrix()
org.joml.Matrix4f	getViewMatrix()
float	getWidth()
float	getX()
float	getY()
void	load(LX lx, JsonObject object)	Restores this instance from a JSON object
protected void	onKeyPressed(KeyEvent keyEvent, char keyChar, int keyCode)	Subclasses override to receive key events
protected void	onMouseDragged(MouseEvent mouseEvent, float mx, float my, float dx, float dy)	Subclasses override to receive mouse events
protected void	onMousePressed(MouseEvent mouseEvent, float mx, float my)	Subclasses override to receive mouse events
protected void	onMouseScroll(MouseEvent mouseEvent, float mx, float my, float dx, float dy)	Subclasses override to receive mouse events
final UI3dContext	removeComponent(UI3dComponent component)	Removes a component from the layer
final void	removeMovementListener(UI3dContext.MovementListener listener)
void	save(LX lx, JsonObject object)	Serializes this instance into the JSON object
UI3dContext	setCamera(int index)	Sets the cue position index of the camera
UI3dContext	setCameraAcceleration(float cameraAcceleration)	Set's the camera's zoom acceleration, 0 is infinite
UI3dContext	setCameraVelocity(float cameraVelocity)	Sets the camera's maximum zoom speed
UI3dContext	setCenter(float x, float y, float z)	Sets the center of the scene, only respected in ZOOM mode
UI3dContext	setMaxRadius(float maxRadius)	Set maximum radius
UI3dContext	setMinRadius(float minRadius)	Set minimum radius
UI3dContext	setPerspective(float perspective)	Sets perspective angle of the camera in degrees
UI3dContext	setPhi(float phi)	Set the phi angle of viewing
UI3dContext	setPosition(float x, float y)
UI3dContext	setRadius(float radius)	Set radius of the camera
UI3dContext	setRadiusBounds(float minRadius, float maxRadius)	Sets bounds on the radius
UI3dContext	setRect(float x, float y, float width, float height)
UI3dContext	setRotationAcceleration(float rotationAcceleration)	Set's the camera's rotational acceleration, 0 is infinite
UI3dContext	setRotationVelocity(float rotationVelocity)	Sets the camera's maximum rotation speed
UI3dContext	setSize(float width, float height)
UI3dContext	setTheta(double theta)	Set the theta angle of viewing

Methods inherited from class heronarts.glx.ui.UIObject

addListener, addListener, addLoopTask, blur, bringToFront, contains, focus, getDescription, getFocusedChild, getLX, getParent, getUI, hasDirectFocus, hasFocus, isVisible, loop, onBlur, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setDescription, setVisible, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onKeyReleased, onMouseMoved, onMouseOut, onMouseOver, onMouseReleased

Methods inherited from class java.lang.Object

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

Field Details

NUM_CAMERA_POSITIONS

public static final int NUM_CAMERA_POSITIONS

See Also:

• Constant Field Values

mouseMode

public EnumParameter<UI3dContext.MouseMode> mouseMode

Mouse interaction mode

projection

public final EnumParameter<UI3dContext.ProjectionMode> projection

Projection mode

perspective

public final BoundedParameter perspective

Perspective of view

depth

public final BoundedParameter depth

Depth of perspective field, exponential factor of radius by exp(10, Depth)

animation

public final BooleanParameter animation

Whether to animate between camera positions

animationTime

public final BoundedParameter animationTime

Animation time

cameraVelocity

public final MutableParameter cameraVelocity

Max velocity used to damp changes to radius (zoom)

cameraAcceleration

public final MutableParameter cameraAcceleration

Acceleration used to change camera radius (zoom)

rotationVelocity

public final MutableParameter rotationVelocity

Max velocity used to damp changes to rotation (theta/phi)

rotationAcceleration

public final MutableParameter rotationAcceleration

Acceleration used to change rotation (theta/phi)

cue

public final UI3dContext.Camera[] cue

focusCamera

public final ObjectParameter<UI3dContext.Camera> focusCamera

camera

public final UI3dContext.Camera camera

animationProgress

public final UIInputBox.ProgressIndicator animationProgress

view

protected final View view

Constructor Details

UI3dContext

protected UI3dContext(UI ui,
 float x,
 float y,
 float w,
 float h)

Method Details

addMovementListener

public final void addMovementListener(UI3dContext.MovementListener listener)

removeMovementListener

public final void removeMovementListener(UI3dContext.MovementListener listener)

dispose

public void dispose()

Overrides:

dispose in class UIObject

getX

public float getX()

Overrides:

getX in class UIObject

getY

public float getY()

Overrides:

getY in class UIObject

getWidth

public float getWidth()

Specified by:

getWidth in class UIObject

getHeight

public float getHeight()

Specified by:

getHeight in class UIObject

setPosition

public UI3dContext setPosition(float x,
 float y)

setSize

public UI3dContext setSize(float width,
 float height)

setRect

public UI3dContext setRect(float x,
 float y,
 float width,
 float height)

addComponent

public final UI3dContext addComponent(UI3dComponent component)

Adds a component to the layer

Parameters:

component - Component

Returns:

this

removeComponent

public final UI3dContext removeComponent(UI3dComponent component)

Removes a component from the layer

Parameters:

component - Component

Returns:

this

clearCamera

public UI3dContext clearCamera(int index)

Clears the camera stored at the given index

Parameters:

index - Camera index to clear

Returns:

this

setCamera

public UI3dContext setCamera(int index)

Sets the cue position index of the camera

Parameters:

index - Camera index

Returns:

this

setRadius

public UI3dContext setRadius(float radius)

Set radius of the camera

Parameters:

radius - Camera radius

Returns:

this

setPerspective

public UI3dContext setPerspective(float perspective)

Sets perspective angle of the camera in degrees

Parameters:

perspective - Angle in degrees

Returns:

this

setCameraVelocity

public UI3dContext setCameraVelocity(float cameraVelocity)

Sets the camera's maximum zoom speed

Parameters:

cameraVelocity - Max units/per second radius may change by

Returns:

this

setCameraAcceleration

public UI3dContext setCameraAcceleration(float cameraAcceleration)

Set's the camera's zoom acceleration, 0 is infinite

Parameters:

cameraAcceleration - Acceleration for camera

Returns:

this

setRotationVelocity

public UI3dContext setRotationVelocity(float rotationVelocity)

Sets the camera's maximum rotation speed

Parameters:

rotationVelocity - Max radians/per second viewing angle may change by

Returns:

this

setRotationAcceleration

public UI3dContext setRotationAcceleration(float rotationAcceleration)

Set's the camera's rotational acceleration, 0 is infinite

Parameters:

rotationAcceleration - Acceleration of camera rotation

Returns:

this

setTheta

public UI3dContext setTheta(double theta)

Set the theta angle of viewing

Parameters:

theta - Angle about the y axis

Returns:

this

setPhi

public UI3dContext setPhi(float phi)

Set the phi angle of viewing

Parameters:

phi - Angle about the y axis

Returns:

this

setRadiusBounds

public UI3dContext setRadiusBounds(float minRadius,
 float maxRadius)

Sets bounds on the radius

Parameters:

minRadius - Minimum camera radius

maxRadius - Maximum camera radius

Returns:

this

setMinRadius

public UI3dContext setMinRadius(float minRadius)

Set minimum radius

Parameters:

minRadius - Minimum camera radius

Returns:

this

setMaxRadius

public UI3dContext setMaxRadius(float maxRadius)

Set maximum radius

Parameters:

maxRadius - Maximum camera radius

Returns:

this

setCenter

public UI3dContext setCenter(float x,
 float y,
 float z)

Sets the center of the scene, only respected in ZOOM mode

Parameters:

x - X-coordinate

y - Y-coordinate

z - Z-coordinate

Returns:

this

getCenter

public org.joml.Vector3f getCenter()

Gets the center position of the scene

Returns:

center of scene

getEye

public org.joml.Vector3f getEye()

Gets the latest computed eye position

Returns:

eye position

draw

public final void draw(UI ui,
 View view)

Specified by:

draw in interface UILayer

getViewMatrix

public org.joml.Matrix4f getViewMatrix()

getProjectionMatrix

public org.joml.Matrix4f getProjectionMatrix()

onMousePressed

protected void onMousePressed(MouseEvent mouseEvent,
 float mx,
 float my)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMousePressed in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

onMouseDragged

protected void onMouseDragged(MouseEvent mouseEvent,
 float mx,
 float my,
 float dx,
 float dy)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseDragged in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - movement in x

dy - movement in y

onMouseScroll

protected void onMouseScroll(MouseEvent mouseEvent,
 float mx,
 float my,
 float dx,
 float dy)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseScroll in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - Amount of horizontal scroll

dy - Amount of vertical scroll

onKeyPressed

protected void onKeyPressed(KeyEvent keyEvent,
 char keyChar,
 int keyCode)

Description copied from class: UIEventHandler

Subclasses override to receive key events

Overrides:

onKeyPressed in class UIEventHandler

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

save

public void save(LX lx,
 JsonObject object)

Description copied from interface: LXSerializable

Serializes this instance into the JSON object

Specified by:

save in interface LXSerializable

Parameters:

lx - LX instance

object - Object to serialize into

load

public void load(LX lx,
 JsonObject object)

Description copied from interface: LXSerializable

Restores this instance from a JSON object

Specified by:

load in interface LXSerializable

Parameters:

lx - LX instance

object - Object to deserialize