| RenderArea Class |
Defines the rendering area for Open Inventor rendering.
Inheritance HierarchyNamespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 2024.2.2.0 (10.16.2.0)
SyntaxThe RenderArea type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddListener | Adds a OIV.RemoteViz.Rendering.RenderAreaListener to manage the renderArea. |
| CloseConnectionsAndDispose | Closes all connections of the renderArea and disposes it. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetConnection(String) | Gets an existing OIV.RemoteViz.Rendering.Connection to the renderArea. |
| GetConnection(UInt32) | Gets an existing OIV.RemoteViz.Rendering.Connection to the renderArea. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| RemoveAllListeners | Removes all RenderAreaListeners. |
| RemoveListener | Removes a OIV.RemoteViz.Rendering.RenderAreaListener. |
| Resize | Resizes the renderArea at a specific size. |
| SendMessage(IListByte) | Calls SendMessage(buffer, {}). |
| SendMessage(String) | Calls SendMessage(message, {}). |
| SendMessage(IListByte, IListConnection) | Sends a binary message to the renderArea connections. |
| SendMessage(String, IListConnection) | Sends a text message to the renderArea connections. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | FrameMessage | Sets the message which will be associate with the next rendered frames. |
| GLContext | Gets the OpenGL context associated with the renderArea. |
| Gpu | Gets the Graphics Processing Unit (GPU) used to render images. |
| Height | Gets the renderArea height. |
| Id | Gets the renderArea id. |
| IsDisposed | Gets the state of the OIV.RemoteViz.Rendering.RenderArea: alive or disposed. |
| NumConnections | Gets the number of connections (see OIV.RemoteViz.Rendering.Connection) that exist for this renderArea. |
| NumListeners | Gets the number of OIV.RemoteViz.Rendering.RenderAreaListener. |
| SceneManager | Gets the Open Inventor scene manager associated with the renderArea. |
| TouchManager | Gets the Open Inventor touch manager associated with the renderArea. |
| Width | Gets the renderArea width. |
RemarksImplement the class OIV.RemoteViz.Rendering.RenderAreaListener to receive OIV.RemoteViz.Rendering.RenderArea events.
When using OIV.RemoteViz.Rendering.ServiceSettings.RunModes.INVENTOR_SERVICE or OIV.RemoteViz.Rendering.ServiceSettings.RunModes.INVENTOR_APPLICATION service mode, this class provides access to the scene manager and the touch manager to modify the rendering.
A OIV.RemoteViz.Rendering.RenderArea object may be created automatically by RemoteViz or created explicitly by the application. When a client requests a connection (see RemoteVizRenderArea.connectTo()), it specifies a render area id. If a render area with that id does not exist, RemoteViz will create one and OIV.RemoteViz.Rendering.ServiceListener.OnPendingCreateRenderArea(System.String, System.UInt32@, System.UInt32@, OIV.RemoteViz.Rendering.RenderAreaHardware, OIV.RemoteViz.Rendering.Client, OIV.RemoteViz.Rendering.ConnectionParameters) will be called. If a render area with the requested id exists, RemoteViz will use that one and OIV.RemoteViz.Rendering.ServiceListener.OnPendingShareRenderArea(OIV.RemoteViz.Rendering.RenderArea, OIV.RemoteViz.Rendering.Client, OIV.RemoteViz.Rendering.ConnectionParameters) will be called. An application might want to explicitly create a render area, for example, to preload a default scene graph.
A OIV.RemoteViz.Rendering.RenderArea may have zero, one or multiple connections.
A OIV.RemoteViz.Rendering.RenderArea allows the application to send text or binary messages to the associated client. A JavaScript client will receive the message using a listener (see RemoteVizRenderArea.addServiceListener). Messages from a client are received using one of the OIV.RemoteViz.Rendering.RenderAreaListener.OnReceivedMessage(OIV.RemoteViz.Rendering.RenderArea, OIV.RemoteViz.Rendering.Connection, System.String) methods.
See Also