gov.nasa.worldwind.view.orbit.OrbitView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwind-pcm Show documentation
worldwind-pcm
The newest version!
/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */
package gov.nasa.worldwind.view.orbit;

import gov.nasa.worldwind.View;
import gov.nasa.worldwind.geom.Position;

/**
 * @author dcollins
 * @version $Id: OrbitView.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public interface OrbitView extends View
{
     /**
     * 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.
     *
     * @return true If this View will detect collisions; false otherwise.
     */
    boolean isDetectCollisions();

    /**
     * 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.
     *
     * @param detectCollisions If true, this View will resolve collisions; otherwise this
     *                          View will ignore collisions.
     */
    void setDetectCollisions(boolean detectCollisions);

    /**
     * Returns whether or not a collision has occurred since the last call to hadCollisions.
     * If {@link #isDetectCollisions} is false, collisions will not be detected and
     * hadCollisions will always return false.
     *
     * @return true if a collision has occurred since the last call; false otherwise.
     */
    boolean hadCollisions();

    /**
     * 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.
     * @return the center position.
     */
    Position getCenterPosition();

    /**
     * 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.
     * @param center
     */
    void setCenterPosition(Position center);

    /**
     * Get the zoom value for the OrbitView.  The zoom value is the distance between the eye
     * position and the center position.
     * @return the zoom value
     */
    double getZoom();

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

    /**
     * Get the limits for this OrbitView.  OrbitView has state values that augment the state values of a {@link View}.
     * Specifically, zoom and center position.  {@link OrbitViewLimits} enables the limiting of those values in addition
     * the the derived {@link gov.nasa.worldwind.view.BasicViewPropertyLimits} state.
     *
     * @return The active view limits.
     */
    OrbitViewLimits getOrbitViewLimits();

    /**
     * Set the limits for this OrbitView.  OrbitView has state values that augment the state values of a {@link View}.
     * Specifically, zoom and center position.  {@link OrbitViewLimits} enables the limiting of those values in addition
     * the the derived {@link gov.nasa.worldwind.view.BasicViewPropertyLimits} state.
     * @param limits
     */
    void setOrbitViewLimits(OrbitViewLimits limits);

    /**
     * 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 {@link #focusOnViewportCenter}.
     * @return true if the OrbitView implementation can focus on the viewport center.
     **/
    boolean canFocusOnViewportCenter();

    /**
     * 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.
     */
    void focusOnViewportCenter();

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

    public static final String CENTER_STOPPED = "gov.nasa.worldwind.view.orbit.OrbitView.CenterStopped";
}