heronarts.p3lx.ui

Class UI3dContext

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI3dContext

All Implemented Interfaces:

LXLoopTask, LXSerializable, UITabFocus

Direct Known Subclasses:

UIPreviewWindow

public class UI3dContext
extends UIObject
implements LXSerializable, 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 and Description
class	UI3dContext.Camera
static class	UI3dContext.InteractionMode Mode of interaction from keyboard mouse events
static class	UI3dContext.MouseMode Mode of mouse interaction
static interface	UI3dContext.MovementListener
static class	UI3dContext.ProjectionMode

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

LXSerializable.Utils

Field Summary

Fields

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

Fields inherited from class heronarts.p3lx.ui.UIObject

children, hasFocus, mousePressContextMenu, visible

Constructor Summary

Constructors

Modifier	Constructor and Description
	UI3dContext(UI ui, int x, int y, int w, int h) Creates a UI3dContext with the given frame position.
protected	UI3dContext(UI ui, PGraphics pg, int x, int y)

Method Summary

Modifier and Type	Method and Description
UI3dContext	addComponent(UI3dComponent component) Adds a component to the layer
void	addMovementListener(UI3dContext.MovementListener listener)
UI3dContext	clearCamera(int index) Clears the camera stored at the given index
void	draw(UI ui, PGraphics dstPg)
PVector	getCenter() Gets the center position of the scene
PVector	getEye() Gets the latest computed eye position
PGraphics	getGraphics()
float	getHeight()
float	getWidth()
void	load(LX lx, JsonObject object) Restores this instance from a JSON object
static UI3dContext	newTopLevelContext(UI ui) Creates a UI3dContext which draws into the parent Processing graphics context, bypassing any compositing of UI layers.
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	onMouseWheel(MouseEvent mouseEvent, float mx, float my, float delta) Subclasses override to receive mouse events
protected void	onResize() Subclasses may override to handle situation in which the size of the graphics context has changed.
UI3dContext	removeComponent(UI3dComponent component) Removes a component from the layer
void	removeMovementListener(UI3dContext.MovementListener listener)
void	save(LX lx, JsonObject object) Serializes this instance into the JSON object
UI3dContext	setBackground(boolean hasBackground) Sets whether this context has a background or not
UI3dContext	setBackgroundColor(int backgroundColor) Sets the background color for this 3d context
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	setEye(float x, float y, float z) Sets the eye position, only respected in MOVE mode
UI3dContext	setInteractionMode(UI3dContext.InteractionMode interactionMode) Set interaction mode for mouse/key events.
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	setRadius(float radius) Set radius of the camera
UI3dContext	setRadiusBounds(float minRadius, float maxRadius) Sets bounds on the radius
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.p3lx.ui.UIObject

addLoopTask, beginDraw, blur, bringToFront, consumeKeyEvent, consumeMousePress, consumeMouseWheelEvent, contains, endDraw, focus, getDescription, getFocusedChild, getLX, getParent, getUI, hasDirectFocus, hasFocus, isVisible, keyEventConsumed, loop, mousePressConsumed, onBlur, onDraw, onFocus, onUIResize, removeLoopTask, setDescription, setVisible, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyReleased, onKeyTyped, onMouseClicked, onMouseMoved, onMouseOut, onMouseOver, onMouseReleased

Methods inherited from class java.lang.Object

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

Field Detail

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)

phiLock

public final BooleanParameter phiLock

Phi lock prevents crazy vertical rotations

showCenterPoint

public final BooleanParameter showCenterPoint

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

animationProgress

public final UIInputBox.ProgressIndicator animationProgress

Constructor Detail

UI3dContext

public UI3dContext(UI ui,
                   int x,
                   int y,
                   int w,
                   int h)

Creates a UI3dContext with the given frame position. The context has its own PGraphics context and state. Draw calls should be made against the passed pg object which will be appropriately composited into the larger context.

Parameters:

ui - UI context

x - Frame x-position

y - Frame y-position

w - Frame width

h - Frame height

UI3dContext

protected UI3dContext(UI ui,
                      PGraphics pg,
                      int x,
                      int y)

Method Detail

addMovementListener

public final void addMovementListener(UI3dContext.MovementListener listener)

removeMovementListener

public final void removeMovementListener(UI3dContext.MovementListener listener)

newTopLevelContext

public static UI3dContext newTopLevelContext(UI ui)

Creates a UI3dContext which draws into the parent Processing graphics context, bypassing any compositing of UI layers. This context will not have its own PGraphics state. Calls will modify the global draw state. Use this only if you intend to draw directly to the main Processing context

Parameters:

ui - UI object

Returns:

UI3dContext

getGraphics

public PGraphics getGraphics()

getWidth

public float getWidth()

Specified by:

getWidth in class UIObject

getHeight

public float getHeight()

Specified by:

getHeight in class UIObject

setSize

public UI3dContext setSize(float width,
                           float height)

setBackgroundColor

public UI3dContext setBackgroundColor(int backgroundColor)

Sets the background color for this 3d context

Parameters:

backgroundColor - Background color

Returns:

this

setBackground

public UI3dContext setBackground(boolean hasBackground)

Sets whether this context has a background or not

Parameters:

hasBackground - Whether there's a background, if false content cleared each frame

Returns:

this

onResize

protected void onResize()

Subclasses may override to handle situation in which the size of the graphics context has changed.

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

setInteractionMode

public UI3dContext setInteractionMode(UI3dContext.InteractionMode interactionMode)

Set interaction mode for mouse/key events.

Parameters:

interactionMode - Interaction mode

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

setEye

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

Sets the eye position, only respected in MOVE mode

Parameters:

x - X-coordinate

y - Y-coordinate

z - Z-coordinate

Returns:

this

getCenter

public PVector getCenter()

Gets the center position of the scene

Returns:

center of scene

getEye

public PVector getEye()

Gets the latest computed eye position

Returns:

eye position

draw

public final void draw(UI ui,
                       PGraphics dstPg)

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

onMouseWheel

protected void onMouseWheel(MouseEvent mouseEvent,
                            float mx,
                            float my,
                            float delta)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseWheel in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

delta - Amount of wheel movement

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