vona.j3d

Class PyramidWidget

java.lang.Object

vona.j3d.Widget

vona.j3d.FacetedWidget

vona.j3d.EdgedFacetedWidget

vona.j3d.JOGLEdgedFacetedWidget

vona.j3d.PyramidWidget

public class PyramidWidget
extends JOGLEdgedFacetedWidget

A rectangular pyramid.

The face geometry has defined normals. The edge geometry is composed of the base rectangle plus four axial lines along the pyramid creases.

The base dimensions and pyramid depth are mutable. The pyramid base is centered at the origin of the local coordinate frame, with apex extending in the positive Z direction. The pyramid may be further positioned e.g. by manipulating Widget.rx.

trackWidgetLength(float...) may be called to enable Widget.widgetLength tracking, which causes the base width, height, and/or the pyramid depth to track Widget.widgetLength*trackWidthFactor, Widget.widgetLength*trackHeightFactor, or Widget.widgetLength*trackDepthFactor, respectively.

Face vertex array is five tri strips:

• two tri strip for base, vertices ABCD ccw from (-w/2, -h/2, 0) viewed from above apex, strip vertices ADBC
• one-tri strip for each vertical, apex vertex E: EDA, EAB, EBC, ECD

 D   C
   E
 A   B
 

Edge vertex array is 5 line strips:

• 4 line strip CCW around base: ABCDA
• 4 one-line strips: EA, EB, EC, ED

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
protected float	depth the current pyramid depth
protected float	height the current base dims
protected float	trackDepthFactor mapping from Widget.widgetLength to pyramid depth, NaN if none
protected float	trackHeightFactor mapping from Widget.widgetLength to base height, NaN if none
protected float	trackWidthFactor mapping from Widget.widgetLength to base width, NaN if none
protected float	width the current base dims

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
PyramidWidget() Covers PyramidWidget(float, float, float), uses width = height= 1.0f, depth = 0.5f.
PyramidWidget(float width, float height, float depth) Creates a new PyramidWidget with given dims.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	setAngles(float x, float y) Covers setLengthsAndAngles(float, float, float), does not change pyramid depth.
boolean	setAngleX(float x) covers setAngles(float, float), only sets horizontal angle
boolean	setAngleY(float y) covers setAngles(float, float), only sets vertical angle
boolean	setDepth(float depth) covers setLengths(float, float, float), only changes pyramid depth
boolean	setHeight(float height) covers setLengths(float, float, float), only changes base height
boolean	setLengths(float width, float height, float depth) Set the pyramid dimensions.
boolean	setLengthsAndAngles(float x, float y, float depth) Like setLengths(float, float, float) but sets base dimensions from given apex angles.
boolean	setWidth(float width) covers setLengths(float, float, float), only changes base width
void	trackWidgetLength(float... trackFactor) Set trackWidthFactor, trackHeightFactor, and trackDepthFactor, 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

width

protected float width

the current base dims

height

protected float height

the current base dims

depth

protected float depth

the current pyramid depth

trackWidthFactor

protected float trackWidthFactor

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

trackHeightFactor

protected float trackHeightFactor

mapping from Widget.widgetLength to base height, NaN if none

trackDepthFactor

protected float trackDepthFactor

mapping from Widget.widgetLength to pyramid depth, NaN if none

Constructor Detail

PyramidWidget

public PyramidWidget(float width,
             float height,
             float depth)

Creates a new PyramidWidget with given dims.

Parameters:

width - the non-negative base width

height - the non-negative base height

depth - the non-negative pyramid depth

PyramidWidget

public PyramidWidget()

Covers PyramidWidget(float, float, float), uses width = height= 1.0f, depth = 0.5f.

Method Detail

setLengths

public boolean setLengths(float width,
                 float height,
                 float depth)

Set the pyramid dimensions.

Parameters:

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

height - the new base height, ignored if NaN, otherwise must be non-negative

depth - the new pyramid depth, ignored if NaN, otherwise must be non-negative

Returns:

true if anything changed

setWidth

public boolean setWidth(float width)

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

setHeight

public boolean setHeight(float height)

covers setLengths(float, float, float), only changes base height

setDepth

public boolean setDepth(float depth)

covers setLengths(float, float, float), only changes pyramid depth

setLengthsAndAngles

public boolean setLengthsAndAngles(float x,
                          float y,
                          float depth)

Like setLengths(float, float, float) but sets base dimensions from given apex angles.

Parameters:

x - horzontal apex angle in radians, or NaN to leave width unchanged

y - vertical apex angle in radians, or NaN to leave height unchanged

setAngles

public boolean setAngles(float x,
                float y)

Covers setLengthsAndAngles(float, float, float), does not change pyramid depth.

setAngleX

public boolean setAngleX(float x)

covers setAngles(float, float), only sets horizontal angle

setAngleY

public boolean setAngleY(float y)

covers setAngles(float, float), only sets vertical angle

trackWidgetLength

public void trackWidgetLength(float... trackFactor)

Set trackWidthFactor, trackHeightFactor, and trackDepthFactor, 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