Module com.marginallyclever.robotoverlord

Package com.marginallyclever.ro3.apps.viewport

Class Viewport

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.marginallyclever.ro3.apps.App

com.marginallyclever.ro3.apps.viewport.OpenGLPanel

com.marginallyclever.ro3.apps.viewport.Viewport

All Implemented Interfaces:

com.jogamp.opengl.GLEventListener, MouseListener, MouseMotionListener, MouseWheelListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class Viewport
extends OpenGLPanel
implements com.jogamp.opengl.GLEventListener

Viewport is an OpenGLPanel that uses a set of RenderPasses to draw the Registry.getScene() from the perspective of a Registry.getActiveCamera().

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field	Description
ListWithEvents<RenderPass>	renderPasses

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
Viewport()

Method Summary

Modifier and Type	Method	Description
void	addNotify()
void	display(com.jogamp.opengl.GLAutoDrawable glAutoDrawable)
void	dispose(com.jogamp.opengl.GLAutoDrawable glAutoDrawable)
double	getAspectRatio()
javax.vecmath.Vector3d	getCursorAsNormalized()
javax.vecmath.Point2d	getCursorPosition()
double	getOrbitChangeFactor()
Ray	getRayThroughPoint(Camera camera, double x, double y)	Return the ray coming through the viewport in the current projection.
double	getUserMovementScale()
void	init(com.jogamp.opengl.GLAutoDrawable glAutoDrawable)
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	mouseWheelMoved(MouseWheelEvent e)
void	removeNotify()
void	reshape(com.jogamp.opengl.GLAutoDrawable glAutoDrawable, int x, int y, int width, int height)
void	saveRenderPassState()	Save the viewport pass state to the Preferences.
void	setOrbitChangeFactor(double amount)
void	setUserMovementScale(double scale)	Set the scale of user movement.

Methods inherited from class com.marginallyclever.ro3.apps.viewport.OpenGLPanel

addGLEventListener, getFsaaSamples, isDoubleBuffered, isHardwareAccelerated, isVerticalSync, mouseEntered, mouseExited, removeGLEventListener, savePrefs, setDoubleBuffered, setFsaaSamples, setHardwareAccelerated, setVerticalSync, stopAnimationSystem

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

renderPasses

public ListWithEvents<RenderPass> renderPasses

Constructor Details

Viewport

public Viewport()

Method Details

saveRenderPassState

public void saveRenderPassState()

Save the viewport pass state to the Preferences.

addNotify

public void addNotify()

Overrides:

addNotify in class OpenGLPanel

removeNotify

public void removeNotify()

Overrides:

removeNotify in class OpenGLPanel

init

public void init(com.jogamp.opengl.GLAutoDrawable glAutoDrawable)

Specified by:

init in interface com.jogamp.opengl.GLEventListener

Overrides:

init in class OpenGLPanel

dispose

public void dispose(com.jogamp.opengl.GLAutoDrawable glAutoDrawable)

Specified by:

dispose in interface com.jogamp.opengl.GLEventListener

Overrides:

dispose in class OpenGLPanel

reshape

public void reshape(com.jogamp.opengl.GLAutoDrawable glAutoDrawable,
 int x,
 int y,
 int width,
 int height)

Specified by:

reshape in interface com.jogamp.opengl.GLEventListener

Overrides:

reshape in class OpenGLPanel

display

public void display(com.jogamp.opengl.GLAutoDrawable glAutoDrawable)

Specified by:

display in interface com.jogamp.opengl.GLEventListener

Overrides:

display in class OpenGLPanel

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

Overrides:

mouseClicked in class OpenGLPanel

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class OpenGLPanel

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class OpenGLPanel

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class OpenGLPanel

mouseWheelMoved

public void mouseWheelMoved(MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface MouseWheelListener

Overrides:

mouseWheelMoved in class OpenGLPanel

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class OpenGLPanel

getOrbitChangeFactor

public double getOrbitChangeFactor()

setOrbitChangeFactor

public void setOrbitChangeFactor(double amount)

Parameters:

amount - a value greater than one.

getRayThroughPoint

public Ray getRayThroughPoint(Camera camera,
 double x,
 double y)

Return the ray coming through the viewport in the current projection. Remember that in OpenGL the camera -Z=forward, +X=right, +Y=up

Parameters:

x - the cursor position in screen coordinates [-1,1]

y - the cursor position in screen coordinates [-1,1]

Returns:

the ray coming through the viewport in the current projection.

getCursorAsNormalized

public javax.vecmath.Vector3d getCursorAsNormalized()

Returns:

the cursor position as values from -1...1.

getCursorPosition

public javax.vecmath.Point2d getCursorPosition()

getAspectRatio

public double getAspectRatio()

getUserMovementScale

public double getUserMovementScale()

setUserMovementScale

public void setUserMovementScale(double scale)

Set the scale of user movement. This is used to scale the mouse movement to the camera movement.

Parameters:

scale - a value greater than zero.