org.j3d.renderer.java3d.geom
Class Torus

java.lang.Object
  javax.media.j3d.SceneGraphObject
      javax.media.j3d.Node
          javax.media.j3d.Leaf
              javax.media.j3d.Shape3D
                  org.j3d.renderer.java3d.geom.Torus

public class Torus

extends javax.media.j3d.Shape3D

A simple torus that uses triangle strips.

The created torus does not have any capabilities set except for the ability to write the geometry - needed so that we can modify the geometry when you change the height or radius. If you know that you are not going to be changing the geometry you can turn this off.

As we assume you may want to use this as a collidable object, we store the GeometryData instance that is used to create the object in the userData of the underlying TriangleStripArray. The geometry does not have texture coordinates set.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

Fields inherited from class javax.media.j3d.Shape3D

ALLOW_APPEARANCE_OVERRIDE_READ, ALLOW_APPEARANCE_OVERRIDE_WRITE, ALLOW_APPEARANCE_READ, ALLOW_APPEARANCE_WRITE, ALLOW_COLLISION_BOUNDS_READ, ALLOW_COLLISION_BOUNDS_WRITE, ALLOW_GEOMETRY_READ, ALLOW_GEOMETRY_WRITE

Fields inherited from class javax.media.j3d.Node

ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING

Constructor Summary

Torus()
Construct a default torus with no appearance set.

Torus(javax.media.j3d.Appearance app)
Construct a default torus with the given appearance.

Torus(float innerRadius, float outerRadius)
Construct a default torus with no appearance set.

Torus(float innerRadius, float outerRadius, javax.media.j3d.Appearance app)
Construct a default torus with the given appearance.

Torus(float innerRadius, float outerRadius, int inner, int outer, javax.media.j3d.Appearance app)
Construct a torus with all the values customisable.

Torus(int inner, int outer)
Construct a default torus with no appearance set and a custom number of faces.

Torus(int inner, int outer, javax.media.j3d.Appearance app)
Construct a default torus with the given appearance and a custom number of faces.

Method Summary

void	setDimensions(float innerRadius, float outerRadius) Change the radius and height of the torus to the new values.
void	setFacetCount(int inner, int outer) Set the facet count of the torus to the new value.

Methods inherited from class javax.media.j3d.Shape3D

addGeometry, cloneNode, duplicateNode, getAllGeometries, getAppearance, getAppearanceOverrideEnable, getBounds, getCollisionBounds, getGeometry, getGeometry, indexOfGeometry, insertGeometry, intersect, intersect, intersect, numGeometries, removeAllGeometries, removeGeometry, removeGeometry, setAppearance, setAppearanceOverrideEnable, setCollisionBounds, setGeometry, setGeometry

Methods inherited from class javax.media.j3d.Node

cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, getBoundsAutoCompute, getCollidable, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable

Methods inherited from class javax.media.j3d.SceneGraphObject

clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setUserData, updateNodeReferences

Methods inherited from class java.lang.Object

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

Constructor Detail

Torus

public Torus()

Construct a default torus with no appearance set. The default size of the torus is:
Outer radius: 2.0
Inner radius: 1.0
Outer radius Faces: 16
Inner radius Faces: 16

Torus

public Torus(javax.media.j3d.Appearance app)

Construct a default torus with the given appearance. The default size of the torus is:
Outer radius: 2.0
Inner radius: 1.0
Outer radius Faces: 16
Inner radius Faces: 16

Parameters:

app - The appearance to use

Torus

public Torus(int inner,
             int outer)

Construct a default torus with no appearance set and a custom number of faces.
Outer radius: 2.0
Inner radius: 1.0

Parameters:

inner - The number of faces to use around the inner radius

outer - The number of faces to use around the outer radius

Torus

public Torus(float innerRadius,
             float outerRadius)

Construct a default torus with no appearance set. The height and radius as set to the new value and uses the default face count of:
Outer radius Faces: 16
Inner radius Faces: 16

Parameters:

innerRadius - The inner radius of the torus

outerRadius - The outer radius of the torus

Torus

public Torus(int inner,
             int outer,
             javax.media.j3d.Appearance app)

Construct a default torus with the given appearance and a custom number of faces.
Outer radius: 2.0
Inner radius: 1.0

Parameters:

inner - The number of faces to use around the inner radius

outer - The number of faces to use around the outer radius

app - The appearance to use

Torus

public Torus(float innerRadius,
             float outerRadius,
             javax.media.j3d.Appearance app)

Construct a default torus with the given appearance. The height and radius as set to the new value and uses the default face count of Outer radius Faces: 16
Inner radius Faces: 16

Parameters:

innerRadius - The inner radius of the torus

outerRadius - The outer radius of the torus

app - The appearance to use

Torus

public Torus(float innerRadius,
             float outerRadius,
             int inner,
             int outer,
             javax.media.j3d.Appearance app)

Construct a torus with all the values customisable.

Parameters:

innerRadius - The inner radius of the torus

outerRadius - The outer radius of the torus

inner - The number of faces to use around the inner radius

outer - The number of faces to use around the outer radius

app - The appearance to use

Method Detail

setDimensions

public void setDimensions(float innerRadius,
                          float outerRadius)

Change the radius and height of the torus to the new values. If the geometry write capability has been turned off, this will not do anything.

Parameters:

innerRadius - The inner radius of the torus

outerRadius - The outer radius of the torus

setFacetCount

public void setFacetCount(int inner,
                          int outer)

Set the facet count of the torus to the new value. If the geometry write capability has been turned off, this will not do anything.

Parameters:

inner - The number of faces to use around the inner radius

outer - The number of faces to use around the outer radius