Appendix G:
Java API Summary
General
Exceptions
Class Hierarchy
vrml Package
vrml.field Package
vrml.node Package
Appendix G:
Java API Summary
General
Exceptions
Class Hierarchy
vrml Package
vrml.field Package
vrml.node Package
Appendix G:
Java API Summary
General
Exceptions
Class Hierarchy
vrml Package
vrml.field Package
vrml.node Package
Appendix G:
Java API Summary
General
Exceptions
Class Hierarchy
vrml Package
vrml.field Package
vrml.node Package
Appendix G:
Java API Summary
General
Exceptions
Class Hierarchy
vrml Package
vrml.field Package
vrml.node Package
Appendix G:
Java API Summary
General
Exceptions
Class Hierarchy
vrml Package
vrml.field Package
vrml.node Package
Appendix G:
Java API Summary
General
Exceptions
Class Hierarchy
vrml Package
vrml.field Package
vrml.node Package
|
Appendix G
Summary of Java API
General Methods
public void processEvents(int count, Event events[]);
public void processEvent(Event event);
public void eventsProcessed();
public void shutdown();
public void initialize();
ArrayIndexOutOfBoundsException
InvalidFieldException
InvalidEventInException
InvalidEventOutException
InvalidExposedFieldException
InvalidVRMLSyntaxException
InvalidRouteException
InvalidFieldChangeException
IllegalArgumentException
java.lang.Object
|
+- vrml.Event
+- vrml.Browser
+- vrml.Field
| +- vrml.field.SFBool
| +- vrml.field.SFColor
| +- vrml.field.SFFloat
| +- vrml.field.SFImage
| +- vrml.field.SFInt32
| +- vrml.field.SFNode
| +- vrml.field.SFRotation
| +- vrml.field.SFString
| +- vrml.field.SFTime
| +- vrml.field.SFVec2f
| +- vrml.field.SFVec3f
| |
| +- vrml.MField
| | +- vrml.field.MFColor
| | +- vrml.field.MFFloat
| | +- vrml.field.MFInt32
| | +- vrml.field.MFNode
| | +- vrml.field.MFRotation
| | +- vrml.field.MFString
| | +- vrml.field.MFTime
| | +- vrml.field.MFVec2f
| | +- vrml.field.MFVec3f
| |
| +- vrml.ConstField
| +- vrml.field.ConstSFBool
| +- vrml.field.ConstSFColor
| +- vrml.field.ConstSFFloat
| +- vrml.field.ConstSFImage
| +- vrml.field.ConstSFInt32
| +- vrml.field.ConstSFNode
| +- vrml.field.ConstSFRotation
| +- vrml.field.ConstSFString
| +- vrml.field.ConstSFTime
| +- vrml.field.ConstSFVec2f
| +- vrml.field.ConstSFVec3f
| |
| +- vrml.ConstMField
| +- vrml.field.ConstMFColor
| +- vrml.field.ConstMFFloat
| +- vrml.field.ConstMFInt32
| +- vrml.field.ConstMFNode
| +- vrml.field.ConstMFRotation
| +- vrml.field.ConstMFString
| +- vrml.field.ConstMFTime
| +- vrml.field.ConstMFVec2f
| +- vrml.field.ConstMFVec3f
|
+- vrml.BaseNode
+- vrml.node.Node
+- vrml.node.Script
java.lang.Exception
|
+- java.lang.RuntimeException
| +- java.lang.IllegalArgumentException
| +- vrml.InvalidEventInException
| +- vrml.InvalidEventOutException
| +- vrml.InvalidExposedFieldException
| +- vrml.InvalidFieldChangeException
| +- vrml.InvalidFieldException
| +- vrml.InvalidRouteException
|
+- vrml.InvalidVRMLSyntaxException
package vrml;
public class Event implements Cloneable
{
public String getName();
public double getTimeStamp();
public ConstField getValue();
public Object clone();
public String toString(); // This overrides a method in Object
}
public class Browser
{
private Browser();
public String toString(); // This overrides a method in Object
// Browser interface
public String getName();
public String getVersion();
public float getCurrentSpeed();
public float getCurrentFrameRate();
public String getWorldURL();
public void replaceWorld(BaseNode[] nodes);
public BaseNode[] createVrmlFromString(String vrmlSyntax)
throws InvalidVRMLSyntaxException;
public void createVrmlFromURL(String[] url,
BaseNode node, String event)
throws InvalidVRMLSyntaxException;
public void addRoute(BaseNode fromNode, String fromEventOut,
BaseNode toNode, String toEventIn);
public void deleteRoute(BaseNode fromNode, String fromEventOut,
BaseNode toNode, String toEventIn);
public void loadURL(String[] url, String[] parameter)
throws InvalidVRMLSyntaxException;
public void setDescription(String description);
}
public abstract class Field implements Cloneable
{
public Object clone();
}
public abstract class MField extends Field
{
public abstract int getSize();
public abstract void clear();
public abstract void delete(int index);
}
public abstract class ConstField extends Field
{
}
public abstract class ConstMField extends ConstField
{
public abstract int getSize();
}
//
// This is the general BaseNode class
//
public abstract class BaseNode
{
// Returns the type of the node. If the node is a prototype
// it returns the name of the prototype.
public String getType();
// Get the Browser that this node is contained in.
public Browser getBrowser();
}
package vrml.field;
public class SFBool extends Field
{
public SFBool();
public SFBool(boolean value);
public boolean getValue();
public void setValue(boolean b);
public void setValue(ConstSFBool b);
public void setValue(SFBool b);
public String toString(); // This overrides a method in Object
}
public class SFColor extends Field
{
public SFColor();
public SFColor(float red, float green, float blue);
public void getValue(float colors[]);
public float getRed();
public float getGreen();
public float getBlue();
public void setValue(float colors[]);
public void setValue(float red, float green, float blue);
public void setValue(ConstSFColor color);
public void setValue(SFColor color);
public String toString(); // This overrides a method in Object
}
public class SFFloat extends Field
{
public SFFloat();
public SFFloat(float f);
public float getValue();
public void setValue(float f);
public void setValue(ConstSFFloat f);
public void setValue(SFFloat f);
public String toString(); // This overrides a method in Object
}
public class SFImage extends Field
{
public SFImage();
public SFImage(int width, int height,
int components, byte pixels[]);
public int getWidth();
public int getHeight();
public int getComponents();
public void getPixels(byte pixels[]);
public void setValue(int width, int height, int components,
byte pixels[]);
public void setValue(ConstSFImage image);
public void setValue(SFImage image);
public String toString(); // This overrides a method in Object
}
public class SFInt32 extends Field
{
public SFInt32();
public SFInt32(int value);
public int getValue();
public void setValue(int i);
public void setValue(ConstSFInt32 i);
public void setValue(SFInt32 i);
public String toString(); // This overrides a method in Object
}
public class SFNode extends Field
{
public SFNode();
public SFNode(BaseNode node);
public BaseNode getValue();
public void setValue(BaseNode node);
public void setValue(ConstSFNode node);
public void setValue(SFNode node);
public String toString(); // This overrides a method in Object
}
public class SFRotation extends Field
{
public SFRotation();
public SFRotation(float axisX, float axisY,
float axisZ, float angle);
public void getValue(float rotations[]);
public void setValue(float rotations[]);
public void setValue(float axisX, float axisY, float axisZ,
float angle);
public void setValue(ConstSFRotation rotation);
public void setValue(SFRotation rotation);
public String toString(); // This overrides a method in Object
}
public class SFString extends Field
{
public SFString();
public SFString(String s);
public String getValue();
public void setValue(String s);
public void setValue(ConstSFString s);
public void setValue(SFString s);
public String toString(); // This overrides a method in Object
}
public class SFTime extends Field
{
public SFTime();
public SFTime(double time);
public double getValue();
public void setValue(double time);
public void setValue(ConstSFTime time);
public void setValue(SFTime time);
public String toString(); // This overrides a method in Object
}
public class SFVec2f extends Field
{
public SFVec2f();
public SFVec2f(float x, float y);
public void getValue(float vec2s[]);
public float getX();
public float getY();
public void setValue(float vec2s[]);
public void setValue(float x, float y);
public void setValue(ConstSFVec2f vec);
public void setValue(SFVec2f vec);
public String toString(); // This overrides a method in Object
}
public class SFVec3f extends Field
{
public SFVec3f();
public SFVec3f(float x, float y, float z);
public void getValue(float vec3s[]);
public float getX();
public float getY();
public float getZ();
public void setValue(float vec3s[]);
public void setValue(float x, float y, float z);
public void setValue(ConstSFVec3f vec);
public void setValue(SFVec3f vec);
public String toString(); // This overrides a method in Object
}
public class MFColor extends MField
{
public MFColor();
public MFColor(float colors[][]);
public MFColor(float colors[]);
public MFColor(int size, float colors[]);
public void getValue(float colors[][]);
public void getValue(float colors[]);
public void get1Value(int index, float colors[]);
public void get1Value(int index, SFColor color);
public void setValue(float colors[][]);
public void setValue(float colors[]);
public void setValue(int size, float colors[]);
/****************************************************
color[0] ... color[size - 1] are used as color data
in the way that color[0], color[1], and color[2]
represent the first color. The number of colors
is defined as "size / 3".
***************************************************/
public void setValue(MFColor colors);
public void setValue(ConstMFColor colors);
public void set1Value(int index, ConstSFColor color);
public void set1Value(int index, SFColor color);
public void set1Value(int index, float red,
float green, float blue);
public void addValue(ConstSFColor color);
public void addValue(SFColor color);
public void addValue(float red, float green, float blue);
public void insertValue(int index, ConstSFColor color);
public void insertValue(int index, SFColor color);
public void insertValue(int index, float red,
float green, float blue);
public String toString(); // This overrides a method in Object
}
public class MFFloat extends MField
{
public MFFloat();
public MFFloat(int size, float values[]);
public MFFloat(float values[]);
public void getValue(float values[]);
public float get1Value(int index);
public void setValue(float values[]);
public void setValue(int size, float values[]);
public void setValue(MFFloat value);
public void setValue(ConstMFFloat value);
public void set1Value(int index, float f);
public void set1Value(int index, ConstSFFloat f);
public void set1Value(int index, SFFloat f);
public void addValue(float f);
public void addValue(ConstSFFloat f);
public void addValue(SFFloat f);
public void insertValue(int index, float f);
public void insertValue(int index, ConstSFFloat f);
public void insertValue(int index, SFFloat f);
public String toString(); // This overrides a method in Object
}
public class MFInt32 extends MField
{
public MFInt32();
public MFInt32(int size, int values[]);
public MFInt32(int values[]);
public void getValue(int values[]);
public int get1Value(int index);
public void setValue(int values[]);
public void setValue(int size, int values[]);
public void setValue(MFInt32 value);
public void setValue(ConstMFInt32 value);
public void set1Value(int index, int i);
public void set1Value(int index, ConstSFInt32 i);
public void set1Value(int index, SFInt32 i);
public void addValue(int i);
public void addValue(ConstSFInt32 i);
public void addValue(SFInt32 i);
public void insertValue(int index, int i);
public void insertValue(int index, ConstSFInt32 i);
public void insertValue(int index, SFInt32 i);
public String toString(); // This overrides a method in Object
}
public class MFNode extends MField
{
public MFNode();
public MFNode(int size, BaseNode node[]);
public MFNode(BaseNode node[]);
public void getValue(BaseNode node[]);
public BaseNode get1Value(int index);
public void setValue(BaseNode node[]);
public void setValue(int size, BaseNode node[]);
public void setValue(MFNode node);
public void setValue(ConstMFNode node);
public void set1Value(int index, BaseNode node);
public void set1Value(int index, ConstSFNode node);
public void set1Value(int index, SFNode node);
public void addValue(BaseNode node);
public void addValue(ConstSFNode node);
public void addValue(SFNode node);
public void insertValue(int index, BaseNode node);
public void insertValue(int index, ConstSFNode node);
public void insertValue(int index, SFNode node);
public String toString(); // This overrides a method in Object
}
public class MFRotation extends MField
{
public MFRotation();
public MFRotation(float rotations[][]);
public MFRotation(float rotations[]);
public MFRotation(int size, float rotations[]);
public void getValue(float rotations[][]);
public void getValue(float rotations[]);
public void get1Value(int index, float rotations[]);
public void get1Value(int index, SFRotation rotation);
public void setValue(float rotations[][]);
public void setValue(float rotations[]);
public void setValue(int size, float rotations[]);
public void setValue(MFRotation rotations);
public void setValue(ConstMFRotation rotations);
public void set1Value(int index, ConstSFRotation rotation);
public void set1Value(int index, SFRotation rotation);
public void set1Value(int index, float axisX,
float axisY, float axisZ, float angle);
public void addValue(ConstSFRotation rotation);
public void addValue(SFRotation rotation);
public void addValue(float axisX, float axisY,
float axisZ, float angle);
public void insertValue(int index, ConstSFRotation rotation);
public void insertValue(int index, SFRotation rotation);
public void insertValue(int index, float axisX,
float axisY, float axisZ, float angle);
public String toString(); // This overrides a method in Object
}
public class MFString extends MField
{
public MFString();
public MFString(int size, String s[]);
public MFString(String s[]);
public void getValue(String s[]);
public String get1Value(int index);
public void setValue(String s[]);
public void setValue(int size, String s[]);
public void setValue(MFString s);
public void setValue(ConstMFString s);
public void set1Value(int index, String s);
public void set1Value(int index, ConstSFString s);
public void set1Value(int index, SFString s);
public void addValue(String s);
public void addValue(ConstSFString s);
public void addValue(SFString s);
public void insertValue(int index, String s);
public void insertValue(int index, ConstSFString s);
public void insertValue(int index, SFString s);
public String toString(); // This overrides a method in Object
}
public class MFTime extends MField
{
public MFTime();
public MFTime(int size, double times[]);
public MFTime(double times[]);
public void getValue(double times[]);
public double get1Value(int index);
public void setValue(double times[]);
public void setValue(int size, double times[]);
public void setValue(MFTime times);
public void setValue(ConstMFTime times);
public void set1Value(int index, double time);
public void set1Value(int index, ConstSFTime time);
public void set1Value(int index, SFTime time);
public void addValue(double time);
public void addValue(ConstSFTime time);
public void addValue(SFTime time);
public void insertValue(int index, double time);
public void insertValue(int index, ConstSFTime time);
public void insertValue(int index, SFTime time);
public String toString(); // This overrides a method in Object
}
public class MFVec2f extends MField
{
public MFVec2f();
public MFVec2f(float vec2s[][]);
public MFVec2f(float vec2s[]);
public MFVec2f(int size, float vec2s[]);
public void getValue(float vec2s[][]);
public void getValue(float vec2s[]);
public void get1Value(int index, float vec2s[]);
public void get1Value(int index, SFVec2f vec);
public void setValue(float vec2s[][]);
public void setValue(float vec2s[]);
public void setValue(int size, float vec2s[]);
public void setValue(MFVec2f vecs);
public void setValue(ConstMFVec2f vecs);
public void set1Value(int index, float x, float y);
public void set1Value(int index, ConstSFVec2f vec);
public void set1Value(int index, SFVec2f vec);
public void addValue(float x, float y);
public void addValue(ConstSFVec2f vec);
public void addValue(SFVec2f vec);
public void insertValue(int index, float x, float y);
public void insertValue(int index, ConstSFVec2f vec);
public void insertValue(int index, SFVec2f vec);
public String toString(); // This overrides a method in Object
}
public class MFVec3f extends MField
{
public MFVec3f();
public MFVec3f(float vec3s[][]);
public MFVec3f(float vec3s[]);
public MFVec3f(int size, float vec3s[]);
public void getValue(float vec3s[][]);
public void getValue(float vec3s[]);
public void get1Value(int index, float vec3s[]);
public void get1Value(int index, SFVec3f vec);
public void setValue(float vec3s[][]);
public void setValue(float vec3s[]);
public void setValue(int size, float vec3s[]);
public void setValue(MFVec3f vecs);
public void setValue(ConstMFVec3f vecs);
public void set1Value(int index, float x, float y, float z);
public void set1Value(int index, ConstSFVec3f vec);
public void set1Value(int index, SFVec3f vec);
public void addValue(float x, float y, float z);
public void addValue(ConstSFVec3f vec);
public void addValue(SFVec3f vec);
public void insertValue(int index, float x, float y, float z);
public void insertValue(int index, ConstSFVec3f vec);
public void insertValue(int index, SFVec3f vec);
public String toString(); // This overrides a method in Object
}
public class ConstSFBool extends ConstField
{
public ConstSFBool(boolean value);
public boolean getValue();
public String toString(); // This overrides a method in Object
}
public class ConstSFColor extends ConstField
{
public ConstSFColor(float red, float green, float blue);
public void getValue(float colors[]);
public float getRed();
public float getGreen();
public float getBlue();
public String toString(); // This overrides a method in Object
}
public class ConstSFFloat extends ConstField
{
public ConstSFFloat(float value);
public float getValue();
public String toString(); // This overrides a method in Object
}
public class ConstSFImage extends ConstField
{
public ConstSFImage(int width, int height,
int components, byte pixels[]);
public int getWidth();
public int getHeight();
public int getComponents();
public void getPixels(byte pixels[]);
public String toString(); // This overrides a method in Object
}
public class ConstSFInt32 extends ConstField
{
public ConstSFInt32(int value);
public int getValue();
public String toString(); // This overrides a method in Object
}
public class ConstSFNode extends ConstField
{
public ConstSFNode(BaseNode node);
public BaseNode getValue();
public String toString(); // This overrides a method in Object
}
public class ConstSFRotation extends ConstField
{
public ConstSFRotation(float axisX,
float axisY, float axisZ, float angle);
public void getValue(float rotations[]);
public String toString(); // This overrides a method in Object
}
public class ConstSFString extends ConstField
{
public ConstSFString(String value);
public String getValue();
public String toString(); // This overrides a method in Object
}
public class ConstSFTime extends ConstField
{
public ConstSFTime(double time);
public double getValue();
public String toString(); // This overrides a method in Object
}
public class ConstSFVec2f extends ConstField
{
public ConstSFVec2f(float x, float y);
public void getValue(float vec2s[]);
public float getX();
public float getY();
public String toString(); // This overrides a method in Object
}
public class ConstSFVec3f extends ConstField
{
public ConstSFVec3f(float x, float y, float z);
public void getValue(float vec3s[]);
public float getX();
public float getY();
public float getZ();
public String toString(); // This overrides a method in Object
}
public class ConstMFColor extends ConstMField
{
public ConstMFColor(float colors[][]);
public ConstMFColor(float colors[]);
public ConstMFColor(int size, float colors[]);
public void getValue(float colors[][]);
public void getValue(float colors[]);
public void get1Value(int index, float colors[]);
public void get1Value(int index, SFColor color);
public String toString(); // This overrides a method in Object
}
public class ConstMFFloat extends ConstMField
{
public ConstMFFloat(int size, float values[]);
public ConstMFFloat(float values[]);
public void getValue(float values[]);
public float get1Value(int index);
public String toString(); // This overrides a method in Object
}
public class ConstMFInt32 extends ConstMField
{
public ConstMFInt32(int size, int values[]);
public ConstMFInt32(int values[]);
public void getValue(int values[]);
public int get1Value(int index);
public String toString(); // This overrides a method in Object
}
public class ConstMFNode extends ConstMField
{
public ConstMFNode(int size, BaseNode node[]);
public ConstMFNode(BaseNode node[]);
public void getValue(BaseNode node[]);
public BaseNode get1Value(int index);
public String toString(); // This overrides a method in Object
}
public class ConstMFRotation extends ConstMField
{
public ConstMFRotation(float rotations[][]);
public ConstMFRotation(float rotations[]);
public ConstMFRotation(int size, float rotations[]);
public void getValue(float rotations[][]);
public void getValue(float rotations[]);
public void get1Value(int index, float rotations[]);
public void get1Value(int index, SFRotation rotation);
public String toString(); // This overrides a method in Object
}
public class ConstMFString extends ConstMField
{
public ConstMFString(int size, String s[]);
public ConstMFString(String s[]);
public void getValue(String values[]);
public String get1Value(int index);
public String toString(); // This overrides a method in Object
}
public class ConstMFTime extends ConstMField
{
public ConstMFTime(int size, double times[]);
public ConstMFTime(double times[]);
public void getValue(double times[]);
public double get1Value(int index);
public String toString(); // This overrides a method in Object
}
public class ConstMFVec2f extends ConstMField
{
public ConstMFVec2f(float vec2s[][]);
public ConstMFVec2f(float vec2s[]);
public ConstMFVec2f(int size, float vec2s[]);
public void getValue(float vec2s[][]);
public void getValue(float vec2s[]);
public void get1Value(int index, float vec2s[]);
public void get1Value(int index, SFVec2f vec);
public String toString(); // This overrides a method in Object
}
public class ConstMFVec3f extends ConstMField
{
public ConstMFVec3f(float vec3s[][]);
public ConstMFVec3f(float vec3s[]);
public ConstMFVec3f(int size, float vec3s[]);
public void getValue(float vec3s[][]);
public void getValue(float vec3s[]);
public void get1Value(int index, float vec3s[]);
public void get1Value(int index, SFVec3f vec);
public String toString(); // This overrides a method in Object
}

vrml.node Package
package vrml.node;
//
// This is the general Node class
//
public abstract class Node extends BaseNode
{
// Get an EventIn by name. Return value is write-only.
// Throws an InvalidEventInException if eventInName
// isn't a valid eventIn name for a node of this type.
public final Field getEventIn(String eventInName);
// Get an EventOut by name. Return value is read-only.
// Throws an InvalidEventOutException if eventOutName
// isn't a valid eventOut name for a node of this type.
public final ConstField getEventOut(String eventOutName);
// Get an exposed field by name.
// Throws an InvalidExposedFieldException if
// exposedFieldNamed isn't a valid exposedField name
// for a node of this type.
public final Field getExposedField(String exposedFieldName);
public String toString(); // This overrides a method in Object
}
//
// This is the general Script class, to be subclassed by
// all scripts. Note that the provided methods allow the
// script author to explicitly throw tailored exceptions
// in case something goes wrong in the script.
//
public abstract class Script extends BaseNode
{
// This method is called before any event is generated
public void initialize();
// Get a Field by name.
// Throws an InvalidFieldException if fieldName
// isn't a valid field name for a node of this type.
protected final Field getField(String fieldName);
// Get an EventOut by name.
// Throws an InvalidEventOutException if eventOutName
// isn't a valid eventOut name for a node of this type.
protected final Field getEventOut(String eventOutName);
// Get an EventIn by name.
// Throws an InvalidEventInException if eventInName
// isn't a valid eventIn name for a node of this type.
protected final Field getEventIn(String eventInName);
// processEvents() is called automatically when the
// script receives some set of events. It shall not be
// called directly except by its subclass.
// count indicates the number of events delivered.
public void processEvents(int count, Event events[]);
// processEvent() is called automatically when the script
// receives an event.
public void processEvent(Event event);
// eventsProcessed() is called after every invocation
// of processEvents().
public void eventsProcessed()
// shutdown() is called when this Script node is deleted.
public void shutdown();
public String toString(); // This overrides a method in Object
}
|