mil.navy.nps.rra

Class PrintVRML

java.lang.Object

mil.navy.nps.rra.PrintVRML

public class PrintVRML
extends Object

Utility methods used to build a VRML scene, each returning standard VRML node strings.

Specifically, PrintVRML sends VRML strings for various header, DirectionalLight, NavigationInfo, Viewpoint and legend-building PROTO nodes to standard output.

Version:

$Revision: 1.8 $

Author:

LT Timothy M. Holliday USN

Contact: Don Brutzman (web.nps.navy.mil/~brutzman) brutzman@nps.navy.mil

Source Code:

~vrtp/mil/navy/nps/rra/PrintVRML.java

http://web.nps.navy.mil/~brutzman/vrtp/mil/navy/nps/rra/PrintVRML.java

History:

15 Jan 98	Timothy M. Holliday	New
14 May 98	Timothy M. Holliday	Added color and intensity schemes
18 May 98	Timothy M. Holliday	Added VRML colorBarView and textNode
10 Oct 98	Don Brutzman	Javadoc updates for jdk1.2b4 Fixed PROTO initialization/repetition problems
26 April 99	Don Brutzman	Javadoc updates for jdk1.2.1, revised some method names to match get/set naming convention.

Reference:

Holliday, Timothy, Real-Time 3D Sonar Modeling and Visualization, Master's Thesis, Naval Postgraduate School, Monterey California, June 1998. Available at vrtp/rra/HollidayRRAthesis.pdf. and web.nps.navy.mil/~brutzman/vrtp/rra/HollidayRRAthesis.pdf. Slideset available in Powerpoint and Acrobat .pdf formats.

See Also:

Bottom, Surface, SSP, Lobe

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLUE color code value is 4
static String	CENTER string MIDDLE
static int	CONSTANT color code value is 6
static int	GREEN color code value is 3
static String	HORIZONTAL string transform value for VRML
static String	LEFT string BEGIN
static int	LINEAR color code value is 7
int	protoColorBarCount int value for count of proto color
static boolean	protoLegendViewpointFirstInvocation boolean for the first setting for VRML viewpoint node
static int	RAINBOW color code value is 1
static int	RED color code value is 2
static String	RIGHT string END
static int	TRICOLOR color code value is 5
static String	VERTICAL string transform valur for VRML

Constructor Summary

Constructors

Constructor and Description
PrintVRML()

Method Summary

Modifier and Type	Method and Description
String	colorBar(String verticalLabel, String horizontalLabel, String detectionLabel, String counterDetectionLabel) Produce colorbar; only includes detectionLabel and counterDetectionLabel if colorScheme is case TRICOLOR.
boolean	getAppendLineFeed() Return what character is used for end-of-line.
String	getBackground() Return Background node with default values.
String	getBackground(double r, double g, double b) Return Background node with specified (r, g, b) values.
String	getColor() Return color value for current point based on color scheme.
String	getColorBarViewpoint(String title, double x, double y, double z, double xAxis, double yAxis, double zAxis, double theta) Return colorBar Viewpoint node, requires protoColorBar for initialization first.
String	getLegendViewpoint(String title, String info1, String info2, String info3, String info4, String info5, double x, double y, double z) Initialization prior to producing viewpoint for scene legend (color scales and description), by defining a PROTO node.
String	getScaleGeometry(String label, double maximum, double minimum, double x, double y, double z, double xAxis, double yAxis, double zAxis, double theta, int divisions) Return VRML string for the in-scene spatial scale.
String	getSceneHeader() Return standard VRML file header, DirectionalLight, NavigationInfo.
String	protoColorBar(String verticalLabel, String horizontalLabel, String vSubLabel1, String vSubLabel2) Return another sequentially numbered protoColorBar.
void	setAppendLineFeed(boolean pAppendLineFeed) Specify whether linefeeds are appended to lines.
void	setColorScheme(int scheme) Default stub to set counterdetection color scheme - needs work.
void	setColorScheme(int scheme, double maximum, double minimum) User-selectable stub to set counterdetection color scheme - needs work.
void	setColorScheme(int scheme, double maximum, double detection, double counterDetection, double minimum) User-selectable stub to set counterdetection color scheme - needs work.
void	setColorValue(double value) Set color intensity if capped.
void	setIntensityScheme(int scheme) User-selectable stub to set color intensity scheme, current values for scheme are LINEAR and CONSTANT - needs work.
void	setIntensityScheme(int scheme, double maximum, double minimum) User-selectable stub to set color intensity scheme, current values for scheme are LINEAR and CONSTANT - needs work.
void	setIntensityValue(double value) Intensity factor is multiplied against all color components.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RAINBOW

public static final int RAINBOW

color code value is 1

See Also:

Constant Field Values

RED

public static final int RED

color code value is 2

See Also:

Constant Field Values

GREEN

public static final int GREEN

color code value is 3

See Also:

Constant Field Values

BLUE

public static final int BLUE

color code value is 4

See Also:

Constant Field Values

TRICOLOR

public static final int TRICOLOR

color code value is 5

See Also:

Constant Field Values

CONSTANT

public static final int CONSTANT

color code value is 6

See Also:

Constant Field Values

LINEAR

public static final int LINEAR

color code value is 7

See Also:

Constant Field Values

HORIZONTAL

public static final String HORIZONTAL

string transform value for VRML

See Also:

Constant Field Values

VERTICAL

public static final String VERTICAL

string transform valur for VRML

See Also:

Constant Field Values

RIGHT

public static final String RIGHT

string END

See Also:

Constant Field Values

CENTER

public static final String CENTER

string MIDDLE

See Also:

Constant Field Values

LEFT

public static final String LEFT

string BEGIN

See Also:

Constant Field Values

protoLegendViewpointFirstInvocation

public static boolean protoLegendViewpointFirstInvocation

boolean for the first setting for VRML viewpoint node

protoColorBarCount

public int protoColorBarCount

int value for count of proto color

Constructor Detail

PrintVRML

public PrintVRML()

Method Detail

getSceneHeader

public String getSceneHeader()

Return standard VRML file header, DirectionalLight, NavigationInfo.

Returns:

standard VRML file header, DirectionalLight, NavigationInfo.

getBackground

public String getBackground()

Return Background node with default values.

Returns:

Background node.

getBackground

public String getBackground(double r,
                            double g,
                            double b)

Return Background node with specified (r, g, b) values.

Parameters:

r - the rgb color code r

g - the rgb color code g

b - the rgb color code b

Returns:

Background node.

getLegendViewpoint

public String getLegendViewpoint(String title,
                                 String info1,
                                 String info2,
                                 String info3,
                                 String info4,
                                 String info5,
                                 double x,
                                 double y,
                                 double z)

Initialization prior to producing viewpoint for scene legend (color scales and description), by defining a PROTO node.

Parameters:

title - title of String.

info1 - infor 1 for EXTERNPROTO protoLegendViewpoint node

info2 - infor 2 for EXTERNPROTO protoLegendViewpoint node

info3 - infor 3 for EXTERNPROTO protoLegendViewpoint node

info4 - infor 4 for EXTERNPROTO protoLegendViewpoint node

info5 - infor 5 for EXTERNPROTO protoLegendViewpoint node

x - x coordinate for EXTERNPROTO protoLegendViewpoint node

y - y coordinate for EXTERNPROTO protoLegendViewpoint node

z - z coordinate for EXTERNPROTO protoLegendViewpoint node

Returns:

VRML PROTO node.

protoColorBar

public String protoColorBar(String verticalLabel,
                            String horizontalLabel,
                            String vSubLabel1,
                            String vSubLabel2)

Return another sequentially numbered protoColorBar.

Parameters:

verticalLabel - vertical label for PROTO protoColorBar node.

horizontalLabel - vertical label for PROTO protoColorBar node.

vSubLabel1 - label for Transform children node.

vSubLabel2 - label for Transform children node.

Returns:

VRML PROTO protoColorBar node.

getColorBarViewpoint

public String getColorBarViewpoint(String title,
                                   double x,
                                   double y,
                                   double z,
                                   double xAxis,
                                   double yAxis,
                                   double zAxis,
                                   double theta)

Return colorBar Viewpoint node, requires protoColorBar for initialization first.

Parameters:

title - viewpoint title.

x - coordinate x for Transform translation node.

y - coordinate y for Transform translation node.

z - coordinate z for Transform translation node.

xAxis - coordinate xAxis for Transform rotation node.

yAxis - coordinate yAxis for Transform rotation node.

zAxis - coordinate zAxis for Transform rotation node.

theta - theta value for Transform rotation node.

Returns:

VRML Transform node.

setAppendLineFeed

public void setAppendLineFeed(boolean pAppendLineFeed)

Specify whether linefeeds are appended to lines.

Parameters:

pAppendLineFeed - 'true' is LINE_FEED or 'false' is SPACE.

getAppendLineFeed

public boolean getAppendLineFeed()

Return what character is used for end-of-line.

Returns:

the character for end-of-line.

setColorScheme

public void setColorScheme(int scheme)

Default stub to set counterdetection color scheme - needs work.

Parameters:

scheme - color scheme.

setColorScheme

public void setColorScheme(int scheme,
                           double maximum,
                           double minimum)

User-selectable stub to set counterdetection color scheme - needs work.

Parameters:

scheme - color scheme.

maximum - maximum of color.

minimum - minimum of color.

setColorScheme

public void setColorScheme(int scheme,
                           double maximum,
                           double detection,
                           double counterDetection,
                           double minimum)

User-selectable stub to set counterdetection color scheme - needs work.

Parameters:

scheme - color scheme.

maximum - maximum color.

detection - color detection.

counterDetection - counterdetection for color scheme.

minimum - minimum color for Delta.

setColorValue

public void setColorValue(double value)

Set color intensity if capped.

Parameters:

value - color intensity.

setIntensityScheme

public void setIntensityScheme(int scheme)

User-selectable stub to set color intensity scheme, current values for scheme are LINEAR and CONSTANT - needs work.

Parameters:

scheme - color scheme.

setIntensityScheme

public void setIntensityScheme(int scheme,
                               double maximum,
                               double minimum)

User-selectable stub to set color intensity scheme, current values for scheme are LINEAR and CONSTANT - needs work.

Parameters:

scheme - color scheme.

maximum - maximu of color intensity.

minimum - minimum of color intensity.

setIntensityValue

public void setIntensityValue(double value)

Intensity factor is multiplied against all color components.

Parameters:

value - intensity value.

getColor

public String getColor()

Return color value for current point based on color scheme.

Returns:

string of color value.

colorBar

public String colorBar(String verticalLabel,
                       String horizontalLabel,
                       String detectionLabel,
                       String counterDetectionLabel)

Produce colorbar; only includes detectionLabel and counterDetectionLabel if colorScheme is case TRICOLOR.

Parameters:

verticalLabel - String text.

horizontalLabel - String text.

detectionLabel - String text.

counterDetectionLabel - String text.

Returns:

String value of VRML Transform Text node.

getScaleGeometry

public String getScaleGeometry(String label,
                               double maximum,
                               double minimum,
                               double x,
                               double y,
                               double z,
                               double xAxis,
                               double yAxis,
                               double zAxis,
                               double theta,
                               int divisions)

Return VRML string for the in-scene spatial scale.

Parameters:

label - String label for

maximum - maximum value for Transform point node.

minimum - minimum value for Transform point node.

x - coordinate x for Transform node.

y - coordinate y for Transform node.

z - coordinate z for Transform node.

xAxis - coordinate xAxis for Transform translation node.

yAxis - coordinate yAxis for Transform translation node.

zAxis - coordinate zAxis for Transform translation node.

theta - theta value for for Transform translation node.

divisions - int divisions value.

Returns:

VRML string for the in-scene spatial scale.