Application: gvSIG desktop » gvSIG 3D

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2015 gvSIG Association

 *

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.view3d.swing.api;

import java.util.List;

import org.gvsig.fmap.mapcontext.MapContext;

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

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

import org.gvsig.view3d.swing.api.properties.GeneralProperties3D;

import org.gvsig.view3d.swing.api.properties.GeneralProperties3DPanel;

import org.gvsig.view3d.swing.api.properties.LayerProperties3DPanel;

import org.gvsig.view3d.swing.api.properties.MapControlProperties3D;

import org.gvsig.view3d.swing.api.properties.ViewProperties3DPanel;

/**

 * This class is responsible of the management of the library's swing user

 * interface. It is the swing library's main entry point, and provides all the

 * services to manage library swing components.

 * 

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

 *

 */

public interface View3DSwingManager {

    public enum TYPE {

        SPHERE, FLAT

    }

    /**

     * Creates a <code>View3DPanel</code> with a {@link MapControl3D}.

     * 

     * @param theMapContext

     *            associated <code>MapContext</code> of

     *            <code>MapControl3D</code>

     * @param title

     *            Title of window

     * @param type

     *            Type of <code>MapControl3D</code>. See {@link TYPE}.

     * @param viewProperties

     *            View properties to register this <code>MapControl3D</code>

     * @see View3DSwingManager#createMapControl3D(MapContext, TYPE)

     * @return

     */

    public View3DPanel createView3DPanel(MapContext theMapContext,String title, TYPE type,

        ExtendedPropertiesSupport viewProperties);

    /**

     * Registers and creatres a <code>MapControl3D</code> as from

     * {@link MapContext} {@link TYPE}. When an {@link MapControl3D} is created,

     * it automatically adds all available and visible layers of

     * <code>MapControl</code>.

     * 

     * @param theMapContext

     *            associated <code>MapContext</code> of

     *            <code>MapControl3D</code>

     * @param type

     *            Type of <code>MapControl3D</code>. See {@link TYPE}.

     * @param viewProperties

     *            View properties to register this <code>MapControl3D</code>

     * @return an instance of <code>MapControl3D</code> ready to be shown.

     */

    public MapControl3D createMapControl3D(MapContext theMapContext, TYPE type,

        ExtendedPropertiesSupport viewProperties);

    /**

     * Gets the {@link MapControl3D} associated with view properties

     * {@link ExtendedPropertiesSupport}. If there are not indicated type of

     * <code>MapControl3D</code> associated with view properties, it will return

     * an empty list.

     * 

     * @param viewProperties

     * @return List of <code>MapControl3D</code> associated with the view

     *         propoerties.

     */

    public List<MapControl3D> getMapControl3D(

        ExtendedPropertiesSupport viewProperties);

    /**

     * Gets the {@link MapControl3D} associated with view properties

     * {@link ExtendedPropertiesSupport}. Returns <code>null</code>, if there

     * are

     * not indicated type of <code>MapControl3D</code> registered at view

     * properties.

     * 

     * @param viewProperties

     * @param type

     *            Type of <code>MapControl3D</code>

     * @return

     */

    public MapControl3D getMapControl3D(

        ExtendedPropertiesSupport viewProperties, TYPE type);

    /**

     * 

     * @param layer

     * @return

     */

    public LayerProperties3DPanel createLayerProperties3DPanel(FLayer layer);

    /**

     * 

     * @return

     */

    public ViewProperties3DPanel createViewProperties3DPanel(

        MapControlProperties3D properties);

    /**

     * 

     * @param properties

     * @return

     */

    public GeneralProperties3DPanel createGeneralProperties3DPanel(

        GeneralProperties3D properties);

    public MapControlProperties3D getMapControl3DProperties(

        ExtendedPropertiesSupport viewProperties);

    public void setMapControlProperties3D(

        ExtendedPropertiesSupport viewProperties,

        MapControlProperties3D mapControl3DProperties);

    public GeneralProperties3D getGeneral3DProperties();

    public void setGeneral3DProperties(GeneralProperties3D properties);

}