Xj3D VRML/X3D Code API

Package org.web3d.x3d.sai

The core classes for defining access through both external and internal means to an X3D browser and its contents through the X3D SAI (ISO/IEC 17775-2) interface.

See:
          Description

Interface Summary
Browser Basic browser interface that represents the interface to the VRML browser from any application.
BrowserFactoryImpl The factory implementation interface for obtaining references to browser instances.
BrowserListener Listener interface for classes wishing to know about changes in the browser
ComponentInfo Description of a single component.
ExternalBrowser Browser interface that represents the additional abilities an external application is granted to the VRML browser.
MFBool Interface representing a MFBool field.
MFColor Representation of an MFColor field.
MFColorRGBA Representation of an MFColorRGBA field.
MFDouble Representation of a MFDouble field.
MFFloat Representation of a MFFloat field.
MField X3D base interface for MF field values.
MFImage Representation of a MFImage field.
MFInt32 Representation of a MFInt32 field.
MFNode Representation of a MFNode field.
MFRotation Representation of a MFRotation field.
MFString Representation of a MFString field.
MFTime Representations of a MFTime field.
MFVec2d Representation of a MFVec2d field.
MFVec2f Representation of a MFVec2f field.
MFVec3d Representation of a MFVec3d field.
MFVec3f Representation of a MFVec3f field.
ProfileInfo Description of a single profile.
SFBool Representation of a SFBool field.
SFColor Representation of a SFColor field.
SFColorRGBA Representation of a SFColorRGBA field.
SFDouble Representation of a SFDouble field.
SFFloat Representation of a SFFloat field.
SFImage Representation of a SFImage field.
SFInt32 Representation of a SFInt32 field.
SFNode Representation of a SFNode field.
SFRotation Representation of a SFRotation field.
SFString Representation of a SFString field.
SFTime Representation of a SFTime field.
SFVec2d Representation of a SFVec2d field.
SFVec2f Representation of a SFVec2f field.
SFVec3d Representation of a SFVec3d field.
SFVec3f Representation of a SFVec3f field.
X3DAppearanceChildNode Nodes which can appear in a field of an Appearance Node type.
X3DAppearanceNode Node which represents appearance attributes of an object.
X3DAudioClipNode Nodes which describe a source of audio data.
X3DBackgroundNode Defines a 2D transformation that is applied to a texture.
X3DBindableNode Indicates that a node can be bound within the scenegraph to make it the active item.
X3DBoundedObject Indicates that a node contains a bounding box field.
X3DChildNode Representation of any legal child node that can be used in the scene graph.
X3DColorNode A node which specifies color information.
X3DComponent Provides for implementation of a X3D browser than runs as a component and able to extract a Browser reference from it.
X3DComposedGeometryNode An interface for accessing the geometry data of an IndexedGeometry class.
X3DCoordinateNode Nodes which have coordinate information.
X3DDragSensorNode A sensor that is driven by pointing device dragging.
X3DEnvironmentalSensorNode Sensors triggered by environmental effects such the view movement.
X3DExecutionContext Abstract representation of a complete X3D scene graph.
X3DExternProtoDeclaration The representation of an EXTERNPROTO declaration.
X3DField Base representation of an X3D field type.
X3DFieldDefinition Representation of a node's field definition.
X3DFieldEventListener A listener for events on X3D fields
X3DFieldTypes Listing of constants relating to fields types.
X3DFontStyleNode Describes a font in X3D.
X3DGeometricPropertyNode A property of a geometric object such as color, coordinate, normal.
X3DGeometryNode Geometry nodes produce renderable geometry and are contained by a Shape node.
X3DGroupingNode A node which can contain other nodes.
X3DInfoNode Nodes which can be activated by clicking with a pointing device sensor
X3DInterpolatorNode Interpolator nodes are designed for linear keyframed animation.
X3DKeyDeviceSensorNode A sensor that takes it's input from a keyboard device.
X3DLightNode An abstract representation of any form of light node.
X3DLoadStateTypes Listing of constants relating to load states and the SAILoadState type.
X3DMaterialNode Node specifies visual surface material properties for associated geometry.
X3DMetadataObject Indicates that a node contains a bounding box field.
X3DNetworkSensorNode Nodes which can be activated by clicking with a pointing device sensor
X3DNode The base representation of any VRML node in the system whether built in or a proto.
X3DNodeTypes Listing of type constants for X3D nodes.
X3DNormalNode Defines a set of 3D surface normals.
X3DParametricGeometryNode Geometry specified by a parametric description
X3DPerFrameObserverScript Marker interface to say that the implementing class is interested in knowing about per-frame updates and the pre event cascade processing steps.
X3DPointingDeviceSensorNode A sensor driven by a pointing device.
X3DProtoDeclaration The representation of a PROTO declaration.
X3DProtoInstance The base representation of any node that is constructed from a PROTO declaration.
X3DRoute Representation of a ROUTE structure in X3D.
X3DScene Abstract representation of a complete X3D scene graph.
X3DScriptImplementation Marker interface to say that the implementing class is allowed to be executed as a script within the X3D scene graph.
X3DScriptNode Shell representation of a script node.
X3DSensorNode A node which generates events based on sensors
X3DSequencerNode A node represents the Sequencer node types in the spec.
X3DShapeNode Description of a renderable object
X3DSoundNode A node which emits sounds to the environment.
X3DSoundSourceNode A node which emits sounds to the environment.
X3DTextNode Describes a Text string output geometry node in X3D .
X3DTexture2DNode Base interface for all texture types for associated geometry.
X3DTextureCoordinateNode Specifies a set of texture coordinates.
X3DTextureNode Base interface for all texture types for associated geometry.
X3DTextureTransform2DNode Defines a 2D transformation that is applied to a texture.
X3DTextureTransformNode Defines a 2D transformation that is applied to a texture
X3DTimeDependentNode Nodes which have behaviour controlled by a clock.
X3DTouchSensorNode Nodes which can be activated by clicking with a pointing device sensor
X3DTriggerNode A node which represents the trigger node types.
X3DUrlObject Representation of a node that defines it's content at a URL separate to this file that will also need loading.
 

Class Summary
BrowserEvent Class representing events that happen to the VRML browser.
BrowserFactory The factory class for obtaining references to browser instances.
Matrix3 Describes a 3x3 Matrix as required by the SAIMatrix abstract type.
Matrix4 Describes a 3x3 Matrix as required by the SAIMatrix abstract type.
X3DFieldEvent The event that is generated when a field changes value.
 

Exception Summary
BrowserNotSharedException The exception that is thrown when the user attempts to make method calls that require this browser to be shared.
ConnectionException The exception that is thrown when an error occurs in the connection between the external application and the VRML browser.
ImportedNodeException The exception that is thrown when the user attempts to use an IMPORTed node incorrectly in the scene graph.
InsufficientCapabilitiesException The exception that is thrown when a node of greater capabilities than the scene's declared profile and additional components is attempted to be added to that scene.
InvalidBrowserException The exception that is thrown when the user attempts to access a method in the Browser interface after the reference has had the dispose method called.
InvalidDocumentException The exception that is thrown when the user attempts to import a DOM Document to make it into an X3DScene and the document is not correctly structured.
InvalidExecutionContextException The exception that is thrown when a reference to an ExecutionContext is not valid.
InvalidFieldException The exception that is thrown when a reference to any field is not valid.
InvalidFieldValueException The exception that is thrown when the value that has just been set in a field is not valid.
InvalidNodeException The exception that is thrown when a reference to an Node is not valid.
InvalidOperationTimingException The exception that is thrown when the user attempts to use an API call outside of the pre-defined times.
InvalidProtoException The exception that is thrown when a reference to an Proto or ExternProto is not valid.
InvalidReadableFieldException The exception that is thrown when a reference to an readable field is not valid.
InvalidRouteException The exception that is thrown when a reference to any route is not valid.
InvalidURLException The exception that is thrown when the list of all URL and URN values are invalid and cannot be parsed to form a proper URL/URN.
InvalidWritableFieldException The exception that is thrown when a reference to an writable field is not valid.
InvalidX3DException The exception that is thrown when a the string passed to createVrmlFromString does not contain legal X3D - either UTF8 or XML syntax.
NodeInUseException The exception that is thrown when a reference to an Node is already being used when the user wants to add a new DEF, EXPORT or IMPORT definition.
NodeUnavailableException The exception that is thrown when asking for a node by name Node and the name is valid but the underlying node reference is not available from the inline yet.
NoSuchBrowserException The exception that is thrown when the Browser factory is not able to locate a browser given the arguments.
NotSupportedException The exception that is thrown when an operation is not supported by an underlying implementation.
URLUnavailableException The exception that is thrown when the URL is not specified for the currently browser instance or there is some other problem.
X3DException The basic exception that is thrown by any VRML method call that wishes to throw exceptions.
 

Package org.web3d.x3d.sai Description

The core classes for defining access through both external and internal means to an X3D browser and its contents through the X3D SAI (ISO/IEC 17775-2) interface.

The SAI is still somewhat of a work-in-progress. It follows the development of the X3D specification. It will probably change over time.

Related Information


Xj3D VRML/X3D Code API

Copyright © 2001 - 2005 Web3D Consortium