All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class vlc.vrml.generic.geometry.ElevationGrid 

java.lang.Object
   |
   +----vlc.vrml.generic.geometry.VrmlObject
           |
           +----vlc.vrml.generic.geometry.Geometry
                   |
                   +----vlc.vrml.generic.geometry.ElevationGrid
public class ElevationGrid
extends Geometry
JVerge

Version:
0.8 (beta 4) Copyright 1997 The Virtual Light Company under the GNU LGPL

The latest information and bugs in JVerge can be found at http://www.vlc.com.au/JVerge

For definition of the Anchor node please see the VRML 97 Anchor specification

Author:
Justin Couch justin@vlc.com.au

Constructor Index

o ElevationGrid()
Default Constructor.
o ElevationGrid(float[], boolean, boolean, float, boolean, boolean, int, float, int, float)
Constructor to use when you want to supply non-default values for color and coordinate indexes and per vertex coloring.

Method Index

o cleanup()
Call when about to remove the node from the scenegraph.
o clone()
Make a clone of this object
o get_ccw()
Get the value of the ccw field.
o get_color()
Get the currently set Color node
o get_colorPerVertex()
Are colors being applied per vertex or per face?.
o get_creaseAngle()
Get the value of the creaseAngle field.
o get_height()
Get the height coordinates currently used.
o get_normal()
Get the currently set Normal node
o get_normalPerVertex()
Are normals being applied per vertex or per face?.
o get_solid()
Get the value of the solid field.
o get_texCoord()
Get the currently set TextureCoordinate node
o get_xDimension()
Get the length in the local x axis of the grid.
o get_xSpacing()
Get the spacing in the local x axis of the grid.
o get_zDimension()
Get the width in the local x axis of the grid.
o get_zSpacing()
Get the spacing in the local z axis of the grid.
o set_color(Color)
Set the color node to be associated with this node
o set_height(float[])
Set the height coordinates of to be used.
o set_normal(Normal)
Set the Normal node to be associated with this node
o set_texCoord(TextureCoordinate)
Set the TextureCoordinate node to be associated with this node
o writeToStream(int)
Prints the formatted contents of this node to the given stream.

Constructors

o ElevationGrid 
 public ElevationGrid()
Default Constructor. Creates a default IndexedLineSet

o ElevationGrid 
 public ElevationGrid(float height[],
                      boolean ccw,
                      boolean colorPerVertex,
                      float creaseAngle,
                      boolean normalPerVertex,
                      boolean solid,
                      int xDimension,
                      float xSpacing,
                      int zDimension,
                      float zSpacing)
Constructor to use when you want to supply non-default values for color and coordinate indexes and per vertex coloring.

Parameters:
height - The array of height values
ccw - True for Counter Clockwise ordering of the vertexes.
colorPerVertex - True will turn on colors being assigned per vertex rather than per face.
creaseAngle - The angle in radians below which smooth shading is used
normalPerVertex - True will turn on assinging a normal per vertex rather than per face.
solid - True if this is a solid object
xDimension - The number of values along the x side
xSpacing - The distance between values in the x axis
zDimension - The number of values along the z side
zSpacing - The distance between values in the z axis

Methods

o cleanup 
 public void cleanup()
Call when about to remove the node from the scenegraph.

Overrides:
cleanup in class VrmlObject
o writeToStream 
 public void writeToStream(int indent)
Prints the formatted contents of this node to the given stream.

Parameters:
indent - The number of spaces to indent this node in the string
Overrides:
writeToStream in class VrmlObject
o set_color 
 public void set_color(Color color)
Set the color node to be associated with this node

Parameters:
color - A valid JVerge color node or null to remove the current.
o get_color 
 public Color get_color()
Get the currently set Color node

Returns:
The current color node or null if not set.
o set_texCoord 
 public void set_texCoord(TextureCoordinate tex)
Set the TextureCoordinate node to be associated with this node

Parameters:
color - A valid JVerge TextureCoordinate node or null to remove the current.
o get_texCoord 
 public TextureCoordinate get_texCoord()
Get the currently set TextureCoordinate node

Returns:
The current TextureCoordinate node or null if not set.
o set_normal 
 public void set_normal(Normal normal)
Set the Normal node to be associated with this node

Parameters:
color - A valid JVerge Normal node or null to remove the current.
o get_normal 
 public Normal get_normal()
Get the currently set Normal node

Returns:
The current normal node or null if not set.
o get_ccw 
 public boolean get_ccw()
Get the value of the ccw field.

Returns:
true if counter clockwise ordering is true. False if not
o get_colorPerVertex 
 public boolean get_colorPerVertex()
Are colors being applied per vertex or per face?.

Returns:
true if prevertex colors are is true. False if not
o get_creaseAngle 
 public float get_creaseAngle()
Get the value of the creaseAngle field.

Returns:
The angle in radians that shoiuld be the max for smooth shading.
o get_normalPerVertex 
 public boolean get_normalPerVertex()
Are normals being applied per vertex or per face?.

Returns:
true if prevertex normals are is true. False if not
o get_solid 
 public boolean get_solid()
Get the value of the solid field. This is how the object knows to do backface culling of solid obejcts

Returns:
true if the object is regarded as solid. False if not
o set_height 
 public void set_height(float vals[])
Set the height coordinates of to be used.

Parameters:
vals - An array of height values in the order specified by the ElevationGrid node.
o get_height 
 public float[] get_height()
Get the height coordinates currently used.

Returns:
An array of height values in the order specified by the ElevationGrid node.
o get_xDimension 
 public int get_xDimension()
Get the length in the local x axis of the grid.

Returns:
The length used.
o get_xSpacing 
 public float get_xSpacing()
Get the spacing in the local x axis of the grid.

Returns:
The spacing used.
o get_zDimension 
 public int get_zDimension()
Get the width in the local x axis of the grid.

Returns:
The width used.
o get_zSpacing 
 public float get_zSpacing()
Get the spacing in the local z axis of the grid.

Returns:
The spacing used.
o clone 
 public Object clone()
Make a clone of this object

Returns:
A deep clone copy of this object
Overrides:
clone in class VrmlObject 
All Packages  Class Hierarchy  This Package  Previous  Next  Index