Application: gvSIG desktop » gvSIG 3D

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2015 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.view3d.swing.api;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.fmap.mapcontext.ViewPort;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.swing.api.Component;

import org.gvsig.tools.task.Cancellable;

import org.gvsig.view3d.swing.api.View3DSwingManager.TYPE;

import org.gvsig.view3d.swing.api.properties.MapControlProperties3D;

/**

 * A component that includes a {@link MapContext} and a

 * {@link WorldWindowGLJPanel}.

 * 

 * <code>MapContext</code> is used to:

 * <ul>

 * <li>Get layers to convert them to {@link Layer}. When <code>MapContext</code>

 * layers are converted, they are added to WorldWindowGLJPanel to display it.</li>

 * <li>Get {@link ViewPort} to synchronize view ports.</li>

 * </ul>

 * 

 * <code>WorldWindowGLJPanel</code> is used to display WW Models (globe and

 * layers). It's a self-contained component intended to serve as an

 * application's WorldWindow.

 * 

 * This component offers methods to:

 * <ul>

 * <li>Get shared object to cancel draw request. See

 * {@link MapControl3D#getCancellable()}</li>

 * <li>Get and set associated <code>MapContext</code>. See

 * {@link MapControl3D#getMapContext()}</li>

 * <li>Get and set vertical exaggeration of WW Model. See

 * {@link MapControl3D#getVerticalExaggeration()} and

 * {@link MapControl3D#setVerticalExaggeration(double)}</li>

 * <li>Get and set atmosphere layer. See {@link MapControl3D#getAtmosphereVisibility()}

 * and {@link MapControl3D#setAtmosphereVisibility(boolean)}</li>

 * <li>Get and set Minimap component layer. See

 * {@link MapControl3D#getMinimapVisibility()} and {@link MapControl3D#setMiniMapVisibility(boolean)}</li>

 * <li>Get and set North indicator component layer. See

 * {@link MapControl3D#getNorthIndicatorVisibility()} and

 * {@link MapControl3D#setNorthIndicatorVisibility(boolean)}</li>

 * <li>Get and set scale component layer. See {@link MapControl3D#getScaleVisibility()}

 * and {@link MapControl3D#setScaleVisibility(boolean)}</li>

 * <li>Get and set star background layer. See

 * {@link MapControl3D#getStarBackgroundVisibility()} and

 * {@link MapControl3D#setStarsBackgroundVisibility(boolean)}</li>

 * <li>Synchronize view ports. See {@link MapControl3D#synchronizeViewPorts()}</li>

 * <li>Reload layers. There are two methos to reload layers. The first methos is

 * {@link MapControl3D#synchronizeLayers()} that only reload layers with chages.

 * The second methos is {@link MapControl3D#reloadLayers()} that reload all

 * layers of <code>MapContext</code></li>

 * </ul>

 * 

 * @author <a href="mailto:lmarques@disid.com">Lluis Marques</a>

 *

 */

@SuppressWarnings("deprecation")

public interface MapControl3D extends Component, Disposable, Observable {

    /**

     * Notification that notifies just before that this

     * <code>MapControl3D</code>is diposed.

     */

    static final String BEFORE_DISPOSE_MAPCONTEX3D_NOTIFICATION =

        "MapControl3D.beforeDisposePanel";

    /**

     * Notification that notifies just after that this <code>MapControl3D</code>

     * is

     * diposed.

     */

    static final String AFTER_DISPOSE_MAPCONTEX3D_NOTIFICATION =

        "MapControl3D.afterDisposePanel";

    /**

     * Gets shared object to cancel draw of loaded layers. To cancel draw use

     * set

     * canceled <code>true</code> with {@link Cancellable#setCanceled(boolean)}

     * 

     * Note: {@link Cancellable} is deprecated but we have to use it because

     * {@link FLayer#draw(java.awt.image.BufferedImage, java.awt.Graphics2D, org.gvsig.fmap.mapcontext.ViewPort, Cancellable, double)}

     * use it.

     * @return A shared Cancellable object 

     * 

     * @see Cancellable

     */

    public Cancellable getCancellable();

    /**

     * @return Gets the <code>MapContext</code> associated.

     * 

     */

    public MapContext getMapContext();

    /**

     * @return Gets {@link TYPE} of this <code>MapControl3D</code>.

     */

    public TYPE getType();

    /**

     * @return Gets 3D MapControl properties of this MapControl3D. 

     */

    public MapControlProperties3D getProperties();

    /**

     * @return Gets vertical exaggeration model of this <code>MapControl3D</code>.

     * 

     * @see MapControl3D#setVerticalExaggeration(double)

     */

    public double getVerticalExaggeration();

    /**

     * Sets Atmosphere visibility.

     * @param visibility 

     * 

     * @see MapControl3D#getAtmosphereVisibility()

     */

    public void setAtmosphereVisibility(boolean visibility);

    /**

     * Sets MiniMap visibility.

     * @param visibility 

     * 

     * @see MapControl3D#getMinimapVisibility()

     */

    public void setMiniMapVisibility(boolean visibility);

    /**

     * Sets North Indicator visibility.

     * @param visibility 

     * 

     * @see MapControl3D#getNorthIndicatorVisibility()

     */

    public void setNorthIndicatorVisibility(boolean visibility);

    /**

     * Sets Scale visibility.

     * @param visibility 

     * 

     * @see MapControl3D#getScaleVisibility()

     */

    public void setScaleVisibility(boolean visibility);

    /**

     * Sets Star background visibility.

     * @param visibility 

     * 

     * @see MapControl3D#getStarBackgroundVisibility()

     */

    public void setStarsBackgroundVisibility(boolean visibility);

    /**

     * @return Gets Atmosphere visibility.

     *  

     * @see MapControl3D#getAtmosphereVisibility()

     */

    public boolean getAtmosphereVisibility();

    /**

     * @return Gets Minimap visibility.

     * 

     * @see MapControl3D#getMinimapVisibility()

     */

    public boolean getMinimapVisibility();

    /**

     * @return Gets North indicator visibility. 

     * 

     * @see MapControl3D#getNorthIndicatorVisibility()

     */

    public boolean getNorthIndicatorVisibility();

    /**

     * @return Gets Star background visibility. 

     * 

     * @see MapControl3D#getStarBackgroundVisibility()

     */

    public boolean getStarBackgroundVisibility();

    /**

     * @return Gets Scale visibility.

     * 

     * @see MapControl3D#getScaleVisibility()

     */

    public boolean getScaleVisibility();

    /**

     * Forces reload all layers of <code>MapContext</code> associated.

     * 

     * @see {@link MapControl3D#synchronizeLayers()}

     */

    public void reloadLayers();

    /**

     * Synchronize view of <code>MapControl3D</code> with view port of

     * <code>MapContext</code> associated.

     */

    public void synchronizeViewPorts();

    /**

     * Gets underline component that MapControl3D implementation is based on. 

     * 

     * @return UnderLine object 

     */

    public Object getUnderLineComponent();

}