NASA World Wind

gov.nasa.worldwind.view.orbit
Interface OrbitView

All Superinterfaces:
AVList, EventListener, MessageListener, PropertyChangeListener, Restorable, View, WWObject
All Known Implementing Classes:
BasicOrbitView, FlatOrbitView

public interface OrbitView
extends View


Field Summary
static String CENTER_STOPPED
           
 
Fields inherited from interface gov.nasa.worldwind.View
VIEW_STOPPED
 
Method Summary
 boolean canFocusOnViewportCenter()
          Implementations are expected to determines if the OrbitView can set the center of rotation for heading and pitch changes to the viewport center intersection with the globe surface via a call to focusOnViewportCenter().
 void focusOnViewportCenter()
          Implementations are expected to set the center of rotation for heading and pitch at the intersection of a ray originates at the eye, and passes through the center of the viewport with the globe surface.
 Position getCenterPosition()
          Get the center position of the OrbitView.
 OrbitViewLimits getOrbitViewLimits()
          Get the limits for this OrbitView.
 double getZoom()
          Get the zoom value for the OrbitView.
 boolean hadCollisions()
          Returns whether or not a collision has occurred since the last call to hadCollisions.
 boolean isDetectCollisions()
          Returns whether the this View will detect collisions with other objects, such as the surface geometry.
 void setCenterPosition(Position center)
          Sets the center position of the OrbitView.
 void setDetectCollisions(boolean detectCollisions)
          Sets whether or not this View will detect collisions with other objects, such as the surface geometry.
 void setOrbitViewLimits(OrbitViewLimits limits)
          Set the limits for this OrbitView.
 void setZoom(double zoom)
          Set the zoom value for the OrbitVeiw.
 void stopMovementOnCenter()
          Stop any changes to the center position.
 
Methods inherited from interface gov.nasa.worldwind.View
addAnimator, apply, computePixelSizeAtDistance, computePositionFromScreenPoint, computeRayFromScreenPoint, copyViewState, getCenterPoint, getCurrentEyePoint, getCurrentEyePosition, getEyePoint, getEyePosition, getFarClipDistance, getFieldOfView, getForwardVector, getFrustum, getFrustumInModelCoordinates, getGlobe, getHeading, getHorizonDistance, getModelviewMatrix, getNearClipDistance, getPitch, getProjectionMatrix, getRoll, getUpVector, getViewInputHandler, getViewport, getViewPropertyLimits, getViewStateID, goTo, isAnimating, popReferenceCenter, project, pushReferenceCenter, setEyePosition, setFieldOfView, setHeading, setOrientation, setPitch, setReferenceCenter, setRoll, stopAnimations, stopMovement, unProject
 
Methods inherited from interface gov.nasa.worldwind.avlist.AVList
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues
 
Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
 
Methods inherited from interface gov.nasa.worldwind.event.MessageListener
onMessage
 
Methods inherited from interface gov.nasa.worldwind.Restorable
getRestorableState, restoreState
 

Field Detail

CENTER_STOPPED

static final String CENTER_STOPPED
See Also:
Constant Field Values
Method Detail

canFocusOnViewportCenter

boolean canFocusOnViewportCenter()
Implementations are expected to determines if the OrbitView can set the center of rotation for heading and pitch changes to the viewport center intersection with the globe surface via a call to focusOnViewportCenter().

Returns:
true if the OrbitView implementation can focus on the viewport center.

focusOnViewportCenter

void focusOnViewportCenter()
Implementations are expected to set the center of rotation for heading and pitch at the intersection of a ray originates at the eye, and passes through the center of the viewport with the globe surface.


getCenterPosition

Position getCenterPosition()
Get the center position of the OrbitView. The center position is used as the point about which the heading and pitch rotate. It is defined by the intersection of a ray from the eye position through the center of the viewport with the surface of the globe.

Returns:
the center position.

getOrbitViewLimits

OrbitViewLimits getOrbitViewLimits()
Get the limits for this OrbitView. OrbitView has state values that augment the state values of a View. Specifically, zoom and center position. OrbitViewLimits enables the limiting of those values in addition the the derived BasicViewPropertyLimits state.

Returns:
The active view limits.

getZoom

double getZoom()
Get the zoom value for the OrbitView. The zoom value is the distance between the eye position and the center position.

Returns:
the zoom value

hadCollisions

boolean hadCollisions()
Returns whether or not a collision has occurred since the last call to hadCollisions. If isDetectCollisions() is false, collisions will not be detected and hadCollisions will always return false.

Returns:
true if a collision has occurred since the last call; false otherwise.

isDetectCollisions

boolean isDetectCollisions()
Returns whether the this View will detect collisions with other objects, such as the surface geometry. If true, implementations may also automatically resolve any detected collisions.

Returns:
true If this View will detect collisions; false otherwise.

setCenterPosition

void setCenterPosition(Position center)
Sets the center position of the OrbitView. The center position is used as the point about which the heading and pitch rotate. It is defined by the intersection of a ray from the eye position through the center of the viewport with the surface of the globe.

Parameters:
center -

setDetectCollisions

void setDetectCollisions(boolean detectCollisions)
Sets whether or not this View will detect collisions with other objects, such as the surface geometry. If detectCollisions is true, implementations may also automatically resolve any detected collisions.

Parameters:
detectCollisions - If true, this View will resolve collisions; otherwise this View will ignore collisions.

setOrbitViewLimits

void setOrbitViewLimits(OrbitViewLimits limits)
Set the limits for this OrbitView. OrbitView has state values that augment the state values of a View. Specifically, zoom and center position. OrbitViewLimits enables the limiting of those values in addition the the derived BasicViewPropertyLimits state.

Parameters:
limits -

setZoom

void setZoom(double zoom)
Set the zoom value for the OrbitVeiw. The zoom value is the distance between the eye position and the center position.

Parameters:
zoom -

stopMovementOnCenter

void stopMovementOnCenter()
Stop any changes to the center position.


NASA World Wind