Application: gvSIG desktop » gvSIG 3D

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

import java.beans.PropertyChangeListener;

import java.io.File;

/**

 * This class represents the general properties of 3D library.

 * 

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

 *

 */

public interface GeneralProperties3D {

    public final static String DEFAULT_VIEW_HEIGHT_PROPERTY_NAME =

        "defaultViewHeight";

    public final static String DEFAULT_VIEW_WIDTH_PROPERTY_NAME =

        "defaultViewWidth";

    public final static String ATMOSPHERE_VISIBILITY_PROPERTY_NAME =

        "atmosphereVisibility";

    public final static String MINIMAP_VISIBILITY_PROPERTY_NAME =

        "minimapVisibility";

    public final static String NORTH_INDICATOR_VISIBILITY_PROPERTY_NAME =

        "northIndicatorVisibility";

    public final static String STARS_BACKGROUND_VISIBILITY_PROPERTY_NAME =

        "starsBackgroundVisibility";

    public final static String SCALE_VISIBILITY_PROPERTY_NAME =

        "scaleVisibility";

    public final static String VIEWPORT_ANIMATION_PROPERTY_NAME =

        "viewPortAnimation";

    public final static String CACHE_PATH_PROPERTY_NAME = "cachePath";

    /**

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

     * 

     * @param listener

     * @see GeneralProperties3D#removePropertyChangeListener(PropertyChangeListener)

     */

    public void addPropertyChangeListener(PropertyChangeListener listener);

    /**

     * Gets the atmosphere visibility.

     * 

     * @see GeneralProperties3D#setAtmosphereVisibility(boolean)

     * @return visibility of atmosphere component.

     */

    public boolean getAtmosphereVisibility();

    /**

     * Gets path of tile cache.

     * 

     * @see GeneralProperties3D#setCachePath(File)

     * @return

     */

    public File getCachePath();

    /**

     * Gets the default view heigth of 3D views.

     * 

     * @see GeneralProperties3D#setDefaultViewHeight(int)

     * @return Default height of 3D views.

     */

    public int getDefaultViewHeight();

    /**

     * Gets the default view width of 3D views.

     * 

     * @see GeneralProperties3D#setDefaultViewWidth(int)

     * @return Default width of 3D views.

     */

    public int getDefaultViewWidth();

    /**

     * Gets minimap visibility.

     * 

     * @see GeneralProperties3D#setMinimapVisibility(boolean)

     * @return Visibility of minimap.

     */

    public boolean getMinimapVisibility();

    /**

     * Gets north indicator visibility.

     * 

     * @see GeneralProperties3D#setNorthIndicatorVisibility(boolean)

     * @return Visibility of north indicator component.

     */

    public boolean getNorthIndicatorVisibility();

    /**

     * Get visibility of scale component.

     * 

     * @see GeneralProperties3D#setScaleVisibility(boolean)

     * @return Visibility of scale component.

     */

    public boolean getScaleVisibility();

    /**

     * Get starts background visibility.

     * 

     * @see GeneralProperties3D#setStarsBackgroundVisibility(boolean)

     * @return Visibility of starts background component.

     */

    public boolean getStarsBackgroundVisibility();

    /**

     * Gets if the view port synchronize is animated

     * 

     * @see GeneralProperties3D#setViewPortAnimation(boolean)

     * @return True if view port synchronize is animated, false if it is not

     *         animated.

     */

    public boolean getViewPortAnimation();

    /**

     * Removes {@link PropertyChangeListener}.

     * 

     * @param listener

     * @see GeneralProperties3D#addPropertyChangeListener(PropertyChangeListener)

     */

    public void removePropertyChangeListener(PropertyChangeListener listener);

    /**

     * Sets visibility of atmosphere component.

     * 

     * @param visibility

     * @see GeneralProperties3D#getAtmosphereVisibility()

     */

    public void setAtmosphereVisibility(boolean visibility);

    /**

     * Sets path of tile cache.

     * 

     * @param path

     * @see GeneralProperties3D#getCachePath()

     */

    public void setCachePath(File path);

    /**

     * Sets default view height.

     * 

     * @param height

     * @see GeneralProperties3D#getDefaultViewHeight()

     */

    public void setDefaultViewHeight(int height);

    /**

     * Sets default view width.

     * 

     * @param width

     * @see GeneralProperties3D#getDefaultViewWidth()

     */

    public void setDefaultViewWidth(int width);

    /**

     * Sets visibility of miniMap component.

     * 

     * @param visibility

     * @see GeneralProperties3D#getMinimapVisibility()

     */

    public void setMinimapVisibility(boolean visibility);

    /**

     * Sets visibility of north indicator component.

     * 

     * @param visibility

     * @see GeneralProperties3D#getNorthIndicatorVisibility()

     */

    public void setNorthIndicatorVisibility(boolean visibility);

    /**

     * Sets visibility of scale component.

     * 

     * @param visibility

     * @see GeneralProperties3D#getScaleVisibility()

     */

    public void setScaleVisibility(boolean visibility);

    /**

     * Sets visibility of starts background component.

     * 

     * @param visibility

     * @see GeneralProperties3D#getStarsBackgroundVisibility()

     */

    public void setStarsBackgroundVisibility(boolean visibility);

    /**

     * Sets if the view port synchronize is animated or not.

     * 

     * @param flag

     * @see GeneralProperties3D#getViewPortAnimation()

     */

    public void setViewPortAnimation(boolean flag);

}