ViewpointControl (Unidata IDV API v6.3)

java.lang.Object
- ucar.unidata.view.geoloc.ViewpointControl

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener
```
public class ViewpointControl
extends java.lang.Object
implements java.awt.event.ActionListener
```
This class has a menu and ToolBar to control the viewpoint of a 3D display.

Version:

$Revision: 1.31 $

Author:

IDV Development team

Constructor Summary

Constructors
Constructor and Description

ViewpointControl(NavigatedDisplay navDisplay)
Construct a new ViewpointControl for the NavigatedDisplay.

Constructors
Constructor and Description
`ViewpointControl(NavigatedDisplay navDisplay)` Construct a new ViewpointControl for the NavigatedDisplay.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent ae)` Handle the action
`protected void`	`applyVerticalRange(VertScaleInfo transfer)` Apply the vertical range information
`protected void`	`applyVerticalScale(VertScaleInfo transfer)` Deprecated. see `applyVerticalRange(VertScaleInfo)`
`void`	`changeAutoRotate(boolean v)` A method that is called when the user changes the state of autorotation through the menu or button.
`void`	`changeEyePosition()` Change the eye position for stereo systems
`void`	`changePerspectiveView(boolean v)` A method that is called when the user changes the perspective view through the menu or button.
`void`	`changeVerticalRange(VertScaleInfo transfer)` Change the vertical range
`void`	`changeVerticalScale(VertScaleInfo transfer)` Deprecated. see `changeVerticalRange(VertScaleInfo)`
`boolean`	`getAutoRotate()` Get whether the display should autorotate or not
`double`	`getEyePosition()` Get the eye position
`javax.swing.JMenu`	`getMenu()` Make a Viewpoint controls menu
`boolean`	`getPerspectiveView()` Get whether the view is perspective or parallel.
`javax.swing.JToolBar`	`getToolBar()` Make a Viewpoint controls toolbar.
`javax.swing.JToolBar`	`getToolBar(boolean floatable)` Make a Viewpoint controls toolbar.
`javax.swing.JToolBar`	`getToolBar(boolean floatable, int orientation)` Make a Viewpoint controls toolbar.
`javax.swing.JToolBar`	`getToolBar(int orientation)` Make a Viewpoint controls toolbar.
`ViewpointInfo`	`getViewpointInfo()` Get the view point information.
`protected VertScaleInfo`	`getVsi()`
`protected javax.swing.JMenu`	`makeMenu()` Make the view point controls menu.
`protected javax.swing.JToolBar`	`makeToolBar()` Make the toolbar for this control.
`protected javax.swing.JToolBar`	`makeToolBar(boolean floatable)` Make the toolbar for this control.
`void`	`makeVerticalRangeMenuItem(javax.swing.JMenu viewMenu)` Add the vertical range menu item to the menu
`VertScaleDialog`	`makeVerticalRangeWidget(boolean visible)` Make the vertical range widget
`void`	`makeVerticalScaleMenuItem(javax.swing.JMenu viewMenu)` Deprecated. see `makeVerticalRangeMenuItem(JMenu)`
`VertScaleDialog`	`makeVerticalScaleWidget(boolean visible)` Deprecated. see `makeVerticalRangeWidget(boolean)`
`ViewpointInfo`	`rotateViewpoint(ViewpointInfo transfer)` Rotate the viewpoint to the parameters in `transfer`
`void`	`setAutoRotate(boolean rotate)` Set the auto rotate value
`void`	`setBottomView()` Set the view to the bottom.
`void`	`setEastView()` Set the view to the east.
`void`	`setEyePosition(double position)` Set the eye position
`void`	`setNorthView()` Set the view to the north.
`void`	`setPerspectiveView(boolean perspective)` Set the perspective view.
`void`	`setRotate(java.lang.String dir)` Set the rotate direction
`void`	`setSouthView()` Set the view to the south.
`void`	`setTopView()` Set the view to the top.
`void`	`setViewpointInfo(ViewpointInfo vpi)` Set the view point information
`void`	`setWestView()` Set the view to the west.

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

- Constructor Detail
  - ViewpointControl
```
public ViewpointControl(NavigatedDisplay navDisplay)
```
    Construct a new ViewpointControl for the NavigatedDisplay.
    
    Parameters:
    
    navDisplay - display to use (cannot be null)
- Method Detail
  - getToolBar
```
public javax.swing.JToolBar getToolBar()
```
    Make a Viewpoint controls toolbar.
    
    Returns:
    
    the toolbar
  - getToolBar
```
public javax.swing.JToolBar getToolBar(int orientation)
```
    Make a Viewpoint controls toolbar.
    
    Parameters:
    
    orientation - JToolBar.VERTICAL or JToolBar.HORIZONTAL
    
    Returns:
    
    the toolbar
  - getToolBar
```
public javax.swing.JToolBar getToolBar(boolean floatable)
```
    Make a Viewpoint controls toolbar.
    
    Parameters:
    
    floatable - Is the toolbar floatable
    
    Returns:
    
    the toolbar
  - getToolBar
```
public javax.swing.JToolBar getToolBar(boolean floatable,
                                       int orientation)
```
    Make a Viewpoint controls toolbar.
    
    Parameters:
    
    floatable - Is the toolbar floatable
    
    orientation - JToolBar.VERTICAL or JToolBar.HORIZONTAL
    
    Returns:
    
    the toolbar
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent ae)
```
    Handle the action
    
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
    
    Parameters:
    
    ae - The action
  - makeToolBar
```
protected javax.swing.JToolBar makeToolBar()
```
    Make the toolbar for this control.
    
    Returns:
    
    the toolbar
  - makeToolBar
```
protected javax.swing.JToolBar makeToolBar(boolean floatable)
```
    Make the toolbar for this control.
    
    Parameters:
    
    floatable - Is the toolbar floatable
    
    Returns:
    
    the toolbar
  - setRotate
```
public void setRotate(java.lang.String dir)
```
    Set the rotate direction
    
    Parameters:
    
    dir - the direction
  - getMenu
```
public javax.swing.JMenu getMenu()
```
    Make a Viewpoint controls menu
    
    Returns:
    
    the menu
  - makeMenu
```
protected javax.swing.JMenu makeMenu()
```
    Make the view point controls menu.
    
    Returns:
    
    the menu
  - makeVerticalScaleMenuItem
```
public void makeVerticalScaleMenuItem(javax.swing.JMenu viewMenu)
```
    Deprecated. see makeVerticalRangeMenuItem(JMenu)
    
    Add the vertical scale menu item to the menu
    
    Parameters:
    
    viewMenu - Menu to add item to
  - makeVerticalRangeMenuItem
```
public void makeVerticalRangeMenuItem(javax.swing.JMenu viewMenu)
```
    Add the vertical range menu item to the menu
    
    Parameters:
    
    viewMenu - Menu to add item to
  - setTopView
```
public void setTopView()
```
    Set the view to the top.
  - setBottomView
```
public void setBottomView()
```
    Set the view to the bottom.
  - setNorthView
```
public void setNorthView()
```
    Set the view to the north.
  - setSouthView
```
public void setSouthView()
```
    Set the view to the south.
  - setEastView
```
public void setEastView()
```
    Set the view to the east.
  - setWestView
```
public void setWestView()
```
    Set the view to the west.
  - setEyePosition
```
public void setEyePosition(double position)
```
    Set the eye position
    
    Parameters:
    
    position - the eye position
  - getEyePosition
```
public double getEyePosition()
```
    Get the eye position
    
    Returns:
    
    the eye position
  - changeEyePosition
```
public void changeEyePosition()
```
    Change the eye position for stereo systems
  - getPerspectiveView
```
public boolean getPerspectiveView()
```
    Get whether the view is perspective or parallel.
    
    Returns:
    
    true if perspective
  - changePerspectiveView
```
public void changePerspectiveView(boolean v)
```
    A method that is called when the user changes the perspective view through the menu or button. It can be overridden so other code can be notified.
    
    Parameters:
    
    v - true to set perspective view
  - setPerspectiveView
```
public void setPerspectiveView(boolean perspective)
```
    Set the perspective view.
    
    Parameters:
    
    perspective - true for perspective
  - getAutoRotate
```
public boolean getAutoRotate()
```
    Get whether the display should autorotate or not
    
    Returns:
    
    true if autorotate
  - changeAutoRotate
```
public void changeAutoRotate(boolean v)
```
    A method that is called when the user changes the state of autorotation through the menu or button. It can be overridden so other code can be notified.
    
    Parameters:
    
    v - true to set auto rotation
  - setAutoRotate
```
public void setAutoRotate(boolean rotate)
```
    Set the auto rotate value
    
    Parameters:
    
    rotate - true to rotate
  - rotateViewpoint
```
public ViewpointInfo rotateViewpoint(ViewpointInfo transfer)
```
    Rotate the viewpoint to the parameters in transfer
    
    Parameters:
    
    transfer - holder of the new view point information
    
    Returns:
    
    the transfer
  - getViewpointInfo
```
public ViewpointInfo getViewpointInfo()
```
    Get the view point information.
    
    Returns:
    
    the view point information
  - setViewpointInfo
```
public void setViewpointInfo(ViewpointInfo vpi)
```
    Set the view point information
    
    Parameters:
    
    vpi - new view point info
  - getVsi
```
protected VertScaleInfo getVsi()
```
    Returns:
    
    the vsi
  - makeVerticalScaleWidget
```
public VertScaleDialog makeVerticalScaleWidget(boolean visible)
```
    Deprecated. see makeVerticalRangeWidget(boolean)
    
    Make the vertical scale widget
    
    Parameters:
    
    visible - true to be visible
    
    Returns:
    
    vertical scale widget
  - makeVerticalRangeWidget
```
public VertScaleDialog makeVerticalRangeWidget(boolean visible)
```
    Make the vertical range widget
    
    Parameters:
    
    visible - true to be visible
    
    Returns:
    
    vertical range widget
  - changeVerticalScale
```
public void changeVerticalScale(VertScaleInfo transfer)
```
    Deprecated. see changeVerticalRange(VertScaleInfo)
    
    Change the vertical scale
    
    Parameters:
    
    transfer - vertical scale information
  - changeVerticalRange
```
public void changeVerticalRange(VertScaleInfo transfer)
```
    Change the vertical range
    
    Parameters:
    
    transfer - vertical range information
  - applyVerticalScale
```
protected void applyVerticalScale(VertScaleInfo transfer)
                           throws java.lang.Exception
```
    Deprecated. see applyVerticalRange(VertScaleInfo)
    
    Apply the vertical scale
    
    Parameters:
    
    transfer - The info
    
    Throws:
    
    java.lang.Exception - On badness
  - applyVerticalRange
```
protected void applyVerticalRange(VertScaleInfo transfer)
                           throws java.lang.Exception
```
    Apply the vertical range information
    
    Parameters:
    
    transfer - The info
    
    Throws:
    
    java.lang.Exception - On badness

Class ViewpointControl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ViewpointControl

Method Detail

getToolBar

getToolBar

getToolBar

getToolBar

actionPerformed

makeToolBar

makeToolBar

setRotate

getMenu

makeMenu

makeVerticalScaleMenuItem

makeVerticalRangeMenuItem

setTopView

setBottomView

setNorthView

setSouthView

setEastView

setWestView

setEyePosition

getEyePosition

changeEyePosition

getPerspectiveView

changePerspectiveView

setPerspectiveView

getAutoRotate

changeAutoRotate

setAutoRotate

rotateViewpoint

getViewpointInfo

setViewpointInfo

getVsi

makeVerticalScaleWidget

makeVerticalRangeWidget

changeVerticalScale

changeVerticalRange

applyVerticalScale

applyVerticalRange