NASA World Wind

gov.nasa.worldwind.view
Interface ViewPropertyLimits

All Known Subinterfaces:
OrbitViewLimits
All Known Implementing Classes:
BasicOrbitViewLimits, BasicViewPropertyLimits, FlyViewLimits

public interface ViewPropertyLimits


Method Summary
 double[] getEyeElevationLimits()
          Returns the minimum and maximum values for the View elevation.
 Sector getEyeLocationLimits()
          Returns the Sector which limits the View eye position latitude and longitude.
 Angle[] getHeadingLimits()
          Returns the minimum and maximum Angles for the OrbitView heading property.
 Angle[] getPitchLimits()
          Returns the minimum and maximum Angles for the OrbitView pitch property.
 void getRestorableState(RestorableSupport rs, RestorableSupport.StateObject context)
           
 Angle[] getRollLimits()
          Returns the minimum and maximum Angles for the OrbitView roll property.
 void restoreState(RestorableSupport rs, RestorableSupport.StateObject context)
           
 void setEyeElevationLimits(double minValue, double maxValue)
          Sets the minimum and maximum values for the View elevation.
 void setEyeLocationLimits(Sector sector)
          Sets the Sector which will limit the View eye position latitude and longitude.
 void setHeadingLimits(Angle minAngle, Angle maxAngle)
          Sets the minimum and maximum Angles which will limit the OrbitView heading property.
 void setPitchLimits(Angle minAngle, Angle maxAngle)
          Sets the minimum and maximum Angles which will limit the OrbitView pitch property.
 void setRollLimits(Angle minAngle, Angle maxAngle)
          Sets the minimum and maximum Angles which will limit the OrbitView roll property.
 

Method Detail

getEyeElevationLimits

double[] getEyeElevationLimits()
Returns the minimum and maximum values for the View elevation.

Returns:
minimum and maximum allowable values for the elevation.

getEyeLocationLimits

Sector getEyeLocationLimits()
Returns the Sector which limits the View eye position latitude and longitude.

Returns:
Sector which limits the eye position latitude and longitude.

getHeadingLimits

Angle[] getHeadingLimits()
Returns the minimum and maximum Angles for the OrbitView heading property.

Returns:
minimum and maximum allowable Angles for heading.

getPitchLimits

Angle[] getPitchLimits()
Returns the minimum and maximum Angles for the OrbitView pitch property.

Returns:
minimum and maximum allowable Angles for pitch.

getRestorableState

void getRestorableState(RestorableSupport rs,
                        RestorableSupport.StateObject context)

getRollLimits

Angle[] getRollLimits()
Returns the minimum and maximum Angles for the OrbitView roll property.

Returns:
minimum and maximum allowable Angles for roll.

restoreState

void restoreState(RestorableSupport rs,
                  RestorableSupport.StateObject context)

setEyeElevationLimits

void setEyeElevationLimits(double minValue,
                           double maxValue)
Sets the minimum and maximum values for the View elevation.

Parameters:
minValue - The minimum elevation.
maxValue - The maximum elevation.

setEyeLocationLimits

void setEyeLocationLimits(Sector sector)
Sets the Sector which will limit the View eye position latitude and longitude.

Parameters:
sector - Sector which will limit the eye position latitude and longitude.
Throws:
IllegalArgumentException - if sector is null.

setHeadingLimits

void setHeadingLimits(Angle minAngle,
                      Angle maxAngle)
Sets the minimum and maximum Angles which will limit the OrbitView heading property.

Parameters:
minAngle - the minimum allowable angle for heading.
maxAngle - the maximum allowable angle for heading.
Throws:
IllegalArgumentException - if either minAngle or maxAngle is null.

setPitchLimits

void setPitchLimits(Angle minAngle,
                    Angle maxAngle)
Sets the minimum and maximum Angles which will limit the OrbitView pitch property.

Parameters:
minAngle - the minimum allowable angle for pitch.
maxAngle - the maximum allowable angle for pitch.
Throws:
IllegalArgumentException - if either minAngle or maxAngle is null.

setRollLimits

void setRollLimits(Angle minAngle,
                   Angle maxAngle)
Sets the minimum and maximum Angles which will limit the OrbitView roll property.

Parameters:
minAngle - the minimum allowable angle for roll.
maxAngle - the maximum allowable angle for roll.
Throws:
IllegalArgumentException - if either minAngle or maxAngle is null.

NASA World Wind