Application: gvSIG desktop » gvSIG 3D

package org.gvsig.view3d.swing.api.properties;

import java.beans.PropertyChangeListener;

import org.gvsig.tools.persistence.Persistent;

import org.gvsig.view3d.swing.api.MapControl3D;

/**

 * This class represents the properties of {@link MapControl3D}.

 * 

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

 *

 */

public interface MapControlProperties3D extends Persistent{

    public static final String PERSISTENCE_NAME = "MapControl3DProperties";

    public final String SPHERE_VERTICAL_EXAGGERATION_PROPERTY_NAME =

        "sphereVerticalExaggeration";

    public final String FLAT_VERTICAL_EXAGGERATION_PROPERTY_NAME =

        "flatVerticalExaggeration";

    public final String AUTO_LAYER_SYNCHRONIZE_PROPERTY_NAME =

        "autoLayerSynchronize";

    public final String AUTO_VIEWPORT_SYNCHRONIZE_PROPERTY_NAME =

        "autoViewPortSynchronize";

    public final String BLUE_MARBEL_VISIBILITY_PROPERTY_NAME =

        "blueMarbelLayerVisibility";

    public final String NASA_LANDSAT_VISIBILITY_PROPERTY_NAME =

        "nasaLandsatLayerVisibility";

    public final String DEFAULT_ELEVATION_VISIBILITY_PROPERTY_NAME =

        "defaultElevationVisibility";

    /**

     * Adds {@link PropertyChangeListener} that will listen properties changes.

     * 

     * @param listener

     */

    public void addPropertyChangeListener(PropertyChangeListener listener);

    /**

     * Gets if auto layer synchronize is active or not.

     * 

     * @see MapControlProperties3D#setAutoLayerSynchronize(boolean)

     * @return

     */

    public boolean getAutoLayerSynchronize();

    /**

     * Gets if auto view synchronize is active or not

     * 

     * @see MapControlProperties3D#setAutoViewPortSynchronize(boolean)

     * @return

     */

    public boolean getAutoViewPortSynchronize();

    /**

     * Gets visibility of Blue Marble layer. 

     * 

     * @see MapControlProperties3D#setBlueMarbleLayerVisibility(boolean)

     * @return

     */

    public boolean getBlueMarbleLayerVisibility();

    /**

     * Gets visiblity of default elevation.

     * 

     * @see MapControlProperties3D#setDefaultElevationVisibility(boolean)

     * @return

     */

    public boolean getDefaultElevationVisibility();

    /**

     * Get vertical exaggeration of flat view

     * 

     * @see MapControlProperties3D#setFlatVerticalExaggeration(double)

     * @return

     */

    public double getFlatVerticalExaggeration();

    /**

     * Gets visibility of Nasa Landsat Layer

     * 

     * @see MapControlProperties3D#setNasaLandsatVisibility(boolean)

     * @return

     */

    public boolean getNasaLandsatLayerVisibility();

    /**

     * Gets vertical exaggeration of sphere view

     * 

     * @see MapControlProperties3D#setSphereVerticalExaggeration(double)

     * @return

     */

    public double getSphereVerticalExaggeration();

    /**

     * Removes {@link PropertyChangeListener}.

     * 

     * @see MapControlProperties3D#addPropertyChangeListener(PropertyChangeListener)

     * @param listener

     */

    public void removePropertyChangeListener(PropertyChangeListener listener);

    /**

     * Set auto layer synchronize.

     * 

     * @param flag True to active auto layer synchronize, false to disable it.

     * @see MapControlProperties3D#getAutoLayerSynchronize()

     */

    public void setAutoLayerSynchronize(boolean flag);

    /**

     * Set auto viesport synchronize.

     * 

     * @param flag True to active auto viewport synchronize, false to disable it.

     * @see MapControlProperties3D#getAutoViewSynchronize()

     */

    public void setAutoViewPortSynchronize(boolean flag);

    /**

     * Sets visibility of BlueMarble layer.

     * 

     * @param visibility

     * @see MapControlProperties3D#getBlueMarbleLayerVisibility()

     */

    public void setBlueMarbleLayerVisibility(boolean visibility);

    /**

     * Sets visibility of deafult elevation.

     * 

     * @param visibility

     * @see MapControlProperties3D#getDefaultElevationVisibility()

     */

    public void setDefaultElevationVisibility(boolean visibility);

    /**

     * Sets flat vertical exaggeration.

     * 

     * @param value

     * @see MapControlProperties3D#getFlatVerticalExaggeration()

     */

    public void setFlatVerticalExaggeration(double value);

    /**

     * Sets Nasa Landsat visibility.

     * 

     * @param visibility

     * @see MapControlProperties3D#getNasaLandsatLayerVisibility()

     */

    public void setNasaLandsatVisibility(boolean visibility);

    /**

     * Sets sphere vertical exaggeration.

     * 

     * @param value

     * @see MapControlProperties3D#getSphereVerticalExaggeration()

     */

    public void setSphereVerticalExaggeration(double value);

}