Application: gvSIG desktop » gvSIG 3D

=================================================================

 Visor 3D básico que integra Nasa WW SDK

=================================================================

-------------------

 Diseño técnico

-------------------

:Company:   gvSIG Association 

:Author:    DiSiD Corporation, S.L.

:Revision:  $Rev: $

:Date:      $Date: $

:Copyright: All rigths reserved

.. contents::

   :depth: 2

   :backlinks: none

.. sectnum::

   :depth: 2

   :start: 1

.. |year| date:: %Y

.. header:: 

   .. class:: headertable

   +-----------------------+-------------------------+

   |.. class:: left        |.. class:: right         |

   |                       |                         |

   | Diseño técnico        |###Page###               |

   +-----------------------+-------------------------+ 

.. footer:: 

    .. include:: <isonum.txt>

    .. class:: left

    *Visor 3D básico que integra Nasa WW SDK - Diseño técnico*

    |copy| |year| ** 

Introducción

=============

Este documento detalla el diseño técnico del nuevo visor 3D basado en la librería NASA WW SDK para gvSIG 2.1+. Para más información consulte:

 * http://worldwind.arc.nasa.gov/java/

 * http://goworldwind.org/

El diseño técnico tendrá en cuenta el análisis de requisitos y el análisis funcional realizados. En primer lugar se detallarán el API y las implementaciones de los diferentes módulos del proyecto.  

Diseño técnico

=====================

Para tener un poco del contexto del diseño técnico, se expone como debería de funcionar de forma resumida el visor 3D. Seguidamente se detallará el API e implementación de la librería y las extensiones del plugin.

Ejemplo de casos de uso

-------------------------------

A partir de una vista 2D, se desea representar la información cargada en la vista de forma tridimensional. Para ello, el usuario dispondrá de dos entradas de menú / botones para crear los dos tipos de visores: esférico y plano (View3DExtension, una única extensión para dos acciones). Al pulsar sobre uno de los botones, el plugin accederá a la información de la vista activa mediante la obtención del MapControl y la servirá a la librería NASA WW SDK mediante View3DModel#add(FLayer layer). El modelo obtendrá la capa equivalente mediante el View3DManager#getWWLayer(FLayer, loadMode) y la añadirá a un objeto gov.nasa.worldwind.Model. Cuando todas las capas han sido añadidas, se creará el visor mediante View3DSwingManager#createView3DPanel(MapControl, model).

Además de las dos extensiones para la creación de visores, el usuario también dispondrá de una extensión llamada RefreshView3DExtension para la actualización de los datos del visor activo con los posibles cambios efectuados sobre la vista 2D. La extensión ejecutará el método View3DPanel#reloadLayers().

Y finalmente, existirá una última extensión llamada SynchronizeView3DExtension que permitirá al usuario sincronizar los enfoques de la vista 2D y el visor 3D asociado a la vista. Se accederá al ViewPort del MapControl asociado para sincronizarlo con el enfoque del visor 3D.

LIB API

--------

.. note::

   Los métodos deben lanzar excepciones hacia el nivel más alto de la librería. Como no esta definido el API de excepciones no indico que tipo de excepciones pueden lanzar los métodos.

Este es el API de la librería del visor 3D, la cual esta basada en el modelo de implementación simple API/IMPL.

* Project: org.gvsig.view3d/org.gvsig.view3d.lib/org.gvsig.view3d.lib.api

* Package: or.gvsig.view3d.lib.api

View3DManager 

*********************************************

Proveerá las siguientes operaciones:

* getWWLayer(FLayer layer, int loadMode) : gov.nasa.worldwind.layers.Layer

A partir de una capa de gvSIG y un modo de carga se obtiene una capa nativa de la librería World Wind. Existen 4 modos de carga: raster imagen, raster elevación, vectorial rasterizada y vectorial 3d. Dependiendo del modo de carga se obtendrá una capa nativa u otra.

DataReader 

*********************************************

Proveerá las siguientes operaciones:

* canRead(Object sourceFile) : boolean

Determina si la fuente de datos se puede acceder o no. Puede recibir como parámetro un objeto del tipo File, java.net.URL, String o java.io.InputStream. 

* read(Object sourceFile) : gov.nasa.worldwind.layers.Layer

A partir de una fuente de datos crea una capa gov.nasa.worldwind.layers.Layer.

SWING API

----------

Este es el API de la interfaz de usuario de la librería del visor 3D, la cual esta basada en el modelo de implementación simple API/IMPL.

* Project: org.gvsig.view3d/org.gvsig.view3d.swing/org.gvsig.view3d.swing.api

* Package: or.gvsig.view3d.swing.api

View3DSwingManager

********************

* createView3DModel(int mode) : View3DModel

Crea un modelo a partir del modo. El modo puede tener dos valores: View3dModel.SPHERE y View3DModel.FLAT. El método configura todo lo necesario en la librería NASA WW SDK para la creación de un visor según el modo.

* createView3DModel(int mode, FLayers layers) : View3DModel

Crea un modelo a partir del modo. El modo puede tener dos valores: View3dModel.SPHERE y View3DModel.FLAT. El método configura todo lo necesario en la librería NASA WW SDK para la creación de un visor según el modo. Además recorre la colección de layers y las añade al modelo creado.

* createView3DPanel(MapControl theMapControl, View3DModel theModel) : View3DPanel

Crea un panel con el componente para dibujar la información en 3D a partir de un MapControl y un modelo.

View3DPanel extends JPanel

****************************

Clase abstracta que extiende de JPanel. Como JPanel no tiene una interfaz definida, crearemos una clase abstracta que implementará la vista del visor (tamaño, inicialización de componentes...) y definirá el API de nuestro componente. Se añadirá los siguientes métodos definidos pero sin implementarlos.

* getMapControl() : MapControl

Obtiene el mapControl asociado al panel. Del mapControl asociado se extrae la información necesaria para la representación de los datos en 3D y la sincronización de enfoques.

* getModel() : View3DModel

Obtiene el modelo del visor.

* getVerticalExaggeration() : double

Obtiene la exageración vertical del visor.

* reloadLayers() : void

Elimina las capas del modelo de la vista. Accede al MapControl asociado al visor y carga de nuevo las capas. Se usa para actualizar el visor con los posibles cambios realizados sobre la vista 2D.

* setMapControl(MapControl theMapControl) : void

Establece el mapControl al visor. 

* setVerticalExaggeration(double verticalExaggeration) : void

Establece las exageración vertical del visor.

* show() : void

Muestra el visor. 

* showAtmosphere() : void

Muestra la atmósfera si el visor es esférico.

* showNortIndicator() : void

Muestra el indicador del norte.

* showMiniMap() : void

Muestra el minimapa.

* showScale() : void

Muestra la escala de la capa.

* showStarBackgroundLayer() : void

Muestra el fondo de estrellas.

* hideAtmosphere() : void

Oculta la atmósfera en visores esféricos.

* hideMiniMap() : void

Oculta el minimapa.

* hideStarBackgroundLayer() : void

Oculta el fondo de estrellas.

* hideNorthIndicator() : void

Oculta el indicador del norte.

* hideScale() : void

Oculta la escala del mapa.

* synchronizeViewPorts() : void

Sincroniza el viewPort de la vista 2D enlazada al visor con el enfoque del visor 3D.

View3DModel

**************

* add(FLayer layer) : void

A partir de la capa que recibe como parámetro, obtiene la capa equivalente en la librería World Wind y la añade al modelo. 

* add(FLayers layers) : void

A partir de la colección de capas, obtiene las capas equivalentes en la librería World Wind y las añade al modelo respetando el orden.

* remove(FLayer layer) : void

Elimina del modelo la capa equivalente de la recibida como parámetro.

* removeAll() : void

Elimina todas las capas del modelo.

LIB IMPL

----------

DefaultView3DManager implements View3dManager

****************************************************

Implementación por defecto del manager View3DManager

DefaultVectorialDataReader implements DataReader

*************************************************

Implementación por defecto de la interfaz DataReader. Esta implementación se debe usar para acceder cuando la fuente de datos sea de tipo vectorial. 

DefaultRasterDataReader implements DataReader

************************************************

Implementación por defecto de la interfaz DataReader. Esta implementación se debe usar para acceder cuando la fuente de datos sea de tipo raster. 

DefaultElevationDataReader implements DataReader

************************************************

Implementación por defecto de la interfaz DataReader. Esta implementación se debe usar para acceder cuando la fuente de datos sea de tipo raster y el modo de carga elevación.

SWING IMPL

--------------

DefaultView3DSwingManager implements View3DSwingManager

********************************************************

Implementación por defecto del manager View3DSwingManager

DefaultView3DModel implements View3DModel

******************************************

Implementación por defecto de la clase View3DModel

DefaultView3DPanel extends View3DPanel

***************************************************

Implementación por defecto de los métodos descritos en la clase abstracta View3DPanel

View3D Plugin

----------------

Plugin principal de la librería. Estará compuesto por tres extensiones: View3DExtension, RefreshView3DExtension y SynchronizeView3DExtension. Además, gestionará la persistencia de las opciones establecidas por el usuario. El plugin registrará las acciones mediante el config.xml y creará el instalable con los archivos JARs.

View3DExtension

************************

Extensión de Andami asociada a dos acciones: "create-flat-view3d" y "create-spherical-view3d". Esta extensión deberá estar siempre visible y activa solo cuando se active una vista 2D con un capa o más. Las dos acciones obtendrán la instancia del View3DSwingManager, crearán el modelo, añadirán las capas de la vista activa, crearán el panel del visor 3D a partir del modelo y lo mostrarán.

RefreshView3DExtension

************************

Extensión de Andami asociada a la acción: "refresh-view3D". Esta extensión deberá estar visible cuando se active un visor 3D y siempre activa. La extensión obtendrá la instancia de tipo View3DPanel y ejecutará la operación View3DPanel#reloadLayers().

SynchronizeView3DExtension

****************************

Extensión de Andami asociada a la acción: "synchronize-view3D". Esta extensión deberá estar visible cuando se active una vista3D y siempre activa. La extensión obtendrá la instancia de tipo View3DPanel y ejecutará la operación View3DPanel#synchronizeViewPorts().

Persistencia

******************

Se creará un archivo llamado plugin-persistence.def que definirá la estructura de las preferencias. A priori las preferencias tendrán las siguientes propiedades:

 * Tamaño por defecto x : int

 * Tamaño por defecto y : int

 * Mostrar minimapa : boolean

 * Mostrar atmósfera : boolean

 * Mostrar escala : boolean

 * Mostrar indicar del norte : boolean

 * Mostrar fondo de estrellas : boolean

Se creará un panel para añadirlo a las preferencias generales de aplicación para que el usuario pueda modificar las preferencias del plugin.