Application: gvSIG desktop » gvSIG 3D

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

import java.awt.Color;

/**

 * This class defines the 3D properties for vector layers.s

 * 

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

 * @author Andrea Antonello andrea.antonello@gmail.com

 */

public interface VectorLayerProperties3D extends LayerProperties3D {

    public static final String DEFAULT_COLOR = "defaultColor";

    public static final String ELEVATION_MODE = "elevationMode";

    public static final String CONSTANT_HEIGHT = "constantHeight";

    /**

     * The elevation mode to use.

     * 

     * <p>

     * Supported modes are:

     * <ul>

     * <li>gov.nasa.worldwind.WorldWind.ABSOLUTE: if the layer has 3d

     * coordinates,

     * the coordinates are used to define the absolute elevation of

     * the polygon's base vertexes.</li>

     * <li>gov.nasa.worldwind.WorldWind.CLAMP_TO_GROUND</li>

     * <li>gov.nasa.worldwind.WorldWind.RELATIVE_TO_GROUND: if the layer has 3d

     * coordinates,

     * the coordinates are used as if they were heights relative to the ground.

     * </li>

     * </ul>

     * 

     * @return the elevation mode.

     */

    public int getElevationMode();

    /**

     * Set the elevationMode to use.

     * 

     * @param elevationMode

     * @see #getElevationMode()

     */

    public void setElevationMode(int elevationMode);

    /**

     * Getter for the default color, which is used if the style

     * can't be taken from the layer's legend.

     * 

     * @return the default color to use.

     */

    public Color getDefaultColor();

    /**

     * Setter for the default color for the style..

     * 

     * @param defaultColor

     *            the default color to use.

     */

    public void setDefaultColor(Color defaultColor);

    /**

     * Getter for the value of constant height to use either for offset or extrusion

     * depending of the type of loading mode.

     * 

     * <p>

     * This is set as a Double object, so that it can also be <code>null</code>.

     * if it is null, no constant value is used.

     * 

     * @return the constant height to use or <code>null</code>.

     */

    public Double getConstantHeight();

    /**

     * Setter for the constant height to use  for offset or extrusion

     * depending of the type of loading mode.

     * 

     * @param constantHeight

     *            the constant height to use.

     */

    public void setConstantHeight(Double constantHeight);

}