view

Class ObjectPole

java.lang.Object

view.ObjectPole

public class ObjectPole
extends Object

Mouse-based control over the orientation and position of an object. This Pole speaks of three spaces: local, world, and view. Local refers to the coordinate system of vertices given to the matrix that this Pole generates. World represents the \em output coordinate system. So vertices enter in local and are transformed to world. Note that this does not have to actually be the real world-space. It could be the space of some parent hierarchy, but the ObjectPole is not really designed for that. View represents the space provided by the ViewProvider given to the constructor. The assumption that this Pole makes when using the view space matrix is that the matrix the ObjectPole generates will be multiplied by the view matrix given by the ViewProvider. So it is assumed that there is no intermediate space. This Pole is given an action button, which it will listen for click events from. When the action button is held down and the mouse moved, the object's orientation will change, relative to the orientation of the view. But only if a ViewProvider (such as ViewPole) was provided; otherwise, the rotation will be relative to the world. If no modifier keys (shift, ctrl, alt) were held when the click was given, then the object will be oriented in both the view-space X and Y axes. If the CTRL key is held when the click was given, then the object will only rotate around either the X or Y axis. The selection is based on whether the X or the Y mouse coordinate is farthest from the initial position when dragging started. If the ALT key is held, then the object will rotate about the Z axis, and only the X position of the mouse affects the object.

Author:

gbarbieri

Constructor Summary

Constructors

Constructor and Description
ObjectPole(ObjectData initialData, float rotateScale, int actionButton, view.ViewProvider lookAtProvider) Creates an object pole with a given initial position and orientation.

Method Summary

Modifier and Type	Method and Description
glm.mat._4.Mat4	calcMatrix() Generates the local-to-world matrix for this object.
ObjectData	getPosOrient()
float	getRotationScale()
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	reset() Resets the object to the initial position/orientation.
void	rotateLocalDegrees(glm.quat.Quat rot)
void	rotateLocalDegrees(glm.quat.Quat rot, boolean fromInitial)
void	rotateViewDegrees(glm.quat.Quat rot)
void	rotateViewDegrees(glm.quat.Quat rot, boolean fromInitial)
void	rotateWorldDegrees(glm.quat.Quat rot)
void	rotateWorldDegrees(glm.quat.Quat rot, boolean fromInitial)
void	setRotationScale(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

ObjectPole

public ObjectPole(ObjectData initialData,
                  float rotateScale,
                  int actionButton,
                  view.ViewProvider lookAtProvider)

Creates an object pole with a given initial position and orientation.

Parameters:

initialData - The starting position and orientation of the object in world space.

rotateScale - The number of degrees to rotate the object per window space pixel

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

lookAtProvider - An object that will compute a view matrix. This defines the view space that orientations can be relative to. If it is NULL, then orientations will be relative to the world.

Method Detail

calcMatrix

public glm.mat._4.Mat4 calcMatrix()

Generates the local-to-world matrix for this object.

Returns:

setRotationScale

public void setRotationScale(float rotateScale)

Sets the scaling factor for orientation changes.

Parameters:

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

getRotationScale

public float getRotationScale()

Returns:

The current scaling factor for orientation changes.

getPosOrient

public ObjectData getPosOrient()

Returns:

The current position and orientation of the object.

reset

public void reset()

Resets the object to the initial position/orientation. Will fail if currently dragging.

rotateWorldDegrees

public void rotateWorldDegrees(glm.quat.Quat rot)

rotateWorldDegrees

public void rotateWorldDegrees(glm.quat.Quat rot,
                               boolean fromInitial)

rotateLocalDegrees

public void rotateLocalDegrees(glm.quat.Quat rot)

rotateLocalDegrees

public void rotateLocalDegrees(glm.quat.Quat rot,
                               boolean fromInitial)

rotateViewDegrees

public void rotateViewDegrees(glm.quat.Quat rot)

rotateViewDegrees

public void rotateViewDegrees(glm.quat.Quat rot,
                              boolean fromInitial)

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)