vona.j3d

Class AnnulusWidget

java.lang.Object

vona.j3d.Widget

vona.j3d.FacetedWidget

vona.j3d.EdgedFacetedWidget

vona.j3d.JOGLEdgedFacetedWidget

vona.j3d.AnnulusWidget

public class AnnulusWidget
extends JOGLEdgedFacetedWidget

A circular annulus.

The face geometry is tessellated into radial wedges, with defined normals. The edge geometry is composed of the two perimeter circles.

The radius and radial width are mutable, and the annulus is centered at the origin of the local coordinate frame, with outward normal along the positive Z axis. It may be further positioned e.g. by manipulating Widget.rx.

trackWidgetLength(float...) may be called to enable Widget.widgetLength tracking, which causes the inner radius and/or the radial width to track Widget.widgetLength*trackInnerRadiusFactor corresp. Widget.widgetLength*trackWidthFactor.

Face vertex array is one tri strip in ccw order from (ir, 0, 0).

Edge vertex array is two line strips in ccw order from (ir, 0, 0) and (ir+w, 0, 0).

Copyright (C) 2008 Marsette A. Vona, III

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Author:

Marsette (Marty) A. Vona, III

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	cvsid
static int	DEF_NUM_SECTORS default ns
protected float	innerRadius current inner radius
int	ns number of azimuth and elevation sectors
float	sectorAngle angle span of each sector
protected float	trackInnerRadiusFactor mapping from Widget.widgetLength to radius, NaN if none
protected float	trackWidthFactor mapping from Widget.widgetLength to radial width, NaN if none
protected float	width current radial width

Fields inherited from class vona.j3d.JOGLEdgedFacetedWidget

edgeGeometry, edgeVertices, faceGeometry, faceVertices, X, Y, Z

Fields inherited from class vona.j3d.EdgedFacetedWidget

DASHED_PATTERN, DEF_EDGE_COLOR, DEF_OFFSET_BIAS, DEF_OFFSET_FACTOR, DOTTED_PATTERN, edgeAppearance, edgeColoringAttributes, edgeLineAttributes, EDGES, edgeTransparencyAttributes, facePolygonAttributes, SOLID_PATTERN

Fields inherited from class vona.j3d.FacetedWidget

faceAppearance, faceMaterial, FACES, faceTransparencyAttributes

Fields inherited from class vona.j3d.Widget

alpha, appearance, autoSetBoundingSpheres, boundingSphereCenter, boundingSphereCenterInView, boundingSphereRadius, boundingSphereRadiusInView, dbgEnabled, dbgNormalsGeometry, dbgNormalsVertices, dbgSpheresGeometry, dbgSpheresVertices, DEF_DBG_NORMAL_LENGTH, DEF_WIDGET_LENGTH, enabled, geometry, numGeometries, primitiveIterator, propertyMap, rx, vertexAccessor, widgetLength

Constructor Summary

Constructors

Constructor and Description
AnnulusWidget() Covers AnnulusWidget(float, float, int), uses DEF_NUM_SECTORS, innerRadius = 0.25f and width = 0.25f.
AnnulusWidget(float innerRadius, float width) Covers AnnulusWidget(float, float, int), uses DEF_NUM_SECTORS.
AnnulusWidget(float innerRadius, float width, int numSectors) Creates a new AnnulusWidget with given radius, radial width, and ns.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	setInnerRadius(float innerRadius) covers setLengths(float, float), only changes inner radius
boolean	setLengths(float innerRadius, float width) Set the inner radius and radial width.
boolean	setWidth(float width) covers setLengths(float, float), only changes radial width
void	trackWidgetLength(float... trackFactor) Set trackInnerRadiusFactor and trackWidthFactor, see class header doc.
protected void	widgetLengthChanged() implements Widget.widgetLength tracking, see class header doc

Methods inherited from class vona.j3d.JOGLEdgedFacetedWidget

gevc, gfnc, gfvc, sev, sevc, sfn, sfnc, sfv, sfvc

Methods inherited from class vona.j3d.EdgedFacetedWidget

enableEdges, getEdgeAppearance, getEdgeGeometry, setAlpha, setColor, setColor, setEdgeAlpha, setEdgeColor, setEdgeColor, setEdgePattern, setEdgePattern, setEdgeWidth, setFaceOffset, setFaceOffsetBias, setFaceOffsetFactor

Methods inherited from class vona.j3d.FacetedWidget

enableFaces, getFaceAppearance, getFaceGeometry, setFaceAlpha, setFaceColor, setFaceColor

Methods inherited from class vona.j3d.Widget

cons, countGeometryArrays, disableBoundingSphere, disableBoundingSpheres, dump, dump, enableDBGGeometry, enableGeometry, ensureBoundingSpheresInView, getAppearance, getBoundingSphereCenter, getBoundingSphereRadius, getGeometry, getProperty, getWidget, getWidgetAlpha, hasBoundingSphere, hasBoundingSphereInView, hasProperty, indexOf, populateFrom, recomputeBoundingSphere, recomputeBoundingSpheres, removeDBGNormals, removeDBGSpheres, removeGeometry, removeGeometry, removeProperty, replaceAppearanceWithClone, replaceGeometryWithClone, scaleWidget, setAppearance, setBoundingSphereCenter, setBoundingSphereRadius, setGeometry, setGeometryAlpha, setGeometryAlpha, setGeometryAndAppearance, setProperty, setProperty, setWidgetAlpha, setWidgetLength, updateAllDBGNormals, updateAllDBGNormals, updateAllDBGSpheres, updateDBGNormals, updateDBGNormals, updateDBGSpheres, updateExistingDBGNormals, updateExistingDBGSpheres

Methods inherited from class java.lang.Object

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

Field Detail

cvsid

private static final java.lang.String cvsid

See Also:

Constant Field Values

DEF_NUM_SECTORS

public static final int DEF_NUM_SECTORS

default ns

See Also:

Constant Field Values

ns

public final int ns

number of azimuth and elevation sectors

sectorAngle

public final float sectorAngle

angle span of each sector

innerRadius

protected float innerRadius

current inner radius

width

protected float width

current radial width

trackInnerRadiusFactor

protected float trackInnerRadiusFactor

mapping from Widget.widgetLength to radius, NaN if none

trackWidthFactor

protected float trackWidthFactor

mapping from Widget.widgetLength to radial width, NaN if none

Constructor Detail

AnnulusWidget

public AnnulusWidget(float innerRadius,
             float width,
             int numSectors)

Creates a new AnnulusWidget with given radius, radial width, and ns.

Parameters:

innerRadius - the non-negative inner radius

width - the non-negative radial width

numSectors - the number of sectors, must be positive

AnnulusWidget

public AnnulusWidget(float innerRadius,
             float width)

Covers AnnulusWidget(float, float, int), uses DEF_NUM_SECTORS.

AnnulusWidget

public AnnulusWidget()

Covers AnnulusWidget(float, float, int), uses DEF_NUM_SECTORS, innerRadius = 0.25f and width = 0.25f.

Method Detail

setLengths

public boolean setLengths(float innerRadius,
                 float width)

Set the inner radius and radial width.

Parameters:

innerRadius - the new inner radius, ignored if NaN, otherwise must be non-negative

width - the new radial width, ignored if NaN, otherwise must be non-negative

Returns:

true if anything changed

setInnerRadius

public boolean setInnerRadius(float innerRadius)

covers setLengths(float, float), only changes inner radius

setWidth

public boolean setWidth(float width)

covers setLengths(float, float), only changes radial width

trackWidgetLength

public void trackWidgetLength(float... trackFactor)

Set trackInnerRadiusFactor and trackWidthFactor, see class header doc.

Overrides:

trackWidgetLength in class Widget

widgetLengthChanged

protected void widgetLengthChanged()

implements Widget.widgetLength tracking, see class header doc

Overrides:

widgetLengthChanged in class Widget