Package gov.nasa.worldwind.view.orbit

Interface OrbitViewLimits

All Superinterfaces:

ViewPropertyLimits

All Known Implementing Classes:

BasicOrbitViewLimits

public interface OrbitViewLimits
extends ViewPropertyLimits

OrbitViewLimits extends the ViewPropertyLimits interface to include restrictions on the viewing parameters of an OrbitView.

Method Summary

Modifier and Type	Method	Description
double[]	getCenterElevationLimits()	Returns the minimum and maximum values for the orbit view center elevation.
Sector	getCenterLocationLimits()	Returns the Sector which limits the orbit view center latitude and longitude.
double[]	getZoomLimits()	Returns the minimum and maximum values for the orbit view zoom property.
Position	limitCenterPosition(View view, Position position)	Returns a position clamped to the center location limits and center elevation limits specified by this limit object.
double	limitZoom(View view, double value)	Returns a distance clamped to the zoom limits specified by this limit object.
void	setCenterElevationLimits(double minValue, double maxValue)	Sets the minimum and maximum values which will limit the orbit view center elevation.
void	setCenterLocationLimits(Sector sector)	Sets the Sector which will limit the orbit view center latitude and longitude.
void	setZoomLimits(double minValue, double maxValue)	Sets the minimum and maximum values which will limit the orbit view zoom property.

Methods inherited from interface gov.nasa.worldwind.view.ViewPropertyLimits

getEyeElevationLimits, getEyeLocationLimits, getHeadingLimits, getPitchLimits, getRestorableState, getRollLimits, limitEyePosition, limitHeading, limitPitch, limitRoll, reset, restoreState, setEyeElevationLimits, setEyeLocationLimits, setHeadingLimits, setPitchLimits, setRollLimits

Method Detail

getCenterLocationLimits

Sector getCenterLocationLimits()

Returns the Sector which limits the orbit view center latitude and longitude.

Returns:

Sector which limits the center latitude and longitude.

setCenterLocationLimits

void setCenterLocationLimits(Sector sector)

Sets the Sector which will limit the orbit view center latitude and longitude.

Parameters:

sector - Sector which will limit the center latitude and longitude.

Throws:

java.lang.IllegalArgumentException - if sector is null.

getCenterElevationLimits

double[] getCenterElevationLimits()

Returns the minimum and maximum values for the orbit view center elevation.

Returns:

Minimum and maximum allowable values for center elevation.

setCenterElevationLimits

void setCenterElevationLimits(double minValue,
                              double maxValue)

Sets the minimum and maximum values which will limit the orbit view center elevation.

Parameters:

minValue - the minimum allowable value for center elevation.

maxValue - the maximum allowable value for center elevation.

getZoomLimits

double[] getZoomLimits()

Returns the minimum and maximum values for the orbit view zoom property.

Returns:

Minimum and maximum allowable values for zoom.

setZoomLimits

void setZoomLimits(double minValue,
                   double maxValue)

Sets the minimum and maximum values which will limit the orbit view zoom property.

Parameters:

minValue - the mimimum allowable value for zoom.

maxValue - the maximum allowable value for zoom.

limitCenterPosition

Position limitCenterPosition(View view,
                             Position position)

Returns a position clamped to the center location limits and center elevation limits specified by this limit object. This method does not modify the specified view's properties, but may use the view as a context for determining how to apply the limits.

Parameters:

view - the view associated with the center position and the property limits.

position - position to clamp to the allowed range.

Returns:

The clamped position.

Throws:

java.lang.IllegalArgumentException - if any argument is null.

limitZoom

double limitZoom(View view,
                 double value)

Returns a distance clamped to the zoom limits specified by this limit object. This method does not modify the specified view's properties, but may use the view as a context for determining how to apply the limits.

Parameters:

view - the view associated with the zoom distance and the property limits.

value - zoom distance to clamp to the allowed range.

Returns:

The clamped value.

Throws:

java.lang.IllegalArgumentException - if any argument is null.