Package gov.nasa.worldwind.render

Class Box

java.lang.Object

gov.nasa.worldwind.avlist.AVListImpl

gov.nasa.worldwind.WWObjectImpl

gov.nasa.worldwind.render.AbstractShape

gov.nasa.worldwind.render.RigidShape

gov.nasa.worldwind.render.Box

All Implemented Interfaces:

AVList, Draggable, MessageListener, Exportable, ExtentHolder, Movable, Movable2, Attributable, GeographicExtent, Highlightable, OrderedRenderable, PreRenderable, Renderable, Restorable, WWObject, java.beans.PropertyChangeListener, java.util.EventListener

public class Box
extends RigidShape

A general box volume defined by a center position and three axis radii.

Nested Class Summary

Nested classes/interfaces inherited from class gov.nasa.worldwind.render.RigidShape

RigidShape.Offsets, RigidShape.ShapeData

Nested classes/interfaces inherited from class gov.nasa.worldwind.render.AbstractShape

AbstractShape.AbstractShapeData

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	DEFAULT_SUBDIVISIONS
protected int	faceCount
protected int	subdivisions

Fields inherited from class gov.nasa.worldwind.render.RigidShape

centerPosition, DEFAULT_GEOMETRY_CACHE_SIZE, detailHint, eastWestRadius, GEOMETRY_CACHE_KEY, GEOMETRY_CACHE_NAME, geometryBuilder, heading, imageSources, northSouthRadius, offsets, offsetTextureCoords, previousIntersectionGlobeStateKey, previousIntersectionShapeData, previousIntersectionTerrain, renderExtent, roll, skewEastWest, skewNorthSouth, textures, tilt, verticalRadius

Fields inherited from class gov.nasa.worldwind.render.AbstractShape

activeAttributes, altitudeMode, BEogsh, currentData, DEFAULT_ALTITUDE_MODE, DEFAULT_GEOMETRY_GENERATION_INTERVAL, DEFAULT_HIGHLIGHT_MATERIAL, DEFAULT_INTERIOR_MATERIAL, DEFAULT_OUTLINE_MATERIAL, DEFAULT_OUTLINE_PICK_WIDTH, defaultAttributes, delegateOwner, dragEnabled, draggableSupport, enableBatchPicking, enableBatchRendering, enableDepthOffset, highlightAttrs, highlighted, maxExpiryTime, minExpiryTime, normalAttrs, outlinePickWidth, outlineShapeRenderer, pickLayer, pickSupport, referencePosition, sector, shapeDataCache, surfaceShape, VBO_THRESHOLD, viewDistanceExpiration, visible

Fields inherited from interface gov.nasa.worldwind.Exportable

FORMAT_NOT_SUPPORTED, FORMAT_PARTIALLY_SUPPORTED, FORMAT_SUPPORTED

Constructor Summary

Constructors

Constructor	Description
Box()	Construct a box with default parameters
Box(Position centerPosition, double northSouthRadius, double verticalRadius, double eastWestRadius)	Construct a box from a specified center position and axes lengths.
Box(Position centerPosition, double northSouthRadius, double verticalRadius, double eastWestRadius, Angle heading, Angle tilt, Angle roll)	Construct a Box from a specified center position, axes lengths and rotation angles.

Method Summary

Modifier and Type	Method	Description
protected void	computeSubdivisions(DrawContext dc, RigidShape.ShapeData shapeData)	Computes the number of subdivisions necessary to achieve the expected Level of Detail given the shape's relationship to the viewer.
protected RigidShape.ShapeData	createIntersectionGeometry(Terrain terrain)
protected void	doExportAsKML(javax.xml.stream.XMLStreamWriter xmlWriter)	Exports shape-specific fields.
protected void	drawGeometry(DrawContext dc, int mode, int count, int type, java.nio.Buffer elementBuffer, RigidShape.ShapeData shapeData, int face)	Renders the Box, using data from the provided buffer and the given parameters.
int	getFaceCount()	Returns the number of separate faces that comprise this shape.
int	getSubdivisions()
java.lang.String	isExportFormatSupported(java.lang.String mimeType)	No export formats supported.
protected void	makeGeometry(RigidShape.ShapeData shapeData)	Sets the Geometry mesh for this Box, either by pulling it from the geometryCache, or by creating it anew if the appropriate geometry does not yet exist in the cache.
protected void	makeUnitBox(int subdivisions, java.util.List<Geometry> meshes)	Generates a unit box geometry, including the vertices, indices, normals and texture coordinates, tessellated with the specified number of divisions.

Methods inherited from class gov.nasa.worldwind.render.RigidShape

beginDrawing, clearCachedVbos, clearIntersectionGeometry, computeExtent, computeReferencePoint, computeReferencePoint, computeRenderMatrix, computeRenderMatrix, computeRenderMatrixInverse, computeTransformedVertices, createCacheEntry, doDrawInterior, doDrawOutline, doGetRestorableState, doMakeOrderedRenderable, doRestoreState, drawGeometry, fillVBO, getCenterPosition, getCurrentShapeData, getDetailHint, getEastWestRadius, getExtent, getGeometryBuilder, getGeometryCache, getHeading, getImageSource, getNorthSouthRadius, getOffsets, getReferencePosition, getRestorableState, getRoll, getSector, getSkewEastWest, getSkewNorthSouth, getTexture, getTilt, getVboIds, getVerticalRadius, initialize, intersect, intersect, intersect, intersectFace, isOrderedRenderableValid, isSameAsPreviousTerrain, moveTo, mustApplyTexture, mustApplyTexture, mustRegenerateGeometry, reset, restoreState, setCenterPosition, setDetailHint, setEastWestRadius, setFaceCount, setHeading, setImageSource, setImageSources, setImageSources, setModelViewMatrix, setNorthSouthRadius, setOffset, setRoll, setSkewEastWest, setSkewNorthSouth, setTexture, setTilt, setUpGeometryCache, setVerticalRadius

Methods inherited from class gov.nasa.worldwind.render.AbstractShape

addOrderedRenderable, checkViewDistanceExpiration, computeExtentFromPositions, computePoint, computePoint, countTriangleVertices, createPickedObject, createSurfaceShape, determineActiveAttributes, doDrag, doDrawOrderedRenderable, drag, drawBatched, drawInterior, drawOrderedRenderable, drawOutline, endDrawing, export, exportAsKML, getActiveAttributes, getAltitudeMode, getAttributes, getCurrentData, getDelegateOwner, getDistanceFromEye, getExtent, getGeometryRegenerationInterval, getHighlightAttributes, getOutlinePickWidth, getReferencePoint, getVboIds, intersectsFrustum, isDragEnabled, isEnableBatchPicking, isEnableBatchRendering, isEnableDepthOffset, isHighlighted, isTerrainDependent, isViewDistanceExpiration, isVisible, makeOrderedRenderable, makeTexture, move, moveTo, mustApplyLighting, mustApplyLighting, mustCreateNormals, mustCreateNormals, mustDrawInterior, mustDrawOutline, pick, prepareToDrawInterior, prepareToDrawOutline, preRender, render, setAltitudeMode, setAttributes, setDelegateOwner, setDragEnabled, setEnableBatchPicking, setEnableBatchRendering, setEnableDepthOffset, setGeometryRegenerationInterval, setHighlightAttributes, setHighlighted, setOutlinePickWidth, setReferencePosition, setViewDistanceExpiration, setVisible, shouldUseVBOs, updateSurfaceShape

Methods inherited from class gov.nasa.worldwind.WWObjectImpl

onMessage, propertyChange

Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getBooleanValue, getBooleanValue, getChangeSupport, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getRestorableStateForAVPair, getStringValue, getStringValue, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nasa.worldwind.avlist.AVList

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues

Field Detail

DEFAULT_SUBDIVISIONS

protected static final int DEFAULT_SUBDIVISIONS

See Also:

Constant Field Values

faceCount

protected int faceCount

subdivisions

protected int subdivisions

Constructor Detail

Box

public Box()

Construct a box with default parameters

Box

public Box(Position centerPosition,
           double northSouthRadius,
           double verticalRadius,
           double eastWestRadius)

Construct a box from a specified center position and axes lengths.

Parameters:

centerPosition - the box's center position.

northSouthRadius - the box's north-south radius, in meters.

verticalRadius - the box's vertical radius, in meters.

eastWestRadius - the box's east-west radius, in meters.

Throws:

java.lang.IllegalArgumentException - if the center position is null or any of the radii are not greater than 0.

Box

public Box(Position centerPosition,
           double northSouthRadius,
           double verticalRadius,
           double eastWestRadius,
           Angle heading,
           Angle tilt,
           Angle roll)

Construct a Box from a specified center position, axes lengths and rotation angles. All angles are specified in degrees and positive angles are counter-clockwise.

Parameters:

centerPosition - the Box's center position.

northSouthRadius - the Box's north-south radius, in meters.

verticalRadius - the Box's vertical radius, in meters.

eastWestRadius - the Box's east-west radius, in meters.

heading - the Box's azimuth, its rotation about its vertical axis.

tilt - the Box pitch, its rotation about its east-west axis.

roll - the Box's roll, its rotation about its north-south axis.

Method Detail

getFaceCount

public int getFaceCount()

Description copied from class: RigidShape

Returns the number of separate faces that comprise this shape.

Overrides:

getFaceCount in class RigidShape

Returns:

number of faces

getSubdivisions

public int getSubdivisions()

Specified by:

getSubdivisions in class RigidShape

computeSubdivisions

protected void computeSubdivisions(DrawContext dc,
                                   RigidShape.ShapeData shapeData)

Computes the number of subdivisions necessary to achieve the expected Level of Detail given the shape's relationship to the viewer.

Specified by:

computeSubdivisions in class RigidShape

Parameters:

dc - the current drawContext.

shapeData - the current globe-specific shape data

makeGeometry

protected void makeGeometry(RigidShape.ShapeData shapeData)

Sets the Geometry mesh for this Box, either by pulling it from the geometryCache, or by creating it anew if the appropriate geometry does not yet exist in the cache.

Specified by:

makeGeometry in class RigidShape

Parameters:

shapeData - this shape's current shape data.

makeUnitBox

protected void makeUnitBox(int subdivisions,
                           java.util.List<Geometry> meshes)

Generates a unit box geometry, including the vertices, indices, normals and texture coordinates, tessellated with the specified number of divisions.

Parameters:

subdivisions - the number of times to subdivide the unit box geometry

meshes - the Geometry list to hold the computed points, etc. for all Geometries

drawGeometry

protected void drawGeometry(DrawContext dc,
                            int mode,
                            int count,
                            int type,
                            java.nio.Buffer elementBuffer,
                            RigidShape.ShapeData shapeData,
                            int face)

Renders the Box, using data from the provided buffer and the given parameters.

Specified by:

drawGeometry in class RigidShape

Parameters:

dc - the current draw context

mode - the render mode

count - the number of elements to be drawn

type - the data type of the elements to be drawn

elementBuffer - the buffer containing the list of elements to be drawn

shapeData - this shape's current globe-specific shape data

face - the index of the shape face to render

createIntersectionGeometry

protected RigidShape.ShapeData createIntersectionGeometry(Terrain terrain)

Specified by:

createIntersectionGeometry in class RigidShape

isExportFormatSupported

public java.lang.String isExportFormatSupported(java.lang.String mimeType)

No export formats supported.

Specified by:

isExportFormatSupported in interface Exportable

Overrides:

isExportFormatSupported in class AbstractShape

Parameters:

mimeType - Desired export format.

Returns:

One of Exportable.FORMAT_SUPPORTED, Exportable.FORMAT_NOT_SUPPORTED, or Exportable.FORMAT_PARTIALLY_SUPPORTED.

See Also:

Exportable.export(String, Object)

doExportAsKML

protected void doExportAsKML(javax.xml.stream.XMLStreamWriter xmlWriter)
                      throws java.io.IOException,
                             javax.xml.stream.XMLStreamException

Description copied from class: AbstractShape

Exports shape-specific fields.

Specified by:

doExportAsKML in class AbstractShape

Parameters:

xmlWriter - the export writer to write to.

Throws:

java.io.IOException - if an IO error occurs while writing to the output destination.

javax.xml.stream.XMLStreamException - if an exception occurs converting this shape's fields to XML.