Field Detail

• overlay

  protected OverlayTransform overlay

  Associated overlay transform.

• name

  protected String name

  Name of this tool.

• tip

  protected String tip

  Tool tip text.

• icon

  protected String icon

  Filename of icon.

Constructor Detail

• OverlayTool

  public OverlayTool(OverlayTransform overlay,
                     String name,
                     String tip,
                     String icon)

  Constructs a measurement line creation tool.

Method Detail

• mouseDown

  public void mouseDown(DisplayEvent e,
                        int px,
                        int py,
                        float dx,
                        float dy,
                        int[] pos,
                        int mods)

  Instructs this tool to respond to a mouse press.

  Parameters:

  e - DisplayEvent corresponding to this mouse press.

  px - X coordinate of mouse press in pixel coordinate system.

  py - Y coordinate of mouse press in pixel coordinate system.

  dx - X coordinate of mouse press in data coordinate system.

  dy - Y coordinate of mouse press in data coordinate system.

  pos - Dimensional position of mouse press.

  mods - Modifiers of mouse press.

• mouseUp

  public void mouseUp(DisplayEvent e,
                      int px,
                      int py,
                      float dx,
                      float dy,
                      int[] pos,
                      int mods)

  Instructs this tool to respond to a mouse release.

  Parameters:

  e - DisplayEvent corresponding to this mouse release.

  px - X coordinate of mouse release in pixel coordinate system.

  py - Y coordinate of mouse release in pixel coordinate system.

  dx - X coordinate of mouse release in data coordinate system.

  dy - Y coordinate of mouse release in data coordinate system.

  pos - Dimensional position of mouse release.

  mods - Modifiers of mouse release.

• mouseDrag

  public void mouseDrag(DisplayEvent e,
                        int px,
                        int py,
                        float dx,
                        float dy,
                        int[] pos,
                        int mods)

  Instructs this tool to respond to a mouse drag.

  Parameters:

  e - DisplayEvent corresponding to this mouse drag.

  px - X coordinate of mouse drag in pixel coordinate system.

  py - Y coordinate of mouse drag in pixel coordinate system.

  dx - X coordinate of mouse drag in data coordinate system.

  dy - Y coordinate of mouse drag in data coordinate system.

  pos - Dimensional position of mouse drag.

  mods - Modifiers of mouse drag.

• mouseMoved

  public void mouseMoved(DisplayEvent e,
                         int px,
                         int py,
                         float dx,
                         float dy,
                         int[] pos,
                         int mods)

  Instructs this tool to respond to mouse movement.

  Parameters:

  e - DisplayEvent corresponding to this mouse movement.

  px - X coordinate of mouse movement in pixel coordinate system.

  py - Y coordinate of mouse movement in pixel coordinate system.

  dx - X coordinate of mouse movement in data coordinate system.

  dy - Y coordinate of mouse movement in data coordinate system.

  pos - Dimensional position of mouse movement.

  mods - Modifiers of mouse movement.

• keyPressed

  public void keyPressed(int code,
                         int mods)

  Instructs this tool to respond to a key press.

  Parameters:

  code - Key code of pressed key.

  mods - Modifiers of pressed key.

• keyReleased

  public void keyReleased(int code,
                          int mods)

  Instructs this tool to respond to a key release.

  Parameters:

  code - Key code of released key.

  mods - Modifiers of released key.

• getTransform

  public OverlayTransform getTransform()

  Gets associated overlay transform.

• getName

  public String getName()

  Gets tool name.

• getTip

  public String getTip()

  Gets tool tip text.

• getIcon

  public String getIcon()

  Gets path to icon file.

• deselectAll

  protected void deselectAll()

  Deselect all selected overlays.