Statistics
| Revision:

gvsig-3d / 2.1 / trunk / doc / dt-visor-3d.rst @ 479

History | View | Annotate | Download (34.6 KB)

1
=================================================================
2
 Visor 3D básico que integra Nasa WW SDK
3
=================================================================
4

    
5
-------------------
6
 Diseño técnico
7
-------------------
8

    
9
:Company:   gvSIG Association 
10
:Author:    DiSiD Corporation, S.L.
11
:Revision:  $Rev: $
12
:Date:      $Date: $
13
:Copyright: All rigths reserved
14

    
15
.. contents::
16
   :depth: 2
17
   :backlinks: none
18

    
19
.. sectnum::
20
   :depth: 1
21
   :start: 1
22

    
23
.. |year| date:: %Y
24

    
25
.. header:: 
26
      
27
   .. class:: headertable
28

    
29
   +-----------------------+-------------------------+
30
   |.. class:: left        |.. class:: right         |
31
   |                       |                         |
32
   | Diseño técnico        |###Page###               |
33
   +-----------------------+-------------------------+ 
34

    
35

    
36
.. footer:: 
37

    
38
    .. include:: <isonum.txt>
39

    
40
    .. class:: left
41

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

    
44
    |copy| |year| ** 
45

    
46

    
47
Introducción
48
=============
49

    
50
.. note::
51
 Este documento esta en continua construcción. A medida que se avance en el proyecto se irá añadiendo nueva información y refinando la existente.
52

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

    
55
* http://worldwind.arc.nasa.gov/java/
56
* http://goworldwind.org/
57

    
58
El diseño técnico tendrá en cuenta el análisis de requisitos y el análisis funcional realizados en:
59

    
60
* http://devel.gvsig.org/svn/gvsig-3d/2.1/trunk/doc/re-visor-3d.rst
61
* http://devel.gvsig.org/svn/gvsig-3d/2.1/trunk/doc/af-visor-3d.rst
62

    
63
Diseño técnico
64
=====================
65

    
66
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á como se estructura la librería y la arquitectura de plugins.
67

    
68
Ejemplo de caso de uso
69
-------------------------------
70

    
71
A partir de una vista 2D, se desea representar la información cargada 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 definidos en TYPE.SPHERE y TYPE.FLAT. Las dos entradas de menú ejecutarán una misma extensión, View3DExtension, la cual dependiendo del *action command* realizará una acción u otra. Pero antes de explicar la creación de visor el usuario debe definir parámetros o propiedades para la carga y gestión de las capas dentro del visor 3D.
72

    
73
Las capas tienen propiedades comunes, definidas en `LayerProperties3D`_, y especificas que varían en función del tipo de capa, definidas en las subclases ``RasterLayerProperties3D`` y ``VectorialLayerProperties3D``. La propiedades comunes son las siguientes:
74

    
75
* Nivel máximo de detalle: nivel máximo de detalle en la visualización de la capa. Cuanto más alto sea el número máximo de nivel de detalle más tiles se generarán y más espacio ocuparán en el disco.
76
* Nivel mínimo de detalle: nivel mínimo de detalle en la visualización de la capa. Cuanto más pequeño sea el número mínimo de nivel de detalle menos tiles se generarán y menos espacio ocuparán en el disco.
77

    
78
La librería WW permite dividir un raster, ya sea normal o de elevación, en varios niveles de detalle que se muestran dependiendo de lo cerca o lejos se encuentre el enfoque de la capa raster. Los niveles de detalle se estructuran en forma de pirámide, de menor resolución y número de tiles (nivel mínimo) a mayor nivel de resolución y número de tiles (nivel máximo). Para más información de como se gestionan los niveles de detalle y los tiles dentro de la librería WW consulte:
79

    
80
 http://www.microimages.com/documentation/TechGuides/78Worldwind.pdf
81

    
82
Además de las propiedades descritas anteriormente si la capa es de tipo vectorial tiene las siguientes propiedades:
83

    
84
* Modo de carga rasterizado: permite indicar si la capa vectorial se va a cargar en el visor de forma rasterizada. La rasterización de una capa vectorial consiste en la conversión de una imagen vectorial a una imagen formada por píxeles. Por defecto las capas vectoriales se cargan en el visor rasterizadas debido a que la carga de capas vectoriales sin rasterizar se abordará más adelante.  
85

    
86
Si la capa es de tipo raster tiene las siguientes propiedades:
87

    
88
* Modo de carga elevación: permite indicar si el raster es de tipo elevación o no. 
89

    
90
Una vez definidas las propiedades 3D de la capas, se procede a la creación de un visor 3D. La extensión obtendrá la instancia única mediante el Locator y ejecutará el método ``ViewPanel3DManager#createViewPanel3D(MapContext, TYPE)`` pasándole como parámetro el mapContext de la vista activa y el tipo de visor dependiendo del *action command*. En la creación del visor, se accederá a la capas del MapContext para cargarlas obteniendo las propiedades asociadas a las capas mediante ``ViewPanel3D#getLayerProperties3D(FLayer)`` para determinar que tipo de ``LayerConverter`` instanciar.
91

    
92
Instanciado el conversor para la obtención de una capa WW se ejecutará el método ``LayerConverter#convertToLayer(FLayer)`` o ``LayerConverter#convertToElevationModel(FLayer flayer)`` dependiendo del tipo de capa y el modo de carga. Estos método realizarán todo lo necesario para obtener la capa WW correspondiente. Una vez obtenida la capa se debe de añadir al componente WW y mostrar la ventana mediante ``ViewPanel3D#show()``.
93

    
94
Por otra parte cuando se activa un visor, se activan dos entradas de menú adicionales: Refrescar visor y Sincronizar enfoques. La entrada de menú Refrescar visor esta asociada a la extensión RefreshView3DExtension la cual obtendrá el `MapControl3D`_ del visor activo y ejecutará el método ``MapControl3D#synchronizeLayer()``. La entrada de menú Sincronizar enfoques esta asociada a la extensión ``SynchronizeView3DExtension`` la cual obtendrá el enfoque de la vista 2D a la que esta enlazada para mover el enfoque del visor hasta que los dos enfoques estén sincronizados.
95

    
96
Integración con la librería NASA WW SDK
97
----------------------------------------
98

    
99
World Wind es una colección de componentes que de forma interactiva muestran información geográfica en 3D. Las aplicaciones o applets que usen la librería deberá integrar uno o más componentes dentro de su interfaz gráfica. World wind sigue el siguiente esquema:
100

    
101
.. image:: images/world-wind-diagram.png
102

    
103
* Globe: representa la forma del planeta y el terreno. Contiene un Tessellator el cual es el encargado de generar el terreno.
104
* Layer: las capas añaden las imágenes, objetos u otra información al globo. La capas se ajustan a la forma del globo y se mueven junto a el cuando el usuario navega por el espacio tridimensional.
105
* Model: junta el globo y las capas.
106
* View: determina la vista del usuario sobre el modelo. La vista se va modificando en base a los eventos de usuario que recibe.
107
* SceneController: asocia la vista con el modelo. Controla el tiempo y el renderizado del modelo.
108

    
109
Se pretende crear una nivel de abstracción que ofrezca a los consumidores de la librería la funcionalidades descritas en el análisis funcional de forma que no tengan que interactuar con la librería WW. La integración del plugin con la librería World Wind se ha diseñado del siguiente modo:
110

    
111
* El componente `ViewPanel3D`_ integra un componente ``WorldWindowGLJPanel``. ``WorldWindowGLJPanel`` es autocontenido y su propósito es servir la aplicación WorldWind mostrando el modelo definido (globo y capas).
112
* La librería posee unos archivos de configuración en XML que son cargados cuando la librería se registra. Estos archivos de configuración por un lado definen la clases que implementan los distintos servicios que ofrece la librería y por otro las capas que se cargan por defecto al crear un modelo básico.
113
* Además de esta configuración, es necesario configurar unos parámetros especificados para crear un ``WorldWindowGLJPanel`` esférico o plano. Esta configuración se realiza al instanciar un objeto `ViewPanel3D`_. Dependiendo del modo indicado como parámetro, se establece una configuración u otra.
114
* La obtención de las capas WW a partir de capas de gvSIG se realiza mediante la clase `LayerConverter`_ la cual permite obtener la capa equivalente en WW a partir de una capa de gvSIG para añadirla a las capas del modelo WW. Se ha implementa un nuevo tipo de capa llamado RasterTiledImageLayer la cual gestiona la peticiones de tiles en tiempo para que se obtengan los datos directamente desde el DAL de gvSIG. Esta gestión se realiza mediante los objetos ``DefaultRetrieverFactory``, ``DefaultRasterRetriever``, ``DefaultRasterServer``, ``DefaultDataRasterReaderFactory``, ``DefaultDataRasterReader`` y ``DefaultDataRaster``.
115

    
116
LIB API
117
---------
118

    
119
Este es el API de la lógica de la librería, la cual esta basada en el modelo de implementación simple API/IMPL
120

    
121
* Project: org.gvsig.view3d/org.gvsig.view3d.lib/org.gvsig.view3d.lib.api
122
* Package: org.gvsig.view3d.lib.api
123

    
124
LayerProperties3D
125
~~~~~~~~~~~~~~~~~~~~~~
126

    
127
Clase que representa la propiedades 3D de una capa.
128

    
129
* setMaxLevel(int maxLevel) : void
130

    
131
  Asigna el máximo nivel de detalle de la capa.
132

    
133
* getMaxLevel() : int
134

    
135
  Obtiene el máximo nivel de detalle de la capa.
136

    
137
* setMinLevel(int minLevel) : void
138

    
139
  Asigna el mínimo nivel de detalle de la capa.
140

    
141
* getMinLevel() : int
142

    
143
  Obtiene el mínimo nivel de detalle de la capa.
144

    
145
* setFileStore(String path) : void
146

    
147
  Asigna el directorio padre donde se ubicarán las diferentes capas cacheadas
148

    
149
* getFileStore() : String
150

    
151
  Obtiene el directorio padre donde se ubican las diferentes capas cacheadas.
152

    
153
* getCacheName() : String
154

    
155
  Obtiene el nombre único de la caché el cual da nombre a la carpeta dentro del file store que contiene los tiles cacheados y los archivos de configuración.
156

    
157
RasterLayerProperties3D extends LayerProperties3D
158
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159

    
160
Clase que representa la propiedades 3D de una capa raster.
161

    
162
* setElevation(boolean elevation) : void
163

    
164
  Asigna a la capa si el modo de carga de la capa es de elevación o no.
165

    
166
* getElevation() : boolean
167

    
168
  Obtiene si el modo de carga de la capa raster es de elevación o no.
169

    
170
VectorialLayerProperties3D extends LayerProperties3D
171
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
172

    
173
Clase que representa la propiedades 3D de una capa vectorial.
174

    
175
* setRasterized(boolean rasterized) : void
176

    
177
  Asigna a la capa si el modo de carga de la capa es rasterizado o no.
178

    
179
* getRasterized() : boolean
180

    
181
  Obtiene si el modo de carga de la capa vectorial es rasterizado o no.
182

    
183
.. note::
184
  Falta añadir la propiedades de vista y propiedades generales.
185

    
186
LIB IMPL
187
---------
188

    
189
Esta es la implementación de la lógica de la librería.
190

    
191
DefaulRasterLayerProperties3D
192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193

    
194
Implementación por defecto de las propiedades de las capas raster.
195

    
196
DefaultVectorialLayerProperties3D
197
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198

    
199
Implementación por defecto de la propiedades de las capas vectoriales.
200

    
201
SWING API
202
----------
203

    
204
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.
205

    
206
* Project: org.gvsig.view3d/org.gvsig.view3d.swing/org.gvsig.view3d.swing.api
207
* Package: org.gvsig.view3d.swing.api
208

    
209
View3DSwingManager
210
~~~~~~~~~~~~~~~~~~~~~~
211

    
212
Punto de entrada a la librería view3D. Proporciona métodos para la creación de visores, paneles de propiedades y obtención de las propiedades 3D de una capa.
213

    
214
* createViewPanel3D(MapContext theMapContext, TYPE type) : ViewPanel3D
215

    
216
  Crea un objeto `ViewPanel3D`_ pasándole como parámetro el MapContext y el tipo de panel.
217

    
218
* createMapControl3D(MapContext mapContext, TYPE type) : MapControl3D
219

    
220
  Crea un objeto `MapControl3D`_ a partir del MapContext y el tipo.
221

    
222
* getLayerProperties3D(FLayer layer) : LayerProperties3D
223

    
224
  Obtiene las propiedades asociadas a un capa.
225

    
226
* setLayerProperties3D(FLayer layer, LayerProperties3D properties) : void
227

    
228
  Asigna las propiedades a la capa que recibe como parámetro.
229

    
230
* getMapControl3D(MapContext theMapContext, TYPE type) : MapControl3D
231

    
232
  Obtiene el `MapControl3D`_ del tipo indicado mediante el parámetro ``TYPE`` registrado al ``MapContext``. Si no hay ningún `MapControl3D`_ registrado devuelve ``null``.  
233

    
234

    
235
.. note::
236
  Falta especificar las propiedades relacionadas con la vista, las propiedades generales y sus interfaces.
237

    
238
MapControl3D
239
~~~~~~~~~~~~~~~~~~~~~~
240

    
241
Define el API del componente 3D.  Esta clase representa el componente 3D del visor. Permite añadir y quitar capas, sincronizar capas y enfoques con la vista 2D enlazada, configurar la visibilidad de los componentes del visor. Además, a partir de un MapContext obtiene las capas y las convierte en capas WW para añadirlas al componente WorldWind.
242

    
243
* getCancellable() : Cancellable
244

    
245
  Obtiene el objeto compartido el cual permite cancelar todas las ordenes de pintado que se están ejecutando en un momento dado.
246
 
247
* getMapContext() : MapContext
248

    
249
  Obtiene el ``MapContext`` asociado al visor. Del ``MapContext`` asociado se extrae la información necesaria para la representación de los datos en 3D y la sincronización de enfoques.
250

    
251
* getType() : TYPE
252

    
253
  Obtiene el tipo del visor. Devuelve un objeto enum que puede ser TPYE.SPHERE o TYPE.FLAT (ver `TYPE`_).
254

    
255
* getVerticalExaggeration() : double
256

    
257
  Obtiene la exageración vertical del visor.
258

    
259
* reloadLayers() : void
260

    
261
  Elimina las capas cargadas. Accede al MapContext asociado al visor y carga de nuevo las capas. Se usa para actualizar el visor con los posibles cambios realizados sobre la vista 2D.
262

    
263
* setMapContext(MapContext theMapContext) : void
264

    
265
  Establece el MapContext al visor y recarga la información mediante reloadLayers().
266

    
267
* setVerticalExaggeration(double verticalExaggeration) : void
268

    
269
  Establece las exageración vertical del visor.
270

    
271
* showAtmosphere() : void
272

    
273
  Si no esta añadida la capa que representa la Atmosphera la añade al componente ``WorldWind``.
274

    
275
* showNortIndicator() : void
276

    
277
  Si no esta añadido el componente que representa el indicador del norte lo añade al componente ``WorldWind``.
278

    
279
* showMiniMap() : void
280

    
281
  Si no esta añadido el componente que representa el minimapa lo añade al componente ``WorldWind``.
282

    
283
* showScale() : void
284

    
285
  Si no esta añadido el componente que representa la escala lo añade al componente ``WorldWind``.
286

    
287
* showStarBackground() : void
288

    
289
  Si no esta añadido el componente que representa el fondo de estrellas lo añade al componente ``WorldWind``.
290

    
291
* synchronizeViewPorts() : void
292

    
293
  Obtiene el ``ViewPort`` de la vista y realiza las transformaciones necesarias para el enfoque del visor 3D muestra la misma región. Hay que tener en cuenta si la opción "Animación en la sincronización de enfoques" esta marcada o no. En caso de que este marcada la sincronización se debe animar, en caso contrario, no.
294

    
295
* synchronizeLayers() : void
296

    
297
  Comprueba que capas han sufrido cambios mediante el versionado del MapContext y la vuelve a recargar en el modelo del componente WW. 
298

    
299
* hideAtmosphere() : void
300

    
301
  Si esta añadido, elimina el componente que representa la atmósfera del componente ``WorldWind``.
302

    
303
* hideMiniMapVisibility() : void
304

    
305
  Si esta añadido, elimina el componente que representa el minimapa del componente ``WorldWind`` si esta añadido.
306

    
307
* hideStarBackgroun() : void
308

    
309
  Si esta añadido, elimina el componente que representa el fondo de estrellas del componente ``WorldWind`` si esta añadido.
310

    
311
* hideNorthIndicator() : void
312

    
313
  Si esta añadido, elimina el componente que representa el indicador del norte del componente ``WorldWind`` si esta añadido.
314

    
315
* hideScale() : void
316

    
317
  Si esta añadido, elimina el componente que representa las escala  del componente ``WorldWind`` si esta añadido.
318

    
319
DefaultTiledImageLayer
320
________________________
321

    
322
Los pasos para obtener una capa RasterTiledImageLayer son los siguientes:
323

    
324
* Configuración de los parámetros necesarios en un fichero XML para crear una capa del tipo RasterTileImageLayer. Los parámetros necesarios son:
325

    
326
 * DATASET_NAME: Nombre del dataset.
327
 * DATA_CACHE_NAME: Nombre de la carpeta dentro de la cache donde se alojará los tiles generados en tiempo de ejecución. Este nombre debe ser único.
328
 * SERVICE_NAME: En nuestro caso siempre será *Offline*.
329
 * SECTOR: Zona geográfica del raster especificada en grados sobre la proyección EPSG:4326.
330
 * WIDTH: Ancho en píxeles de la imagen raster.
331
 * HEIGHT: Alto en píxeles de la imagen raster.
332
 * DISPLAY_NAME: Nombre de la capa.
333
 * IMAGE_FORMAT: Formato de los tiles que se generan. Se indican en formato MIME y se aceptan cuatro tipos: PNG, JPG, JPEG y DDS.
334
 * PIXEL_FORMAT: Formato del pixel. Puede tener dos valores: AVKey.IMAGE y AVKey.ELEVATION. En caso de DefaultTiledImageLayer siempre será AVKey.IMAGE.
335
 * TEXTURE_FORMAT: Tipo MIME del formato de la texturas. Se indican en formato MIME y se aceptan cuatro tipos: PNG, JPG, JPEG y DDS.
336
 * FORMAT_SUFFIX: sufijo de archivo de los tiles generados. Debe corresponderse al formato de imagen indicado.
337
 * AVAILABLE_IMAGE_FORMATS: Formatos de imagen disponibles.
338
 * TILE_ORIGIN: Origen desde donde se empiezan a crear los tiles.
339
 * TILE_WIDTH: Ancho en píxeles del tile.
340
 * TILE_HEIGHT: Alto en píxeles del tile.
341
 * NUM_LEVELS: Numero de niveles de detalle. Por defecto se calcular el valor óptimo dependiendo de la resolución del raster.
342
 * LEVEL_ZERO_DELTA: Objeto LatLon con valores en grados. Define que resolución corresponde a que nivel de detalle. Si el valor es muy pequeño (~1º) muestra en niveles de detalle bajos (0 o 1) resoluciones muy altas haciendo el proceso de pintado muy costoso. Es cambio si se asignan valores muy grandes (entre 36 y valores máximos) en niveles bajos de detalle se muestra una resolución muy pequeña haciendo que el proceso de pintado sea muy rápido. Por defecto en capas raster se calcula el valor óptimo y en capas rasterizadas se asigna el valor 20º.
343
 * NETWORK_RETRIEVAL_ENABLED: En nuestro caso siempre será ``false`` ya que para la libería los datos siempre están en local.
344
 * USE_MIP_MAPS: En este caso siempre tendrá el valor ``true`` debido a que mejora la visualización del raster.
345
 * USE_TRANSPARENT_TEXTURES: En este caso siempre tendrá el valor ``true`` debido a que mejora la visualización del raster.
346

    
347

    
348
Además de estos parámetros también es necesario añadir en tiempo de ejecución la capa gvSIG que se desea convertir de la cual se obtendrá la información para la creación de tiles mediante la clave GVSIG_LAYER. Por otra parte, existen parámetros opcionales que si no se asigna ningún valor la librería asigna el valor por defecto.
349

    
350
* Crear la capa de tipo RasterTileImageLayer a partir de los parámetros y añadirla al modelo. Al instanciar una nueva capa RasterTileImageLayer, se configura una factoría del tipo DefaultRetrieverFactory la cual permite la creación de objetos DefaultRasterRetriever. Dichos objetos son los encargados de realizar la distintas peticiones a un objeto DefaultRasterServer el cual es el encargado de servir la información procedente de un DataRaster genérico.
351

    
352
DefaultElevationModel
353
________________________
354

    
355
Los pasos para obtener una capa RasterTiledImageLayer son los siguientes:
356

    
357
* Configuración de los parámetros necesarios en un fichero XML para crear una modelo de elevación ElevationModel. Los parámetros necesarios son:
358

    
359
  * DISPLAY_NAME: Nombre del modelo de elevación
360
  * SECTOR: Zona geográfica del raster especificada en grados sobre la proyección EPSG:4326.
361
  * WIDTH: ancho en píxeles de la imagen raster.
362
  * HEIGHT: alto en píxeles de la imagen raster.
363
  * FILE_STORE: almacén de archivos de la cache. Proporciona métodos para añadir / quitar localizaciones, buscar archivos, borra archivos...
364
  * IMAGE_FORMAT: formato de los tiles genera
365
  * DATA_TYPE: tipo de dato de la información del raster.
366
  * PIXEL_FORMAT: formato del pixel: AVKey.ELEVATION o AVKey.IMAGE
367
  * FORMAT_SUFFIX: sufijo de archivo de los tiles generados.
368

    
369
    Además de estos parámetros también es necesario añadir en tiempo de ejecución la capa gvSIG que se desea convertir de la cual se obtendrá la información para la creación de tiles mediante la clave GVSIG_LAYER. Por otra parte, existen parámetros opcionales que si no se asigna ningún valor la librería asigna el valor por defecto. Los parámetros opcionales son:
370

    
371
  * BYTE_ORDER: orden de los bytes. Little endian o big endian.
372
  * ELEVATION_MAX: elevación máxima y mínima.
373
  * ELEVATION_MIN: elevación mínima del raster.
374
  * EXPIRY_TIME: tiempo de expiración de un tile dentro de la cache.
375
  * MISSING_DATA_SIGNAL: Valor "no data"
376
  * MISSING_DATA_REPLACEMENT: Valor que se obtiene al obtener la elevación sobre un punto "no data".
377
  * NETWORK_RETRIEVAL_ENABLED: Indica el modo de trabajo online o offline.
378
  * ELEVATION_EXTREMES_FILE: ruta al fichero que contiene información sobre las elevaciones extremas.
379

    
380
* Crear el modelo de elevación DefaultElevationModel a partir de lo parámetros y añadirlo al modelo ya existente. El modelo existente será de tipo CompoundElevationModel el cual permite añadir varios modelos de elevación y mostrarlos a la vez. Al instanciar un nuevo modelo de elevación, se configura una factoría del tipo DefaultRetrieverFactory la cual permite la creación de objetos DefaultRasterRetriever. Dichos objetos son los encargados de realizar las distintas peticiones a un objeto DefaultRasterServer el cual es el encargado de servir la información procedente de un DataRaster genérico. 
381

    
382
ViewPanel3D
383
~~~~~~~~~~~~~~~~~~~~~~
384

    
385
Representa la ventana que contiene el componente `MapControl3D`_.
386

    
387
* show() : void
388

    
389
  Invoca al WindowManager para mostrar el visor en modo ventana.
390

    
391
* getMapControl3D() : MapControl3D
392

    
393
  Devuelve el componente asociado a la ventana.
394

    
395
TYPE
396
~~~~~~~~~~~~~~~~~~~~~~
397

    
398
Enumerado que representa los dos tipos posibles de un visor 3D. Los dos tipos son: SPHERE y FLAT.
399

    
400
SWING IMPL
401
--------------
402

    
403
Este es la implementación de la interfaz de usuario de la librería del visor 3D.
404

    
405
* Project: org.gvsig.view3d/org.gvsig.view3d.swing/org.gvsig.view3d.swing.impl
406
* Package: or.gvsig.view3d.swing.impl
407

    
408
DefaultView3DManager implements View3DManager
409
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
410

    
411
Implementación por defecto del manager View3DManager
412

    
413
DefaultViewPanel3D implements ViewPanel3D
414
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
415

    
416
Implementación por defecto de los métodos descritos en la interfaz ViewPanel3D. Esta clase tendrá asociado un MapContext que permitirá obtener información acerca del enfoque, escucha eventos de cambio sobre capas y enfoque, versionado... 
417

    
418
* public DefaultViewPanel3D(MapContext mapContext, TYPE type);
419

    
420
  Constructor que permite instancia un nuevo visor 3D a partir de un MapContext y el tipo. Este constructor accederá a las capas del mapContext para añadirlas al componente de la librería WW. Para añadir una capa al componente WW es necesaria una transformación (``LayerConverter#convertToLayer(layer)``) de la capa gvSIG a una capa WW en base al modo de carga asociado especificado por el usuario.
421

    
422
LayerConverter
423
~~~~~~~~~~~~~~~~~~~~~~
424

    
425
Interfaz que permite convertir una capa gvSIG en una capa WW o en un modelo de elevación. Este proceso depende del tipo de capa y el modo de carga definido.
426

    
427
* convertToLayer(FLayer layer) : gov.nasa.worldwind.layers.Layer
428

    
429
  Método que a partir de una capa gvSIG obtiene una capa WW.
430

    
431
* convertToElevationModel(FLayer layer) : gov.nasa.worldwind.globes.ElevationModel
432

    
433
  Método que permite convertir una capa de gvSIG en un ElevationModel el cual representa una elevación del terreno.
434

    
435
DefaultLayerConverter
436
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
437

    
438
Implementación por defecto de la interfaz LayerConverter. Esta clase permite convertir una capa de gvSIG en un DataRaster genérico el cual permitirá pintar la zona requeridas mediante el método ``FLayer#draw(image,graphics,viewport,scale)``. 
439

    
440
RasterTiledImageLayer extends BasicTiledImageLayer
441
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
442

    
443
Implementación de una capa WW. Entre otras funcionalidades, esta capa gestiona las peticiones de texturas e imágenes que recibe por parte de la aplicación así como la composición de tiles para un sector en concreto, las diferentes resoluciones por nivel de detalle y la creación de tareas para la recuperación / generación de tiles.
444

    
445
Esta capa tiene enlazado un objeto DefaultRetrieverFactory que le permite a la capa crear objetos DefaultRasterRetriever para gestionar las peticiones de datos para la creación de tiles.
446

    
447
En principio solo que habrá que sobrescribir los constructores de la clase BasicTiledImageLayer para que cuando se instancie una capa RasterTiledImageLayer se instancie también un DefaultretrieverFactory a partir de los parámetros.
448

    
449
DefaultRetrieverFactory implements RetrieverFactory
450
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
451

    
452
Implementación por defecto de un RetrieverFactory. Representa la factoría para la creación de instancias de objetos Retriever.
453

    
454
* createRetriever(AVList params, RetrievalPostProcessor postProcessor) : Retriever
455

    
456
  Instancia una implementación de la interfaz Retriever a partir de una lista de parámetros y un RetrievalPostProcessor que recibe como parámetro y una instancia local de RasterServer.
457

    
458
DefaultRasterRetriever implements Retriever
459
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
460

    
461
Implementación por defecto de Retriever. Esta clase gestiona las peticiones de imágenes que recibe por parte de la capa. Permite configurar tiempos de respuesta como timeouts, tiempo de expiración... además permite saber el estado en que se encuentra el retriever.
462

    
463
DefaultRasterServer implements RasterServer
464
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465

    
466
Implementación por defecto de la interfaz RasterServer. Como su nombre indica esta clase representa un servidor de raster que atiende a las peticiones realizadas por objetos Retriever. Cuando recibe una petición mediante el método ``RasterServer#getRasterAsByteBuffer()`` accede al DataRaster que tiene asociado obtiene la información que precisa y la devuelve en un objeto de tipo java.nio.ByteBuffer.
467

    
468
* getRasterAsByteBuffer(AVList params) : ByteBuffer
469

    
470
  Obtiene del DataRaster asociado la información definida en los parámetros que recibe y la devuelve en un objeto java.nio.ByteBuffer.
471

    
472
* getSector() : Sector
473

    
474
  Obtiene el sector del data raster asociado.
475

    
476
DefaulDataRasterReaderFactory extends BasicDataRasterReaderFactory
477
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
478

    
479
Factoría que permite la creación de nuestra implementación DefaultDataReaderRasterReader a partir de un objeto de tipo DataStore.
480

    
481
* findReaderFor(Object source, AVList params) : DataRasterReader
482

    
483
  Obtiene la instancia de DataRasterReader apropiada para la lectura de la fuente de datos.
484

    
485
DefaultDataRasterReader extends AbstractDataRasterReader
486
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
487

    
488
Permite saber si se puede leer y obtener objetos DataRaster a partir de DataStore validando lo parámetros y metadatos del almacén.
489

    
490
* canRead(Object source, AVList params) : boolean
491

    
492
  Obtiene si este DataRasterReader es capaz de leer la fuente de datos y crear objetos DataRaster.
493

    
494
* read(Object source, AVList params) throws java.io.IOException : DataRaster[]
495

    
496
  Lee de la fuente de datos y crea objetos DataRaster
497

    
498
* readMetadata(Object source, AVList params) throws java.io.IOException : AVList
499

    
500
  Obtiene los metadatos asociados a las fuente de datos. Los metadatos varían en función de la fuente y el DataRasterReader.
501

    
502
* isImageryRaster(Object source, AVList params) : boolean
503

    
504
  Obtiene si la fuente de datos es de tipo raster imagen.
505

    
506
* isElevationsRaster(Object source, AVList params) : boolean
507

    
508
  Obtiene si la fuente de datos es de tipo imagen
509

    
510
GvSIGLayerDataRaster implements DataRaster
511
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
512

    
513
Representa información raster. Esta clase recibe peticiones de datos para la generación de tiles por lo que es la encargada de mediante el método ``FLayer#draw()`` de la capa que tiene asociada pintar la sección requerida.
514

    
515
* getWidth() : int
516

    
517
  Obtiene el ancho en píxeles del raster.
518

    
519
* getHeiht() : int
520

    
521
  Obtiene el alto en píxeles del raster.
522

    
523
* drawOnTo(DataRaster canvas) : void
524

    
525
  Copia la información de este raster al especificado por parámetro. Es usado para hacer peticiones de datos sobre zonas determinadas por el tamaño y posición del DataRaster especificado.
526

    
527
* getSubRaster(AVList params) : DataRaster
528

    
529
  A partir de los parámetros que recibe obtiene una sección del raster.
530

    
531
* getSubRaster(int with, int height, Sector sector, AVList params) : DataRaster
532

    
533
  A partir de los parámetros que recibe obtiene una sección del raster.
534

    
535
View3D APP
536
----------------
537

    
538
Este es el módulo donde se encuentran los diferentes plugins de la librería. Se deben implementar en total cinco plugins. Por un lado, habrá un plugin llamada **org.gvsig.view3d.app.common** el cual contiene todas las extensiones de la librería y los paneles de preferencias de aplicación y de propiedades de vista. Además, debe de tener las dependencias comunes a todas las plataformas y el archivo de configuración "config.xml" para la creación de las entradas de menú y botones en gvSIG. Por otro lado, debe de haber un plugin por cada plataforma el cual no debe de contener ninguna clase debido a que ya se encuentran en el plugin "common". Este plugin solo debe de gestionar las dependencias nativas con la plataforma correspondiente y preparar el empaquetado JAR para que se despliegue como si fuera un plugin normal usando el archivo de configuración del plugin org.gvsig.view3d.app.common así como sus dependencias junto con las dependencias nativas. El resultado esperado debería ser:
539

    
540
* org.gvsig.view3d.app
541

    
542
  - about
543
  - i18n
544
  - images
545
  - lib
546

    
547
    + dependencias comunes
548
    + dependencias nativas de la plataforma
549

    
550
  - config.xml
551
  - package.info
552

    
553
Plugin common
554
~~~~~~~~~~~~~~~~~~~~~~
555

    
556
El plugin common (org.gvsig.view3d.app.common) estará compuesto por tres extensiones: View3DExtension, RefreshView3DExtension y SynchronizeView3DExtension. Además, gestionará la persistencia de las opciones establecidas por el usuario.
557

    
558
* View3DExtension: extensión de Andami asociada a dos acciones: "flat-view3d" y "sphere-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 panel, añadirán las capas de la vista activa, y lo mostrarán.
559
* 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 ViewPanel3D y ejecutará la operación ``ViewPanel3D#reloadLayers()``.
560
* 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 ViewPanel3D y ejecutará la operación ``ViewPanel3D#synchronizeViewPorts()``.
561

    
562
Preferencias
563
~~~~~~~~~~~~~~~~~~~~~~
564

    
565
El plugin view3D maneja diferentes tipos de preferencias que dependiendo de a que afecten se sitúan en un lugar u otro. Existen tres tipos: preferencias 3D de capa, preferencias de vista y preferencias generales.
566

    
567
Preferencias 3D de capa
568
________________________
569

    
570
La preferecias de capa afectan solo a una capa. Esta preferencias serán accesibles desde la propiedades de capa del menu contextual del TOC. Para añadir una nueva pestaña a las propiedades de una capa, nuestro panel de propiedades 3D debe extender de la clase ``AbstractThemeManagePage``. La clase que representa la vista se creará dentro de `Plugin common`_ y usuará como modelo la clase `LayerProperties3D`_. A continuación se muestra dos *mockups* de los paneles. El primero representa los parámetros configurables cuando el modo de carga es *Vectorial rasterizada* e *Imagen raster* mientras que el segundo *mockup* representa las opciones configurables cuando el modo de carga es *Modelo ditital del terreno*.
571

    
572
.. image:: images/layer-properties-raster.jpg
573

    
574
Mockup 1: Panel de propiedades cuando el modo de carga es *Vectorial rasterizada* o *Imagen raster*.
575
Explicación de las propiedades:
576

    
577
* Formato de imagen: formato de los tiles generados. Las opciones disponibles son png, jpg, jpeg y dds.
578
* Nivel de detalle: numero mínimo y máximo de nivel de detalle. Para el valor óptimo dejar en blanco.
579
* Resolución nivel cero: resolución en el nivel cero. Por defecto se calcula el valor óptimo teniendo en cuenta el número de niveles de detalle y el tamaño del pixel del raster. En la posición central se situa el valor por defecto, el cual es aumentado o reducido si el usuario establece una resolución baja o alta en el nivel cero.
580
* Tamaño de tesela: tamaño en pixeles de los tiles generados.
581

    
582
.. image:: images/layer-properties-mdt.jpg
583

    
584
Mockup 2: Panel de propiedades cuando el modo de carga es *Modelo digital del terreno*.
585
Explicación de las propiedades disponibles:
586

    
587
* Formato de la imagen: formato de los tiles de elevación generados. Se puede elegir entre Bil16 o Bil32.
588
* Campo altura: al elegir sobre una capa vectorial el modo de cargar MDT, este campo se activa para indicar que campo del FeatureType representa la altura. Si la capa no es de tipo vectorial este campo aparecerá deshabilitado.
589
* Unidades del valor altura: Unidades del valor alutura. Dos opciones: metros y pies.
590
* Valor No Data: Valor del No Data. Todos los pixeles con este valor no se representarán en el visor.
591
* Nivel de detalle: numero mínimo y máximo de nivel de detalle. Para el valor óptimo dejar en blanco.
592
* Resolución nivel cero: resolución en el nivel cero. Por defecto se calcula el valor óptimo teniendo en cuenta el número de niveles de detalle y el tamaño del pixel del raster. En la posición central se situa el valor por defecto, el cual es aumentado o reducido si el usuario establece una resolución baja o alta en el nivel cero.
593
* Tamaño de tesela: tamaño en pixeles de los tiles.
594

    
595

    
596
Properties3DManager extends AbstractThemeManagerPage
597
''''''''''''''''''''''''''''''''''''''''''''''''''''
598

    
599
* getName()
600

    
601
  Obtiene el nombre de la pestaña que mostrará el panel. En este caso "3D".
602

    
603
* getPriority()
604

    
605
  Obtiene la priporidad del panel. Cuanta más prioridad más a la izquierda aparecerá.
606

    
607
* acceptAction()
608

    
609
  Método ejecutado cuando el botón "Aceptar" es pulsado. Delega en el método Properties3DManager#applyAction().
610

    
611
* applyAction()
612

    
613
  Método ejecutado cuando el botón "Aplicar" es pulsado. Se debe obtener los valores de los campos del panel de propiedades y actualizar el modelo de la capa correspondiente.
614

    
615
* cancelAction()
616

    
617
  Método ejecutado cuando el botón "Cancelar" es pulsado. Se deben de descartar todos los cambios efectuados sobre el modelo de la capa.
618

    
619
* setModel(FLayer)
620

    
621
  Método ejecutado al abrir el panel de propiedades. Debe de obtener el modelo a partir de la capa y actualizar los campos del panel.
622

    
623

    
624
Persistencia
625
~~~~~~~~~~~~~~~~~~~~~~
626

    
627
.. note::
628
   TODO