GLMouseAdapter (Artisynth API documentation)

java.lang.Object
- maspack.render.GL.GLMouseAdapter

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener, GLMouseListener
```
public class GLMouseAdapter
extends java.lang.Object
implements GLMouseListener
```

Constructor Summary

Constructors
Constructor and Description

GLMouseAdapter(GLViewer viewer)

Constructors
Constructor and Description
`GLMouseAdapter(GLViewer viewer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.awt.Point`	`getCurrentCursor()`
`int`	`getDraggerConstrainMask()`
`int`	`getDraggerDragMask()`
`int`	`getDraggerRepositionMask()`
`int`	`getEllipticCursorResizeMask()`
`int`	`getEllipticDeselectMask()` Gets the modifier mask that enables deselection when using elliptic selection.
`GLViewer`	`getGLViewer()`
`double`	`getMouseWheelZoomScale()` get the mouse wheel zoom amount default: 100
`int`	`getMultipleSelectionMask()` Gets the modifier mask that enables multiple selection.
`int`	`getRotateButtonMask()` Gets the mouse button mask that enables rotation.
`int`	`getSelectionButtonMask()` Gets the mouse button mask that enables selection.
`int`	`getTranslateButtonMask()` Gets the mouse button mask that enables translation.
`int`	`getZoomButtonMask()` Gets the mouse button mask that enables zooming.
`boolean`	`isSelectVisibleOnly()`
`void`	`mouseClicked(java.awt.event.MouseEvent e)`
`void`	`mouseDragged(java.awt.event.MouseEvent e)`
`void`	`mouseEntered(java.awt.event.MouseEvent e)`
`void`	`mouseExited(java.awt.event.MouseEvent e)`
`void`	`mouseMoved(java.awt.event.MouseEvent e)`
`void`	`mousePressed(java.awt.event.MouseEvent e)`
`void`	`mouseReleased(java.awt.event.MouseEvent e)`
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent e)` to get the zoom function going through the mouse wheel which is easier to navigate, then by using key combination CTRL + mouse click + mouse drag.
`void`	`setDraggerConstrainMask(int mask)`
`void`	`setDraggerDragMask(int mask)`
`void`	`setDraggerRepositionMask(int mask)`
`void`	`setEllipticCursorResizeMask(int mask)`
`void`	`setEllipticDeselectMask(int mask)` Sets the modifier mask that enables deselection when using elliptic selection.
`void`	`setGLViewer(GLViewer viewer)`
`void`	`setLaptopConfig()`
`void`	`setMouseWheelZoomScale(double s)` set the mouse wheel zoom amount modified by Charles Krzysik on Apr 11th 2008 default: 100
`void`	`setMultipleSelectionMask(int mask)` Sets the modifier mask that enables multiple selection.
`void`	`setRotateButtonMask(int mask)` Sets the mouse button mask that enables rotation.
`void`	`setSelectionButtonMask(int mask)` Sets the mouse button mask that enables selection.
`void`	`setSelectVisibleOnly(boolean set)` Configures the selection handler to only select objects visible on the screen (i.e.
`void`	`setTranslateButtonMask(int mask)` Sets the mouse button mask that enables translation.
`void`	`setZoomButtonMask(int mask)` Sets the mouse button mask that enables zooming.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GLMouseAdapter
```
public GLMouseAdapter(GLViewer viewer)
```
- Method Detail
  - getCurrentCursor
```
public java.awt.Point getCurrentCursor()
```
    Specified by:
    
    getCurrentCursor in interface GLMouseListener
  - setGLViewer
```
public void setGLViewer(GLViewer viewer)
```
  - getGLViewer
```
public GLViewer getGLViewer()
```
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
  - mouseWheelMoved
```
public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)
```
    to get the zoom function going through the mouse wheel which is easier to navigate, then by using key combination CTRL + mouse click + mouse drag. The latter is still in the system for backward compatibility author: andreio
    
    Specified by:
    
    mouseWheelMoved in interface java.awt.event.MouseWheelListener
  - setRotateButtonMask
```
public void setRotateButtonMask(int mask)
```
    Sets the mouse button mask that enables rotation. This should be a combination of the following mouse buttons and extended modifiers defined in java.awt.event.InputEvent: BUTTON1_DOWN_MASK, BUTTON2_DOWN_MASK, BUTTON2_DOWN_MASK, SHIFT_DOWN_MASK, ALT_DOWN_MASK, META_DOWN_MASK, and CTRL_DOWN_MASK.
    
    Parameters:
    
    mask - rotation button mask
  - getRotateButtonMask
```
public int getRotateButtonMask()
```
    Gets the mouse button mask that enables rotation.
    
    Returns:
    
    rotation button mask
    
    See Also:
    
    setRotateButtonMask(int)
  - setTranslateButtonMask
```
public void setTranslateButtonMask(int mask)
```
    Sets the mouse button mask that enables translation. This should be a combination of the following mouse buttons and extended modifiers defined in java.awt.event.InputEvent: BUTTON1_DOWN_MASK, BUTTON2_DOWN_MASK, BUTTON2_DOWN_MASK, SHIFT_DOWN_MASK, ALT_DOWN_MASK, META_DOWN_MASK, and CTRL_DOWN_MASK.
    
    Parameters:
    
    mask - translation button mask
  - getTranslateButtonMask
```
public int getTranslateButtonMask()
```
    Gets the mouse button mask that enables translation.
    
    Returns:
    
    translation button mask
    
    See Also:
    
    setTranslateButtonMask(int)
  - setZoomButtonMask
```
public void setZoomButtonMask(int mask)
```
    Sets the mouse button mask that enables zooming. This should be a combination of the following mouse buttons and extended modifiers defined in java.awt.event.InputEvent: BUTTON1_DOWN_MASK, BUTTON2_DOWN_MASK, BUTTON2_DOWN_MASK, SHIFT_DOWN_MASK, ALT_DOWN_MASK, META_DOWN_MASK, and CTRL_DOWN_MASK.
    
    Parameters:
    
    mask - zooming button mask
  - getZoomButtonMask
```
public int getZoomButtonMask()
```
    Gets the mouse button mask that enables zooming.
    
    Returns:
    
    zooming button mask
    
    See Also:
    
    setZoomButtonMask(int)
  - setMouseWheelZoomScale
```
public void setMouseWheelZoomScale(double s)
```
    set the mouse wheel zoom amount modified by Charles Krzysik on Apr 11th 2008 default: 100
    
    Specified by:
    
    setMouseWheelZoomScale in interface GLMouseListener
    
    Parameters:
    
    s - zoomAmount
  - getMouseWheelZoomScale
```
public double getMouseWheelZoomScale()
```
    get the mouse wheel zoom amount default: 100
    
    Specified by:
    
    getMouseWheelZoomScale in interface GLMouseListener
    
    Returns:
    
    zoomAmount
  - setSelectionButtonMask
```
public void setSelectionButtonMask(int mask)
```
    Sets the mouse button mask that enables selection. This should be a combination of the following mouse buttons and extended modifiers defined in java.awt.event.InputEvent: BUTTON1_DOWN_MASK, BUTTON2_DOWN_MASK, BUTTON2_DOWN_MASK, SHIFT_DOWN_MASK, ALT_DOWN_MASK, META_DOWN_MASK, and CTRL_DOWN_MASK.
    
    Parameters:
    
    mask - selection button mask
  - getSelectionButtonMask
```
public int getSelectionButtonMask()
```
    Gets the mouse button mask that enables selection.
    
    Returns:
    
    selection button mask
    
    See Also:
    
    setSelectionButtonMask(int)
  - setMultipleSelectionMask
```
public void setMultipleSelectionMask(int mask)
```
    Sets the modifier mask that enables multiple selection. This should be a combination of the following extended modifiers defined in java.awt.event.InputEvent: SHIFT_DOWN_MASK, ALT_DOWN_MASK, META_DOWN_MASK, and CTRL_DOWN_MASK.
    
    Parameters:
    
    mask - multiple selection modifier mask
  - getMultipleSelectionMask
```
public int getMultipleSelectionMask()
```
    Gets the modifier mask that enables multiple selection.
    
    Specified by:
    
    getMultipleSelectionMask in interface GLMouseListener
    
    Returns:
    
    multiple selection modifier mask
    
    See Also:
    
    setMultipleSelectionMask(int)
  - setEllipticDeselectMask
```
public void setEllipticDeselectMask(int mask)
```
    Sets the modifier mask that enables deselection when using elliptic selection. This should be a combination of the following extended modifiers defined in java.awt.event.InputEvent: SHIFT_DOWN_MASK, ALT_DOWN_MASK, META_DOWN_MASK, and CTRL_DOWN_MASK.
    
    Parameters:
    
    mask - elliptic deselect modifier mask
  - getEllipticDeselectMask
```
public int getEllipticDeselectMask()
```
    Gets the modifier mask that enables deselection when using elliptic selection.
    
    Returns:
    
    elliptic deselect modifier mask
    
    See Also:
    
    setMultipleSelectionMask(int)
  - getDraggerConstrainMask
```
public int getDraggerConstrainMask()
```
  - setDraggerConstrainMask
```
public void setDraggerConstrainMask(int mask)
```
  - getDraggerRepositionMask
```
public int getDraggerRepositionMask()
```
  - setDraggerRepositionMask
```
public void setDraggerRepositionMask(int mask)
```
  - setDraggerDragMask
```
public void setDraggerDragMask(int mask)
```
  - getDraggerDragMask
```
public int getDraggerDragMask()
```
  - setEllipticCursorResizeMask
```
public void setEllipticCursorResizeMask(int mask)
```
  - getEllipticCursorResizeMask
```
public int getEllipticCursorResizeMask()
```
  - setSelectVisibleOnly
```
public void setSelectVisibleOnly(boolean set)
```
    Description copied from interface: GLMouseListener
    
    Configures the selection handler to only select objects visible on the screen (i.e. ignore depth mask)
    
    Specified by:
    
    setSelectVisibleOnly in interface GLMouseListener
    
    Parameters:
    
    set - if true, only selects visible components. False, select occluded
  - isSelectVisibleOnly
```
public boolean isSelectVisibleOnly()
```
    Specified by:
    
    isSelectVisibleOnly in interface GLMouseListener
  - setLaptopConfig
```
public void setLaptopConfig()
```

Class GLMouseAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GLMouseAdapter

Method Detail

getCurrentCursor

setGLViewer

getGLViewer

mouseClicked

mouseEntered

mouseExited

mousePressed

mouseReleased

mouseDragged

mouseMoved

mouseWheelMoved

setRotateButtonMask

getRotateButtonMask

setTranslateButtonMask

getTranslateButtonMask

setZoomButtonMask

getZoomButtonMask

setMouseWheelZoomScale

getMouseWheelZoomScale

setSelectionButtonMask

getSelectionButtonMask

setMultipleSelectionMask

getMultipleSelectionMask

setEllipticDeselectMask

getEllipticDeselectMask

getDraggerConstrainMask

setDraggerConstrainMask

getDraggerRepositionMask

setDraggerRepositionMask

setDraggerDragMask

getDraggerDragMask

setEllipticCursorResizeMask

getEllipticCursorResizeMask

setSelectVisibleOnly

isSelectVisibleOnly

setLaptopConfig