Application: gvSIG desktop » gvSIG 3D

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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.

 *

 */

package org.gvsig.gvsig3d.map3d;

import org.gvsig.fmap.dal.DataParameters;

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

import org.gvsig.osgvp.terrain.Layer;

import org.gvsig.tools.persistence.Persistent;

/**

 * @author gvSIG Team

 * @version $Id$

 *

 */

public interface Layer3DProps {

         // types of 3D layers

    public static final int layer3DImage = 0;

    public static final int layer3DElevation = 1;

    public static final int layer3DVector = 2;

    public static final int layer3DVectorMR = 4;

    public static final int layer3DOSG = 3;

    /**

     * Return The editing state

     * 

     * @return true->editing. false->not editing

     */

    public boolean isEditing();

    /**

     * Set the editing state

     * 

     * @param true->editing. false->not editing

     */

    public void setEditing(boolean isEditing);

    public void setChooseType(boolean bChoose);

    public boolean getHooked();

    public void setHooked(boolean hooked);

    public void setTerrainLayer(Layer terrainLayer);

    public Layer getTerrainLayer();

    /**

     * Setting the layer

     * 

     * @param layer

     */

    public void setLayer(FLayer layer);

    /**

     * Initialize the cache name for the layer. It uses the terrain type the

     * view projection and the type o coordinates

     * 

     * @param terrainType

     * @param viewProj

     * @param geocentricCoordinates

     */

    // public void initCacheName(int terrainType, IProjection viewProj,

    // int geocentricCoordinates);

    // /**

    // * Return the cacheService of this layer. It depends of the type of the

    // layer.

    // *

    // * @return

    // */

    // public CacheService getCacheService();

    //

    // /**

    // * Set the cacheService of this layer. It depends of the type of the

    // layer.

    // *

    // * @param srv

    // */

    // public void setCacheService(CacheService srv);

    /**

     * Set the type of this layer

     * 

     * @param type

     */

    public void setType(int type);

    /**

     * Get the type of the layer

     * 

     * @return

     */

    public int getType();

    // /**

    // * Get the cache name for this layer

    // *

    // * @return

    // */

    // public String getCacheName();

    // /**

    // * Verifies that the vector layer's legend matches the one in the cache

    // * folder

    // */

    // public void VerifyLegend(String terrainName);

    // IPersistance

    public String getClassName();

    /*

     * (non-Javadoc)

     * 

     * @see com.iver.utiles.IPersistence#getXMLEntity()

     */

    // public XMLEntity getXMLEntity();

    //

    // /* (non-Javadoc)

    // * @see

    // com.iver.utiles.IPersistence#setXMLEntity(com.iver.utiles.XMLEntity)

    // */

    // public void setXMLEntity(XMLEntity xml);

    /**

     * Return the opacity of this layer

     * 

     * @return

     */

    public float getOpacity();

    /**

     * Set the opacity of this layer

     * 

     * @param A

     *            value between 0 and 1

     */

    public void setOpacity(float m_opacity);

    /**

     * Get the vertical exaggeration for this layer

     * 

     * @return

     */

    public float getVerticalEx();

    /**

     * Get the vertical exaggeration from this layer

     * 

     * @param ex

     */

    public void setVerticalEx(float ex);

    /**

     * Sets which band is used for the elevation

     * 

     * @param band

     */

    public void setElevationBand(int band);

    /**

     * Gets which band is used for the elevation

     */

    public int getElevationBand();

    /**

     * Get the height that this layer has when it draws in 3D

     * 

     * @return

     */

    public float getHeight();

    /**

     * Set the height that this layer has when it draws in 3D

     * 

     * @param heigth

     */

    public void setHeight(float heigth);

    /**

     * If the features of this layer have z value this method will return true.

     * In the other case it will return false

     * 

     * @return

     */

    public boolean isZEnable();

    /**

     * Set the z enable

     * 

     * @param zenable

     */

    public void setZEnable(boolean zEnable);

    /**

     * It is to know if this layer is new. It only works with the OSG layers

     * 

     * @return

     */

    public boolean isNewLayerOSG();

    /**

     * Set if this layer is new. It only works with OSG layers.

     * 

     * @param newLayerOSG

     */

    public void setNewLayerOSG(boolean newLayerOSG);

    public void setDrawVersion(long version);

    public long getDrawVersion();

}