vona.j3d

Class FrustumWidget

java.lang.Object

vona.j3d.Widget

vona.j3d.FacetedWidget

vona.j3d.EdgedFacetedWidget

vona.j3d.JOGLEdgedFacetedWidget

vona.j3d.FrustumWidget

public class FrustumWidget
extends JOGLEdgedFacetedWidget

A rectangular frustum.

The face geometry has defined outward pointing unit normals. The edge geometry is composed of the near and far rectangular faces plus four axial lines along the frustum creases.

The horizontal and vertical subtended angles and near and far plane locations are mutable. The near face is centered on and perpendicular to the Z axis of the local coordinate frame, at positive depth near; the far face is also centered on and perpendicular to the Z axis and is at positive depth far >= near. The frustum may be further positioned e.g. by manipulating Widget.rx.

trackWidgetLength(float...) may be called to enable Widget.widgetLength tracking, which causes near and/or far to track Widget.widgetLength*trackNearFactor and Widget.widgetLength*trackFarFactor, respectively.

Face vertex array is six tri strips:

• two tri strip for near face, vertices ABCD ccw from (-nw/2, -wh/2, n) viewed from origin, strip vertices ABDC
• two tri strip for far face, vertices EFGH ccw from (-fw/2, -fh/2, f) viewed from origin, strip vertices EHFG
• four two tri strips for vertical faces, strip vertices AEBF, BFCG, CGDH, DHAE

 H     G
   D C
   A B
 E     F
 

Edge vertex array is 1+1+4 line strips:

• 4 line strip CCW around near face: ABCDA
• 4 line strip CCW around far face: EFGHE
• 4 one-line strips: AE, BF, CG, DH

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
protected float	angleX the current apex angles
protected float	angleY the current apex angles
private static java.lang.String	cvsid
static float	DEF_ANGLE_X default angles for no-arg constructor
static float	DEF_ANGLE_Y default angles for no-arg constructor
static float	DEF_FAR default depths for no-arg constructor
static float	DEF_NEAR default depths for no-arg constructor
protected float	far the current near and far plane depths
protected float	near the current near and far plane depths
protected float	trackFarFactor mapping from Widget.widgetLength to far, NaN if none
protected float	trackNearFactor mapping from Widget.widgetLength to near, NaN if none

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
FrustumWidget() Covers FrustumWidget(float, float, float, float), uses DEF_ANGLE_X, DEF_ANGLE_Y, DEF_NEAR, DEF_FAR.
FrustumWidget(float angleX, float angleY, float near, float far) Creates a new FrustumWidget with given dims.

Method Summary

Methods

Modifier and Type	Method and Description
void	enableAxialEdges(boolean enable) enable/disable the four axial edges
void	enableRadialEdges(boolean enable) enable/disable the endcap edges
boolean	setAngles(float angleX, float angleY) Covers setLengthsAndAngles(float, float, float, float), does not change near or far.
boolean	setAngleX(float angleX) covers setAngles(float, float), only sets horizontal angle
boolean	setAngleY(float angleY) covers setAngles(float, float), only sets vertical angle
boolean	setFar(float far) covers setLengths(float, float), only changes far
boolean	setLengths(float near, float far) Covers setLengthsAndAngles(float, float, float, float), does not change angleX or angleY.
boolean	setLengthsAndAngles(float angleX, float angleY, float near, float far) Set the frustum dimensions.
boolean	setNear(float near) covers setLengths(float, float), only changes near
void	trackWidgetLength(float... trackFactor) Set trackNearFactor, trackFarFactor, 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_ANGLE_X

public static final float DEF_ANGLE_X

default angles for no-arg constructor

See Also:

Constant Field Values

DEF_ANGLE_Y

public static final float DEF_ANGLE_Y

default angles for no-arg constructor

See Also:

Constant Field Values

DEF_NEAR

public static final float DEF_NEAR

default depths for no-arg constructor

See Also:

Constant Field Values

DEF_FAR

public static final float DEF_FAR

default depths for no-arg constructor

See Also:

Constant Field Values

angleX

protected float angleX

the current apex angles

angleY

protected float angleY

the current apex angles

near

protected float near

the current near and far plane depths

far

protected float far

the current near and far plane depths

trackNearFactor

protected float trackNearFactor

mapping from Widget.widgetLength to near, NaN if none

trackFarFactor

protected float trackFarFactor

mapping from Widget.widgetLength to far, NaN if none

Constructor Detail

FrustumWidget

public FrustumWidget(float angleX,
             float angleY,
             float near,
             float far)

Creates a new FrustumWidget with given dims.

Parameters:

angleX - the non-negative horizontal apex angle in radians

angleY - the non-negative vertical apex angle in radians

near - the non-negative near distance <= far

far - the non-negative far distance >= near

FrustumWidget

public FrustumWidget()

Covers FrustumWidget(float, float, float, float), uses DEF_ANGLE_X, DEF_ANGLE_Y, DEF_NEAR, DEF_FAR.

Method Detail

enableAxialEdges

public void enableAxialEdges(boolean enable)

enable/disable the four axial edges

enableRadialEdges

public void enableRadialEdges(boolean enable)

enable/disable the endcap edges

setLengthsAndAngles

public boolean setLengthsAndAngles(float angleX,
                          float angleY,
                          float near,
                          float far)

Set the frustum dimensions.

Parameters:

angleX - the new horizontal apex angle in radians, ignored if NaN, otherwise must be non-negative

angleY - the new vertical apex angle in radians, ignored if NaN, otherwise must be non-negative

near - the new near plane distance, ignored if NaN, otherwise must be non-negative and <= far

far - the new far plane distance, ignored if NaN, otherwise must be non-negative and >= near

Returns:

true if anything changed

setLengths

public boolean setLengths(float near,
                 float far)

Covers setLengthsAndAngles(float, float, float, float), does not change angleX or angleY.

setNear

public boolean setNear(float near)

covers setLengths(float, float), only changes near

setFar

public boolean setFar(float far)

covers setLengths(float, float), only changes far

setAngles

public boolean setAngles(float angleX,
                float angleY)

Covers setLengthsAndAngles(float, float, float, float), does not change near or far.

setAngleX

public boolean setAngleX(float angleX)

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

setAngleY

public boolean setAngleY(float angleY)

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

trackWidgetLength

public void trackWidgetLength(float... trackFactor)

Set trackNearFactor, trackFarFactor, 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