PamGraph3D

Class PamShapes3D

java.lang.Object

PamGraph3D.PamShapes3D

public class PamShapes3D
extends java.lang.Object

Simple class to hold various useful 3D shapes for Pamguard.

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field and Description
static javax.vecmath.Color3f	black
static javax.vecmath.Color3f	blue
static javax.vecmath.Color3f	green
static javax.vecmath.Color3f	grey
static javax.vecmath.Color3f	orange
static javax.vecmath.Color3f[]	pamColours3D
static javax.vecmath.Color3f	purple
static javax.vecmath.Color3f	red
static javax.vecmath.Color3f	white
static javax.vecmath.Color3f	yellow

Constructor Summary

Constructors

Constructor and Description
PamShapes3D()

Method Summary

Methods

Modifier and Type	Method and Description
static javax.media.j3d.Shape3D	create3DCross(float x, float y, float z, javax.media.j3d.Appearance lineApp) Creates a 3D cross, with each axis of the cross the size specified by x, y and z.
static javax.media.j3d.BranchGroup	createAxis(float v1, float v2, float v3, float textSize, java.lang.String l1, java.lang.String l2, java.lang.String l3, javax.vecmath.Color3f col) Creates a set of labelled axis showing each 3D dimension.
static javax.media.j3d.BranchGroup	createHydrophoneArray(java.util.ArrayList<javax.vecmath.Point3d> hydrophones)
static javax.media.j3d.BranchGroup	createSeaSurface(float width, javax.vecmath.Color3f colour) Creates a semi-transparent square surface of specified width and colour.
static javax.media.j3d.Shape3D	createSphere(javax.media.j3d.Appearance ap, float size) Create a sphere with appearance ap and specified size.
static javax.media.j3d.TransformGroup	createSphere(javax.vecmath.Point3f point3f, javax.media.j3d.Appearance ap, float size) Create a sphere of appearance ap moved to a position specified by point3f.
static javax.media.j3d.Geometry	createStripGeomtry(java.util.ArrayList<javax.vecmath.Point3f[]> strips) Creates the geometry for a shape defined by a series of circular strips.
static javax.vecmath.Color3f	getPamColour3D(int i) Get a colour form a set colour array
static javax.media.j3d.Appearance	lineAppearance(float LineWidth, boolean AntiAliasing, javax.vecmath.Color3f colour) Specific function for setting the appearance of a line.
static javax.media.j3d.Shape3D	linePolygon3D(java.util.ArrayList<javax.vecmath.Point3f> Data, javax.media.j3d.Appearance app) Creates a joined series of lines specified by an array of 3D points.
static javax.media.j3d.Appearance	PointAppearance(float size, javax.vecmath.Color3f colour) Create an appearance for a pointArray.
static javax.media.j3d.Shape3D	pointArray3D(java.util.ArrayList<javax.vecmath.Point3f> Data, javax.media.j3d.Appearance app) Creates a series of points specified by an array of 3d points of appearance ap
static javax.vecmath.Color3f	randomBlue() Creates a random colour of blue.
static javax.vecmath.Color3f	randomGreen()
static javax.vecmath.Color3f	randomRed() Creates a random colour of blue.
static javax.media.j3d.Appearance	sphereAppearance(javax.vecmath.Color3f col) Creates an appearance.
static javax.media.j3d.Appearance	sphereAppearanceMatt(javax.vecmath.Color3f col) Creates a sphere appearance.
static javax.media.j3d.Appearance	surfaceAppearance(javax.vecmath.Color3f colour, float alpha) Simple appearance for surface.

Methods inherited from class java.lang.Object

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

Field Detail

red

public static javax.vecmath.Color3f red

blue

public static javax.vecmath.Color3f blue

green

public static javax.vecmath.Color3f green

black

public static javax.vecmath.Color3f black

white

public static javax.vecmath.Color3f white

grey

public static javax.vecmath.Color3f grey

purple

public static javax.vecmath.Color3f purple

yellow

public static javax.vecmath.Color3f yellow

orange

public static javax.vecmath.Color3f orange

pamColours3D

public static javax.vecmath.Color3f[] pamColours3D

Constructor Detail

PamShapes3D

public PamShapes3D()

Method Detail

createHydrophoneArray

public static javax.media.j3d.BranchGroup createHydrophoneArray(java.util.ArrayList<javax.vecmath.Point3d> hydrophones)

createSphere

public static javax.media.j3d.TransformGroup createSphere(javax.vecmath.Point3f point3f,
                                          javax.media.j3d.Appearance ap,
                                          float size)

Create a sphere of appearance ap moved to a position specified by point3f.

Parameters:

point3f-the - desired position of the sphere

ap- - the sphere appearance.

size- - the size of the sphere.

Returns:

A transform group containing a sphere at a specified position.

createSphere

public static javax.media.j3d.Shape3D createSphere(javax.media.j3d.Appearance ap,
                                   float size)

Create a sphere with appearance ap and specified size.

Parameters:

ap- - appearance of the sphere.

size - - size of the sphere

Returns:

A Shape3D sphere.

sphereAppearance

public static javax.media.j3d.Appearance sphereAppearance(javax.vecmath.Color3f col)

Creates an appearance. This appearance allows interaction with lighting effects. This can be used with other 3D shapes if required.

Parameters:

col- - colour of the sphere.

sphereAppearanceMatt

public static javax.media.j3d.Appearance sphereAppearanceMatt(javax.vecmath.Color3f col)

Creates a sphere appearance. This appearance does not allow for interaction with lighting effects. This can be used with other 3D shapes if required.

Parameters:

col -

Returns:

createSeaSurface

public static javax.media.j3d.BranchGroup createSeaSurface(float width,
                                           javax.vecmath.Color3f colour)

Creates a semi-transparent square surface of specified width and colour. Useful to show sea surfaces.

Parameters:

width- - width of surface.

colour-colour - of surface

Returns:

BranchGroup containing translucent square surface.

create3DCross

public static javax.media.j3d.Shape3D create3DCross(float x,
                                    float y,
                                    float z,
                                    javax.media.j3d.Appearance lineApp)

Creates a 3D cross, with each axis of the cross the size specified by x, y and z. The appearance of the cross is determined by lineApp

Parameters:

x- - size of the cross in x

y- - size of the cross in y

z- - size of the cross in z

lineapp - - appearance of the cross.

Returns:

lineAppearance

public static javax.media.j3d.Appearance lineAppearance(float LineWidth,
                                        boolean AntiAliasing,
                                        javax.vecmath.Color3f colour)

Specific function for setting the appearance of a line. Note if using this in conjuction with transparant shapes

Parameters:

LineWidth -

AntiAliasing -

colour -

Returns:

randomGreen

public static javax.vecmath.Color3f randomGreen()

randomBlue

public static javax.vecmath.Color3f randomBlue()

Creates a random colour of blue.

Returns:

a random shade of blue.

randomRed

public static javax.vecmath.Color3f randomRed()

Creates a random colour of blue.

Returns:

a random shade of blue.

linePolygon3D

public static javax.media.j3d.Shape3D linePolygon3D(java.util.ArrayList<javax.vecmath.Point3f> Data,
                                    javax.media.j3d.Appearance app)

Creates a joined series of lines specified by an array of 3D points.

Parameters:

Data= - an array of 3D points

Line - appearance

Returns:

pointArray3D

public static javax.media.j3d.Shape3D pointArray3D(java.util.ArrayList<javax.vecmath.Point3f> Data,
                                   javax.media.j3d.Appearance app)

Creates a series of points specified by an array of 3d points of appearance ap

Parameters:

Data. - An array of the points to create the shape3D.

app. - Appearance of the point array.

Returns:

PointAppearance

public static javax.media.j3d.Appearance PointAppearance(float size,
                                         javax.vecmath.Color3f colour)

Create an appearance for a pointArray. Use with pointArray3D.

Parameters:

size- - size of each point within point array.

colour-colour - of each point within point array.

Returns:

createAxis

public static javax.media.j3d.BranchGroup createAxis(float v1,
                                     float v2,
                                     float v3,
                                     float textSize,
                                     java.lang.String l1,
                                     java.lang.String l2,
                                     java.lang.String l3,
                                     javax.vecmath.Color3f col)

Creates a set of labelled axis showing each 3D dimension.

Parameters:

v1-x - axis size

v2-y - axis size

v3-z - axis size-often depth

l1- - x axis text

l2- - y axis text

l3- - z axis text

col-colour -

Returns:

branch group containing axis shapes

createStripGeomtry

public static javax.media.j3d.Geometry createStripGeomtry(java.util.ArrayList<javax.vecmath.Point3f[]> strips)

Creates the geometry for a shape defined by a series of circular strips. e.g. this function is used construct the geometry for hyperboloids.

Parameters:

strips -

Returns:

Geometry required to make a Shape3D

surfaceAppearance

public static javax.media.j3d.Appearance surfaceAppearance(javax.vecmath.Color3f colour,
                                           float alpha)

Simple appearance for surface. Fills the surface with a single semi transparant colour

Parameters:

colour- - colour of the surface

alpha- - tranparancy.

Returns:

surface appearance

getPamColour3D

public static javax.vecmath.Color3f getPamColour3D(int i)

Get a colour form a set colour array

Parameters:

i- - sepcifies which colour to get. If greater than the length of the array then takes remainder index.

Returns: