Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
| Class | Package | Description | |
|---|---|---|---|
|
BatchCommand |
com.mi.rs | Implementation of the IBatchCommand interface. | |
|
BoundingBox |
com.mi.rs.multiview.utils | Provides a wrapper for the Bbox3 type that is used on the server. | |
|
CameraOptions |
com.mi.rs.multiview.option | An option set that contains options for the scene camera. | |
|
CameraSet |
com.mi.rs.multiview.core | The CameraSet class allows for camera manipulation and for setting different camera settings such as the aperture size and focal length. | |
|
CameraWidget3d |
com.mi.rs.multiview.widgets | Implementation for interactive 3D camera widgets. | |
|
Color |
com.mi.rs.multiview.utils | Provides a wrapper for the Color type used on the server. | |
|
Command |
com.mi.rs | A generic implementation of the ICommand interface. | |
|
ConfigXML |
com.mi.rs.multiview.option | Retrieves an XML configuration file from the server and sets the option parameters accordingly. | |
|
ConfigXMLEvent |
com.mi.rs.multiview.event | ||
|
DaylightEvent |
com.mi.rs.multiview.event | ||
|
DaylightOptions |
com.mi.rs.multiview.option | Top-level option set for values affecting daylight settings. | |
|
GeneralUtils |
com.mi.rs.multiview.utils | Provides generic functions. | |
|
H264Options |
com.mi.rs.multiview.option.rtmp | Specifies a list of supported video encoder parameters for the 'h264' codec for the 'mental images x264 (v1)' encoder. | |
|
IBatchCommand |
com.mi.rs | Interface specifying a batch command. | |
|
ICommand |
com.mi.rs | The interface specifying the data and methods of a RealityServer command. | |
|
ICommandSequence |
com.mi.rs | This interface is used by RSService in process commands callbacks to accept a sequence of commands from the application that the service will then process. | |
|
IInputMethod |
com.mi.rs.multiview.input_method | Defines a way in which a view can be manipulated, often by changing the camera parameters. | |
|
IJSON |
com.mi.util | Marks an object to have a special jsonObject member that contains the most recent data in a form that is friendly to the JSON serializer. | |
|
ImageRenderTarget |
com.mi.rs | A UIComponent that displays images rendered using a command of type IRenderCommand. | |
|
InputMethodBase |
com.mi.rs.multiview.input_method | Responsible for adding and removing all mouse listeners for input methods. | |
|
InputMethodEvent |
com.mi.rs.multiview.event | Events fired from IInputMethods object to indicate when they are active, complete, started navigating and finished navigating. | |
|
InputMethodOptions |
com.mi.rs.multiview.option | Stores all the input method options. | |
|
IOptionSet |
com.mi.rs.multiview.option | Used to handle dynamic data by using value change events, value validations and saving and merging with other dynamic Objects. | |
|
IRenderCommand |
com.mi.rs | Defines the interface for commands that return an image. | |
|
IResponse |
com.mi.rs | Defines the interface of a command response object. | |
|
IResponseError |
com.mi.rs | Defines the interface of the error parameter of IResponse. | |
|
IRSDCamera |
com.mi.rs.multiview.utils | Interface designed to allow for different implementation of a camera. | |
|
IScene |
com.mi.rs.multiview.core | Extends a typical RSService connection and stores data about a loaded scene and the capabilities of the server. | |
|
IScope |
com.mi.rs.multiview.scope | The IScope interface defines methods for setting the scope name, the scope parent and getting the state data for that scope on the server. | |
|
IScopeNode |
com.mi.rs.multiview.scope | The IScopeNode interface allows an object that can connect to the server to have its own scope name and IStateData representation. | |
|
IService |
com.mi.rs | Defines the interface of a service object that can process RealityServer commands. | |
|
IStateData |
com.mi.rs | This interface encapsulates the data that is used by the RealityServer state handlers to decide which state commands are processed in. | |
|
IView |
com.mi.rs.multiview.core | Extends the IViewBasic class by adding an IScene object to the view. | |
|
IViewBasic |
com.mi.rs.multiview.core | An IViewBasic object serves as the basis for all views used in the web viewer library. | |
|
IWidget3d |
com.mi.rs.multiview.widgets | Defines update functionality for 3D widgets. | |
|
IWidgetShape3d |
com.mi.rs.multiview.widgets | Provides an interface to repaint 3D widgets. | |
|
JSON |
com.mi.util | ||
|
LookInputMethod |
com.mi.rs.multiview.input_method | Allows first-person camera navigation in a view. | |
|
Matrix4x4 |
com.mi.rs.types | A 4 by 4 matrix that corresponds to the RealityServer type Float64<4,4>. | |
|
MeasureInputMethod |
com.mi.rs.multiview.input_method | Class used to create measure widgets in perspective views. | |
|
MeasureOrthoInputMethod |
com.mi.rs.multiview.input_method | Used to create measure widgets in orthographic views. | |
|
MeasureWidget3d |
com.mi.rs.multiview.widgets | Provides functionality for perspective measure widgets. | |
|
MeasureWidgetBase |
com.mi.rs.multiview.widgets | Provides core functionality to measure widgets. | |
|
MeasureWidgetOrtho |
com.mi.rs.multiview.widgets | Provides base functionality to create an orthographic measure widget. | |
|
NavCamera |
com.mi.rs.multiview.core | The NavCamera class is an extension of the simple container RSCamera. | |
|
OptionArray |
com.mi.rs.multiview.option | Elements of an OptionArray instance can be referred by their index and by their name if they were given one. | |
|
OptionSet |
com.mi.rs.multiview.option | A collection of String key/value pairs, setting and getting values on itself and its child IOptionSet instances if any. | |
|
OptionSetCamera |
com.mi.rs.multiview.option | Option set with a helper interface used to store camera values. | |
|
OptionSetMatrix |
com.mi.rs.multiview.option | Option set with a helper interface used to store 4x4 matrix values. | |
|
OptionSetVector |
com.mi.rs.multiview.option | Represents a 4-element vector as an OptionSet instance. | |
|
OptionValidator |
com.mi.rs.multiview.option | Provides basic validation for built-in types. | |
|
OrbitInputMethod |
com.mi.rs.multiview.input_method | Enables orbit camera navigation in a view. | |
|
PanInputMethod |
com.mi.rs.multiview.input_method | Enables sideways and up and down camera navigation in a view. | |
|
RenderCommand |
com.mi.rs | Implementation of the IRenderCommand interface that renders images using the "render" RealityServer command. | |
|
RendererOptions |
com.mi.rs.multiview.option | Provides options related directly to a view. | |
|
RendererOptionsAlias |
com.mi.rs.multiview.option | Acts as an alias to another RendererOptions instance. | |
|
Response |
com.mi.rs | The object passed to command response handlers. | |
|
RSCamera |
com.mi.rs.multiview.utils | Represents a RealityServer camera and world-to-object matrix on the client. | |
|
RSService |
com.mi.rs | The main client library class that takes care of RealityServer command processing. | |
|
RSServiceEvent |
com.mi.rs | Event dispatched by RSService. | |
|
RSUtilityErrorEvent |
com.mi.rs.multiview.event | ||
|
RSVideo |
com.mi.rs.multiview.core | Simple UIComponent wrapper for the Video object tailored to expose the features of a RealityServer RTMP video stream. | |
|
RTMPOptions |
com.mi.rs.multiview.option.rtmp | RTMPOptions is the base class for all RTMP related options. | |
|
SaveRenderOptions |
com.mi.rs.multiview.option | aveRenderOptions class inherits RendererOptions. | |
|
Scene |
com.mi.rs.multiview.core | Implementation of IScene. | |
|
SceneEvent |
com.mi.rs.multiview.event | SceneEvent events are only fired from an IScene instance and manage parts of the scene that are ready for use or data that has been loaded from the server. | |
|
SceneOptions |
com.mi.rs.multiview.option | The SceneOptions class is the top-level option set for values affecting rendering and navigation. | |
|
Scope |
com.mi.rs.multiview.scope | Helper scope manager. | |
|
ScreenVideoOptions |
com.mi.rs.multiview.option.rtmp | Specifies a list of supported video encoder parameters for the 'screen video' codec for the 'mental images screen sharing 1 (v1)' encoder. | |
|
StateData |
com.mi.rs | A basic implementation of the IStateData interface. | |
|
SuperNav |
com.mi.rs.multiview.input_method | Groups a number of interaction modes into a single interface. | |
|
TransformBase |
com.mi.rs.multiview.utils | Super class for transform classes. | |
|
TransformSimple |
com.mi.rs.multiview.utils | Simple implementation of TransformBase. | |
|
TransformTarget |
com.mi.rs.multiview.utils | Extends TransformBase to include a target point and an up direction making this class useful for targeted transforms such as a camera. | |
|
Vector4 |
com.mi.rs.types | ||
|
ViewBase |
com.mi.rs.multiview.core | Provides a viewport to the scene it is linked to. | |
|
ViewOptions |
com.mi.rs.multiview.option | Contains all the options relating to a view. | |
|
ViewUtils |
com.mi.rs.multiview.utils | Provides functionality to manipulate the camera of a view. | |
|
WalkInputMethod |
com.mi.rs.multiview.input_method | Enables various camera navigation modes. | |
|
Widget3d |
com.mi.rs.multiview.widgets | Embeds 3D widgets in a user interface component. | |
|
WidgetHandle3d |
com.mi.rs.multiview.widgets | Base class for widget handles. | |
|
WidgetHandleCircle3d |
com.mi.rs.multiview.widgets | Creates circle elements for a 3D widget. | |
|
WidgetProjection |
com.mi.rs.multiview.widgets | Provides functions to calculate the widget projection required to embed 3D widgets in 2D applications. | |
|
WidgetShape3d |
com.mi.rs.multiview.widgets | Creates shape elements used by 3D widgets. | |
|
WidgetShapeLines3d |
com.mi.rs.multiview.widgets | Creates shape elements for 3D widgets. | |
|
WidgetShapeMesh3d |
com.mi.rs.multiview.widgets | Creates mesh elements for 3D widgets. | |
|
ZoomInputMethod |
com.mi.rs.multiview.input_method | Offers a possibility to zoom in and out, which is valid for perspective and orthographic views. |