JavaScript Client API

Class List

Here are the classes with brief descriptions:

com.​mi.​rs.​BatchCommand
A batch command is a special command that can have any number of sub-commands
com.​mi.​rs.​Command
The Command class that wraps the information needed to execute a command
com.​mi.​rs.​CommandSequence
The CommandSequence class accepts a sequence of commands to be processed by the service
com.​mi.​util.​EventDispatcher
The EventDispatcher is used dispatch events to registered event listeners
com.​mi.​rs.​GenericRenderCommand
Renders an image
com.​mi.​rs.​event.​ImageEvent
The ImageEvent is dispatched by the ImageRenderTarget when the an image has been loaded
com.​mi.​rs.​ImageRenderTarget
The target for images returned by the render command
com.​mi.​rs.​types.​Matrix4x4
Matrix 4x4 class
com.​mi.​rs.​event.​MouseEvent
The MouseEvent is dispatched by objects that respond to mouse events
com.​mi.​rs.​RenderCommand
Renders an image
com.​mi.​rs.​RenderLoopExecuteCommand
The render_loop_execute command is a special command that operates in a similar way to the batch command
com.​mi.​rs.​RenderLoopStateData
This interface encapsulates the data that is to used when executing commands on render loops via a WebSocketStreamer
com.​mi.​rs.​event.​RenderURLEvent
The RenderURLEvent is dispatched by objects that respond to mouse events
com.​mi.​rs.​Response
Defines the interface of a command response object
com.​mi.​rs.​RSService
The main RealityServer Client Library class that can process RealityServer commands
com.​mi.​rs.​StateData
This interface encapsulates the data that is used by the RealityServer state handlers to decide which state commands are processed in
com.​mi.​rs.​types.​Vector4
Vector 4 class
com.​mi.​rs.​WebSocketStreamer
Same functionality as the RSService except it operates over a Web Socket connection rather than HTTP