SceneGenerator (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- SonarVis.Metcast.MetcastTools.SceneGenerator

```
public class SceneGenerator
extends Object
```
This class generates a 3D sonar visualization scene based on inputs from the Metcast Web Service.* This class fomrats generated output into proper xml file form.

Version:

$Revision: 1.14 $

Author:

Scott Rosetti, LT USN
Contact: Don Brutzman (web.nps.navy.mil/~brutzman) brutzman@nps.navy.mil

See Also:

Bathymetry, EnvironmentalData, MetcastClientMain, MetcastTestClient, ModelOutputFormatter, SeawaterTemp, SignificantWaveHeight, SonarSource, SonarTarget, SoundSpeed, Windspeed

Field Summary

Fields
Modifier and Type Field and Description

StringBuffer xData
data imported from files

Fields
Modifier and Type	Field and Description
`StringBuffer`	`xData` data imported from files

Constructor Summary

Constructors
Constructor and Description
`SceneGenerator()` Creates a new instance of SceneGenerator
`SceneGenerator(double s, EnvironmentalData eData, double lat, double lon)` Creates a new instance of SceneGenerator

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExternalX3D(String data)` Add stored external data.
`String`	`addSource()` Adds source directly from xml file - UNDER CONSTRUCTION
`String`	`addSource(double lat, double depth, double lon, double elev, double azimuth, int rads, double beamWidth, String modelType)` Adds source to scene - NEED TO ADD PROPER LAT/LONG CONVERSION ALGORITHMS
`String`	`addTarget(double lat, double y, double lon)` Add target to scene
`String`	`createScene()` Creates contents portion of X3D file.
`String`	`createX3D()` creates X3D version of scene
`String`	`createX3DHeader()` Generates X3D Header
`String`	`generateColorScheme(double[] array)` Generate color scheme for bathymetry.
`String`	`generateWindowDisplay(boolean live)` Temporary method to create Xj3D firendly version
`double[]`	`getBathArray()` Returns bathymetric values array
`String`	`getBathString()` Returns bathymetric values in string
`EnvironmentalData`	`getEnvironmentalData()` Returns environmental data
`String[]`	`getGeneratedOutputFiles()` Returns generated output files
`double`	`getMaxDepth()` Returns deepest points
`int`	`getNumberPoints()` Returns number of points
`int`	`getNumberSources()` Returns number of sources
`int`	`getNumberTargets()` Returns number of targets
`LinkedList<StringBuffer>`	`getSourceRegistry()` Returns source registry
`double`	`getSpacing()` Returns spacing between data points
`double[][]`	`getTargetLocations()` Returns target location - based on index
`LinkedList<String>`	`getTargetRegistry()` Returns target registry.
`double`	`getTranslation()` Returns translation - distance between "0 0 0" and side of area
`void`	`refreshScene()` addExternalX3D /** Refresh X3D scene
`void`	`registerTarget(double x, double y, double z)` Register target
`void`	`reset()` resets parameters to default values
`void`	`setParameters(double s, EnvironmentalData eData, double lat, double lon)` Sets parameters in scene

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - xData
```
public StringBuffer xData
```
    data imported from files
- Constructor Detail
  - SceneGenerator
```
public SceneGenerator()
```
    Creates a new instance of SceneGenerator
  - SceneGenerator
```
public SceneGenerator(double s,
                      EnvironmentalData eData,
                      double lat,
                      double lon)
```
    Creates a new instance of SceneGenerator
    
    Parameters:
    
    s - The size refers to a single side of area in nm.
    
    eData - The container class to hold environmental data.
    
    lat - The latitude of NW corner of area.
    
    lon - The longitude of NW corner of area.
- Method Detail
  - setParameters
```
public void setParameters(double s,
                          EnvironmentalData eData,
                          double lat,
                          double lon)
```
    Sets parameters in scene
    
    Parameters:
    
    s - The size refers to a single side of area in nm.
    
    eData - The container class to hold environmental data .
    
    lat - The latitude of NW corner of area.
    
    lon - The longitude of NW corner of area.
  - reset
```
public void reset()
```
    resets parameters to default values
  - createX3D
```
public String createX3D()
```
    creates X3D version of scene
    
    Returns:
    
    The string value of X3D header and scene.
  - createX3DHeader
```
public String createX3DHeader()
```
    Generates X3D Header
    
    Returns:
    
    The string value of X3D header.
  - createScene
```
public String createScene()
```
    Creates contents portion of X3D file.
    
    Returns:
    
    The string value of X3D scene.
  - addSource
```
public String addSource()
```
    Adds source directly from xml file - UNDER CONSTRUCTION
    
    Returns:
    
    The string value of generated document.
  - addSource
```
public String addSource(double lat,
                        double depth,
                        double lon,
                        double elev,
                        double azimuth,
                        int rads,
                        double beamWidth,
                        String modelType)
```
    Adds source to scene - NEED TO ADD PROPER LAT/LONG CONVERSION ALGORITHMS
    
    Parameters:
    
    lat - The latitude of NW corner of area.
    
    depth - The depth in area.
    
    lon - The longitude of NW corner of area.
    
    elev - The vertical angle of "center" beam (in degrees) to creates a new instance of SourceGenerator.
    
    azimuth - The horizontal angle of "center" beam (in degrees from 000) to creates a new instance of SourceGenerator.
    
    rads - The number of radials to creates a new instance of SourceGenerator.
    
    beamWidth - The angle (in degrees) of horizontal sweep area to creates a new instance of SourceGenerator.
    
    modelType - The string describing which model engine to access to creates a new instance of SourceGenerator.
    
    Returns:
    
    The string value of the new generated X3D source.
  - addTarget
```
public String addTarget(double lat,
                        double y,
                        double lon)
```
    Add target to scene
    
    Parameters:
    
    lat - The latitude of NW corner of area.
    
    y - The y coordinate.
    
    lon - The longitude of NW corner of area.
    
    Returns:
    
    The string value of X3D Transform node.
  - registerTarget
```
public void registerTarget(double x,
                           double y,
                           double z)
```
    Register target
    
    Parameters:
    
    x - The coordinate point x.
    
    y - The coordinate point y.
    
    z - The coordinate point z.
  - addExternalX3D
```
public void addExternalX3D(String data)
```
    Add stored external data.
    
    Parameters:
    
    data - The string value of external X3D.
  - refreshScene
```
public void refreshScene()
```
    addExternalX3D /** Refresh X3D scene
  - generateColorScheme
```
public String generateColorScheme(double[] array)
```
    Generate color scheme for bathymetry.
    
    Parameters:
    
    array - The double array of depth.
    
    Returns:
    
    The string value of color code.
  - generateWindowDisplay
```
public String generateWindowDisplay(boolean live)
```
    Temporary method to create Xj3D firendly version
    
    Parameters:
    
    live - 'true' do nothing, 'false' set parmeters for Xj3D.
    
    Returns:
    
    The string value of generated VRML code.
  - getEnvironmentalData
```
public EnvironmentalData getEnvironmentalData()
```
    Returns environmental data
    
    Returns:
    
    EnvironmentalData object.
  - getNumberTargets
```
public int getNumberTargets()
```
    Returns number of targets
    
    Returns:
    
    The number of targets.
  - getNumberSources
```
public int getNumberSources()
```
    Returns number of sources
    
    Returns:
    
    The number of sources.
  - getNumberPoints
```
public int getNumberPoints()
```
    Returns number of points
    
    Returns:
    
    The number of points.
  - getSpacing
```
public double getSpacing()
```
    Returns spacing between data points
    
    Returns:
    
    The spacing between data points.
  - getTranslation
```
public double getTranslation()
```
    Returns translation - distance between "0 0 0" and side of area
    
    Returns:
    
    The translation of distance between "0 0 0" and side of area.
  - getBathString
```
public String getBathString()
```
    Returns bathymetric values in string
    
    Returns:
    
    The string value of batymetric values.
  - getMaxDepth
```
public double getMaxDepth()
```
    Returns deepest points
    
    Returns:
    
    The deepest points.
  - getBathArray
```
public double[] getBathArray()
```
    Returns bathymetric values array
    
    Returns:
    
    The bathymetric values array.
  - getTargetRegistry
```
public LinkedList<String> getTargetRegistry()
```
    Returns target registry.
    
    Returns:
    
    The target registry.
  - getSourceRegistry
```
public LinkedList<StringBuffer> getSourceRegistry()
```
    Returns source registry
    
    Returns:
    
    The source registry.
  - getTargetLocations
```
public double[][] getTargetLocations()
```
    Returns target location - based on index
    
    Returns:
    
    The target location - based on index.
  - getGeneratedOutputFiles
```
public String[] getGeneratedOutputFiles()
```
    Returns generated output files
    
    Returns:
    
    The string value of generated output files.

Class SceneGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

xData

Constructor Detail

SceneGenerator

SceneGenerator

Method Detail

setParameters

reset

createX3D

createX3DHeader

createScene

addSource

addSource

addTarget

registerTarget

addExternalX3D

refreshScene

generateColorScheme

generateWindowDisplay

getEnvironmentalData

getNumberTargets

getNumberSources

getNumberPoints

getSpacing

getTranslation

getBathString

getMaxDepth

getBathArray

getTargetRegistry

getSourceRegistry

getTargetLocations

getGeneratedOutputFiles