instantreality 1.0

JavaScript bindings API for InstantReality

The system uses JavaScript Version 1.5. The bindings provide a full ISO-IEC-14772/VRML-Spec;X3D2.0 and almost complete ISO-IEC-19777/X3D-SAI-Spec;X3D3.0 implementation. InstantReality specific extensions are marked with Avalon as standard.

Global objects

Name Description Standard
Browser All browser services are encapsulated through two host objects: Browser and ExternalBrowser. X3D2.0
ComponentInfo The ComponentInfo object stores information about a particular X3D component. The object consists solely of read-only properties. X3D3.0
ComponentInfoArray The ComponentInfoArray object is an object that represents an array of ComponentInfo objects. This is a read-only object. The user is not permitted to create a new instance of this object. X3D3.2
ExecutionContext The execution context. X3D3.0
ExternProtoDeclaration An EXTERNPROTO declaration is represented by the ExternProtoDeclaration host object. The user cannot create instances of this object. EXTERNPROTO declarations can only be fetched using the ExecutionContext object. X3D3.0
ExternProtoDeclarationArray ExternProtoDeclarationArray is an object that represents an array of ExternProtoDeclaration objects. This is a read-only object. The user is not permitted to create a new instance of this object. X3D3.2
Field All field objects provide the functions declared in this class. X3D3.0
FieldDefinition The FieldDefinition object represents all of the descriptive properties of a single field of a node. X3D3.0
FieldDefinitionArray FieldDefinitionArray is an object that represents an array of FieldDefinition objects. This is a read-only object. The user is not permitted to create a new instance of this object. X3D3.2
global Global functions and variables (available without an object). X3D2.0
ProfileInfo This object stores information about a particular X3D profile. X3D3.0
ProfileInfoArray The ProfileInfoArray object is an object that represents an array of ProfileInfo objects. This is a read-only object. The user is not permitted to create a new instance of this object. X3D3.2
ProtoDeclaration A PROTO declaration is represented by the ProtoDeclaration host object. The user cannot create instances of this object. This object can only be fetched using the ExecutionContext object. X3D3.0
ProtoDeclarationArray ProtoDeclarationArray is an object that represents an array of ProtoDeclaration objects. This is a read-only object. The user is not permitted to create a new instance of this object. X3D3.2
Route Routes are represented by the Route host object. This object cannot be directly instantiated. Routes may only be created through calls to the ExecutionContext addRoute() function. X3D3.0
RouteArray RouteArray is an object that represents an array of Route objects. This is a read-only object. The user is not permitted to create a new instance of this object. X3D3.2
Scene The Scene object extends the ExecutionContext object. X3D3.0
View Abstract interface for any render surfaces e.g. Viewport, Viewarea or RenderedTexture. Use the "description" field to name the View. The default Viewarea is 'default'. Avalon
X3DConstants
XMLHttpRequest

Single field objects (SF*)

Name Description Standard
SFColor The SFColor object corresponds to a X3D SFColor field. X3D2.0
SFColorRGBA The SFColorRGBA object corresponds to a X3D SFColorRGBA field. Avalon
SFImage The SFImage object corresponds to a X3D SFImage field. X3D2.0
SFMatrix3f The SFMatrix3f object provides many useful functions for performing manipulations on 3x3 matrices. Avalon
SFMatrix3Row Represents a row of a SFMatrix3f object. Avalon
SFMatrix4f The SFMatrix4f object provides many useful functions for performing manipulations on 4x4 matrices. Avalon
SFMatrix4Row Represents a row of a SFMatrix4f object. Avalon
SFNode The SFNode object corresponds to an X3D SFNode field. X3D2.0
SFRotation The SFRotation object corresponds to an X3D SFRotation field. X3D2.0
SFVec2f The SFVec2f object corresponds to an X3D SFVec2f field. X3D2.0
SFVec3d The SFVec3d object corresponds to an X3D SFVec3d field. X3D2.0
SFVec3f The SFVec3f object corresponds to an X3D SFVec3f field. X3D2.0
SFVec4f The SFVec4f object corresponds to an X3D SFVec4f field. Avalon

Multi field objects (MF*)

Name Description Standard
MFBool The MFBool object is used to store a one-dimensional array of boolean values. X3D3.0
MFColor The MFColor object is used to store a one-dimensional array of SFColor objects. X3D2.0
MFColorRGBA The MFColorRGBA object corresponds to an X3D MFColorRGBA field. Avalon
MFDouble The MFDouble object is used to store a one-dimensional array of double precision numeric values. X3D3.0
MFFloat The MFFloat object corresponds to an X3D MFFloat field. X3D2.0
MFImage The MFImage object corresponds to a X3D MFImage field. Avalon
MFInt32 The MFInt32 field is used to store a one-dimensional array of integer values. X3D2.0
MFMatrix4f The MFMatrix4f object corresponds to an X3D MFMatrix4f field. Avalon
MFNode The MFNode object corresponds to an X3D MFNode field. X3D2.0
MFRotation The MFRotation object corresponds to a X3D MFRotation field. X3D2.0
MFString The MFString object corresponds to a X3D MFString field. X3D2.0
MFTime The MFTime object corresponds to a X3D MFTime field. X3D2.0
MFVec2f The MFVec2f object corresponds to a X3D MFVec2f field. X3D2.0
MFVec3f The MFVec3f object corresponds to an X3D MFVec3f field. X3D2.0
MFVec4f The MFVec4f object corresponds to an X3D MFVec4f field. Avalon