view

Class ViewPole

java.lang.Object

view.ViewPole

public class ViewPole
extends Object

Mouse-based control over the orientation and position of the camera. This view controller is based on a target point, which is centered in the camera, and an orientation around that target point that represents the camera. The Pole allows the user to rotate around this point, move closer to/farther from it, and to move the point itself. This Pole is given a ViewDef that defines a number of size parameters and limitations. This Pole is given an action button, which it will listen for click events from. If the mouse button is clicked and no modifiers are pressed, the the view will rotate around the object in both the view-local X and Y axes. If the CTRL key is held, then it will rotate about the X or Y axes, based on how far the mouse is from the starting point in the X or Y directions. If the ALT key is held, then the camera will spin in the view-local Z direction. Scrolling the mouse wheel up or down moves the camera closer or farther from the object, respectively. The distance is taken from ViewDef::largeRadiusDelta. If the SHIFT key is held while scrolling, then the movement will be the ViewDef::smallRadiusDelta value instead. The target point can be moved, relative to the current view, with the WASD keys. W/S move forward and backwards, while A/D move left and right, respectively. Q and E move down and up, respectively. If the rightKeyboardCtrls parameter of the constructor is set, then it uses the IJKLUO keys instead of WASDQE. The offset applied to the position is ViewDef::largePosOffset; if SHIFT is held, then ViewDef::smallPosOffset is used instead.

Author:

gbarbieri

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ViewProvider.MouseButtons

Constructor Summary

Constructors

Constructor and Description
ViewPole(ViewData initialView, ViewScale viewScale, int actionButton)
ViewPole(ViewData initialView, ViewScale viewScale, int actionButton, boolean rightKeyboardCtrls) Creates a view pole with the given initial target position, view definition, and action button.

Method Summary

Modifier and Type	Method and Description
glm.mat._4.Mat4	calcMatrix() Generates the world-to-camera matrix for the view.
void	charPress(com.jogamp.newt.event.KeyEvent keyEvent)
ViewData	getView()
void	mouseMove(com.jogamp.newt.event.MouseEvent mouseEvent)
void	mousePressed(com.jogamp.newt.event.MouseEvent mouseEvent)
void	mouseReleased(com.jogamp.newt.event.MouseEvent mouseEvent)
void	mouseWheel(com.jogamp.newt.event.MouseEvent mouseEvent)
void	processXchange(int xDiff)
void	processYchange(int yDiff)
void	reset() Resets the view to the initial view.
float	rotationScale()
void	rotationScale(float rotateScale) Sets the scaling factor for orientation changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewPole

public ViewPole(ViewData initialView,
                ViewScale viewScale,
                int actionButton)

ViewPole

public ViewPole(ViewData initialView,
                ViewScale viewScale,
                int actionButton,
                boolean rightKeyboardCtrls)

Creates a view pole with the given initial target position, view definition, and action button.

Parameters:

initialView - initialView The starting state of the view.

viewScale - viewScale The viewport definition to use.

actionButton - actionButton The mouse button to listen for. All other mouse buttons are ignored.

rightKeyboardCtrls - if true, then it uses IJKLUO instead of WASDQE keys.

Method Detail

calcMatrix

public glm.mat._4.Mat4 calcMatrix()

Generates the world-to-camera matrix for the view.

Returns:

rotationScale

public void rotationScale(float rotateScale)

Sets the scaling factor for orientation changes.

Parameters:

rotateScale - The scaling factor is the number of degrees to rotate the view per window space pixel. The scale is the same for all mouse movements.

rotationScale

public float rotationScale()

Returns:

Gets the current scaling factor for orientation changes.

getView

public ViewData getView()

Returns:

Retrieves the current viewing information.

reset

public void reset()

Resets the view to the initial view. Will fail if currently dragging.

processXchange

public void processXchange(int xDiff)

processYchange

public void processYchange(int yDiff)

mouseMove

public void mouseMove(com.jogamp.newt.event.MouseEvent mouseEvent)

mousePressed

public void mousePressed(com.jogamp.newt.event.MouseEvent mouseEvent)

mouseReleased

public void mouseReleased(com.jogamp.newt.event.MouseEvent mouseEvent)

mouseWheel

public void mouseWheel(com.jogamp.newt.event.MouseEvent mouseEvent)

charPress

public void charPress(com.jogamp.newt.event.KeyEvent keyEvent)