Application: gvSIG desktop » gvSIG 3D

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

/**

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

 * 

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

 */

public interface ExtrudedVectorLayerProperties3D

    extends VectorLayerProperties3D {

    public static final String EXTRUSION_HEIGHT_FIELD = "extrusionHeightField";

    public static final String VERTICAL_EXAGGERATION = "verticalExaggeration";

    /**

     * Gets the field name that defines the extrusion height values.

     * 

     * @return the name of the extrusion height field.

     */

    public String getExtrusionHeightField();

    /**

     * Sets the field name that defines the extrusion height values.

     * 

     * @param field

     *            the name of the extrusion height field.

     */

    public void setExtrusionHeightField(String field);

    /**

     * Getter for the vertical exaggeration, which defaults to 1.0.

     * 

     * <p>

     * This value is used to multiply the value contained in the

     * extrusion height field. That way it is for example possible to

     * define in the attributes table as extruded height the number

     * of floors of the building and use a vertical exaggeration of

     * 3.0 meters to get the desired result.

     * 

     * @return the vertical exageration.

     */

    public double getVerticalExaggeration();

    /**

     * Setter for the vertical exaggeration.

     * 

     * @param verticalExaggeration

     *            the value to set.

     */

    public void setVerticalExaggeration(double verticalExaggeration);

}