Extensible 3D (X3D) language bindings
Part 2:  Java

4 Tables

--- X3D separator bar ---

cube 4.1 Introduction and table of contents

4.1.1 Introduction

This clause contains tables defining abbreviations used and mapping abstract names from ISO/IEC 19775-2 (see 2.I19775]) to those of this binding.

4.1.2 Topics

See Table 4.1 for the table of contents for this clause.

Table 4.1 — Topics in this clause

4.2 Mappings of abstract names to Java binding names

4.2.1 Data types

In Table 4.2, each row lists an abstract name of a data type from ISO/IEC 19775-2 followed by the corresponding bound name. The names of data types used to reference data items are not included but may be found in Table 4.3.

Table 4.2 — Data type names listed alphabetically by abstract name

Abstract Name Bound Name
SAIAction N/A
SAIBoolean boolean
SAIBrowserApp X3DComponent
SAIBrowserName java.lang.string
SAIBrowserRef Browser
ExternalBrowser
SAIBrowserVersion java.lang.String
SAIComponentDeclaration ComponentInfo class
SAIComponent (java.lang.String, int)
SAIEncoding int
SAIExecutionContext X3DExecutionContext
SAIFieldAccess X3DFieldTypes
SAIFieldName java.lang.String
SAIFieldType X3DFieldTypes
SAIFieldValue various. Defined by field type. See Table 5.4
SAIFrameRate float
SAILoadState X3DLoadStates
SAINavSpeed float
SAINodeID X3DNode and derived-types
SAINodeType X3DNodeTypes
SAIParameterList java.lang.String
SAIPropertyList java.util.Map
SAIRequesterID java.lang.Object
SAIString java.lang.String
SAIURL java.util.String
null null

Table 4.3 — Data class names listed alphabetically by abstract name

Abstract Name Bound Name
SAIBrowserRef Browser
ExternalBrowser
SAIComponentDeclaration ComponentInfo
SAIExecutionContextID X3DExecutionContext
SAIFieldDeclaration X3DFieldDefinition
SAIFieldValue various. Defined by field type
SAILoadState X3DLoadStates
SAINodeID X3DNode and derived-types
SAIProfileDeclaration ProfileInfo
SAIProtoDeclaration X3DProtoDeclaration
SAIRoute X3DRoute
SAIScript X3DScriptNodeType
SAIScriptImplementation X3DScriptImplementation
X3DPerFrameObserverScript
SAIScene X3DScene

4.2.2 Error types

In Table 4.4, each row lists an abstract name of an exception from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.4 — Error class names listed alphabetically by abstract name

Abstract Name Bound Name
SAI_BROWSER_UNAVAILABLE NoSuchBrowserException
SAI_CONNECTION_ERROR ConnectionException
SAI_INSUFFICIENT_CAPABILITIES InsufficientCapabilitiesException
SAI_DISPOSED InvalidBrowserException
InvalidExecutionContextException
InvalidNodeException
InvalidRouteException
InvalidProtoException
SAI_IMPORTED_NODE InvalidImportException
SAI_INVALID_ACCESS_TYPE InvalidWritableFieldException
InvalidReadableFieldException
SAI_INVALID_BROWSER InvalidBrowserException
SAI_INVALID_DOCUMENT InvalidDocumentException
SAI_INVALID_NAME InvalidNodeException
InvalidNameException
SAI_INVALID_NODE InvalidNodeException
SAI_INVALID_FIELD InvalidFieldException
SAI_INVALID_OPERATION_TIMING InvalidOperationTimingException
SAI_INVALID_URL InvalidURLException
SAI_INVALID_X3D InvalidX3DException
SAI_NODE_NOT_AVAILABLE NodeUnavailableException
SAI_NODE_IN_USE NodeInUseException
SAI_NOT_SHARED BrowserNotSharedException
SAI_NOT_SUPPORTED NotSupportedException
SAI_URL_UNAVAILABLE URLUnavailableException

4.2.3 Event types

In Table 4.5, each row lists an abstract name of an event type from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.5 — Event type names listed alphabetically by abstract name

Abstract Name Bound Name
SAIBrowserEvent BrowserEvent
SAI_BROWSER_ConnectionError CONNECTION_ERROR
SAIFieldEvent X3DFieldEvent
SAI_BROWSER_Initialized INITIALIZED
SAI_BROWSER_Shutdown SHUTDOWN
SAI_BROWSER_URLError URL_ERROR

4.2.4 Browser services

In Table 4.6, each row lists an abstract name of an event type from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.6 — Browser services listed alphabetically by abstract name

Abstract Name Bound Name
getBrowser ExternalBrowser getBrowser(java.applet.Applet)
ExternalBrowser getBrowser(java.applet.Applet, java.lang.String, int) ExternalBrowser getBrowser(java.net.InetAddress, int)
createBrowser X3DComponent createBrowser(java.util.Map)
getName String getName()
String getVersion getVersion()
getCurrentSpeed float getCurrentSpeed()
getCurrentFrameRate float getCurrentFrameRate()
getSupportedProfiles ProfileInfo[] getSupportedProfiles
getProfile ProfileInfo getProfile(java.lang.String)
getSupportedComponents ComponentInfo[] getSupportedComponent()
getComponent ComponentInfo getComponent(java.lang.String, int)
getExecutionContext ExecutionContext getExecutionContext()
createScene X3DScene createScene(ProfileInfo, ComponentInfo[])
replaceWorld replaceWorld(X3DScene)
importDocument X3DScene importDocument(org.w3c.dom.Node)
loadURL void loadURL(java.lang.String[], java.lang.String[])
setDescription void setDescription(java.lang.String)
createX3DFromString X3DScene createX3DFromString(java.lang.String)
createX3DFromStream X3DScene createX3DFromString(java.io.InputStream)
createX3DFromURL X3DScene createX3DFromURL(java.lang.String[])
Update Control void beginUpdate()
void endUpdate()
Register Browser Interest void addBrowserListener(BrowserListener) void removeBrowserListener(BrowserListener)
getRenderingProperties java.util.Map getRenderingProperties()
getBrowserProperties java.util.Map getBrowserProperties()
changeViewpoint void nextViewpoint()
void previousViewpoint()
void firstViewpoint()
void lastViewpoint()
Print void print(Object)
void println(Object)
Dispose void dispose()

4.2.5 Execution context services

In Table 4.7, each row lists an abstract name of an execution context service from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.7 — Execution context services listed alphabetically by abstract name

Abstract Name Bound Name
getSpecificationVersion String getSpecificationVersion()
getEncoding int getEncoding()
getProfile ProfileInfo getProfile()
getComponents ComponentInfo[] getComponents()
getWorldURL String getWorldURL()
getNode X3DNode getNamedNode(java.lang.String)
X3DNode getExportedNode(java.lang.String)
createNode X3DNode createNode(java.lang.String)
createProto X3DNode createProto(java.lang.String)
Named node handling void updateNamedNode(java.lang.String, X3DNode)
void updateImportedNode(java.lang.String, java.lang.String, X3DNode)
void removeNamedNode(java.lang.String)
void removeImportedNode(java.lang.String)
getProtoDeclaration X3DProtoDeclaration getProtoDeclaration(java.lang.String)
PROTO Declaration Handling void updateProtoDeclaration(java.lang.String, X3DProtoDeclaration)
void removeProtoDeclaration(java.lang.String)
getExternProtoDeclaration X3DExternProtoDeclaration getExternProtoDeclaration(java.lang.String)
EXTERNPROTO Declaration Handling void updateExternProtoDeclaration(java.lang.String, X3DExternProtoDeclaration)
void removeExternProtoDeclaration(java.lang.String)
getRootNodes X3DNode[] getRootNodes
getRoutes X3DRoute[] getRoutes()
Dynamic Route Handling X3DRoute[] addRoute(X3DNode, java.lang.String, X3DNode, java.lang.String)
void removeRoute(X3DRoute)
Dispose void dispose()

4.2.6 Scene services

In Table 4.8, each row lists an abstract name of an scene service from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.8 — Scene services listed alphabetically by abstract name

Abstract Name Bound Name
getMetaData java.lang.String getMetaData(java.lang.String)
setMetaData void setMetaData(java.lang.String, java.lang.String)
getNode X3DNode getExportedNode(java.lang.String)
Named Node Handling void updateExportedNode(java.lang.String, java.lang.String)
void removeExportedNode(java.lang.String)
Root Node Handling void addRootNode(X3DNode)
void removeRootNode(X3DNode);

4.2.7 Node services

In Table 4.9, each row lists an abstract name of an node service from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.9 — Node services listed alphabetically by abstract name

Abstract Name Bound Name
getName String getName()
getType int[] getType()
getField X3DField getField(java.lang.String)
getFieldDefinitions X3DFieldDefinition getFieldDefinitions()
Dispose void dispose()

4.2.8 Field services

In Table 4.10, each row lists an abstract name of a field service from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.10 — Field services listed alphabetically by abstract name

Abstract Name Bound Name
getName String getName()
getType int getType()
getAccessType boolean isWritable()
boolean isReadable()
getValue type getValue()
void getValue(type)
type get1Value(int)
setValue void setValue(type)
void get1Value(int, type)
Register Field Interest void addFieldEventListener(X3DFieldEventListener)
void removeFieldEventListener(X3DFieldEventListener)
Dispose void dispose()

4.2.9 Route services

In Table 4.11, each row lists an abstract name of a route service from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.11 — Route services listed alphabetically by abstract name

Abstract Name Bound Name
getSourceNode X3DNode getSourceNode()
getSourceField java.lang.String getSourceField()
getDestinationNode X3DNode getDestinationNode()
getDestinationField java.lang.String getDestinationField()
Dispose dispose()

4.2.10 Prototype services

In Table 4.12, each row lists an abstract name of a prototype service from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.12 — Prototype services listed alphabetically by abstract name

Abstract Name Bound Name
isExternProto instanceof operator
createInstance X3DProtoInstance createInstance()
getFieldDefinitions X3DFieldDefinition[] getFieldDefinitions
Check Load State int getLoadState()
Request Immediate Load void loadNow()
Dispose dispose()

4.2.11 Script content services

In Table 4.13, each row lists an abstract name of a script content service from ISO/IEC 19775-2 followed by the corresponding bound name.

Table 4.13 — Script content services listed alphabetically by abstract name

Abstract Name Bound Name
setBrowser void setBrowser(Browser)
setFields setFields(X3DScriptNode, java.util.Map)
initialize void initialize()
prepareEvents void prepareEvents()
eventsProcessed void eventsProcessed()
shutdown void shutdown()

4.2.12 Matrix services

In Table 4.14, each row lists an abstract name of a matrix service from Part 2 of ISO/IEC 19775 followed by the corresponding bound name.

Table 4.14 — Matrix services listed alphabetically by abstract name

Abstract Name Bound Name
set void set(SFVec3f, SFRotation, SFVec3f, SFRotation, SFVec3f).
get void get(SFVec3f, SFRotation, SFVec3f)
inverse void inverse()
transpose void transpose()
Matrix.multiply void multiplyLeft(Matrix)
void multiplyRight(Matrix)
Matrix Multiply with vector void multiplyLeft(Matrix, SFVec3f)
void multiplyLeft(Matrix, SFVec3d)
void multiplyRight(Matrix, SFVec3f)
void multiplyRight(Matrix, SFVec3d)

--- X3D separator bar ---