Package com.openinventor.remoteviz.rendering

Class RenderArea

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.remoteviz.rendering.RenderArea
public class RenderArea extends Inventor
Defines the rendering area for Open Inventor rendering. Implement the class RenderAreaListener to receive RenderArea events.

When using ServiceSettings.INVENTOR_SERVICE or ServiceSettings.INVENTOR_APPLICATION service mode, this class provides access to the scene manager and the touch manager to modify the rendering.

A 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 ServiceListener.onPendingCreateRenderArea() will be called. If a render area with the requested id exists, RemoteViz will use that one and ServiceListener.onPendingShareRenderArea() will be called. An application might want to explicitly create a render area, for example, to preload a default scene graph.

A RenderArea may have zero, one or multiple connections.

A 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 RenderAreaListener.onReceivedMessage() methods.

  • Method Details

    • sendMessage

      public boolean sendMessage(Collection<Byte> buffer)
      Calls sendMessage(buffer, new java.util.ArrayList<>()).

    • sendMessage

      public boolean sendMessage(String message)
      Calls sendMessage(message, new java.util.ArrayList<>()).

    • getConnection

      public Connection getConnection(String id)
      Gets an existing Connection to the renderArea.

      Parameters:
      id - : ID identifying the Connection

      Returns:
      the connection object if the id exists, otherwise returns null.

    • getGpu

      public String getGpu()
      Gets the Graphics Processing Unit (GPU) used to render images. GPU can be defined in ServiceListener.onPendingCreateRenderArea.
      Returns:
      gpu used to compute the render.

      See Also:

    • getConnection

      public Connection getConnection(int index)
      Gets an existing Connection to the renderArea.

      Parameters:
      index - : index identifying the Connection

      Returns:
      the connection object if the index exists, otherwise returns null.

    • setFrameMessage

      public void setFrameMessage(String message)
      Sets the message which will be associate with the next rendered frames. This message can be recovered on a EncodedFrame.
      See Also:

    • getHeight

      public int getHeight()
      Gets the renderArea height.

      Returns:
      the renderArea height

    • isDisposed

      public boolean isDisposed()
      Gets the state of the RenderArea: alive or disposed. RemoteViz does not keep a reference to the RenderArea object after the object is disposed. If the application kept a reference to the object, this method can be used to query its state.

      The state "disposed" will be set just after triggering the listener ServiceListener.onDisposingRenderArea.

      Returns:
      true if the renderArea is disposed or false if the renderArea is alive.

    • getId

      public String getId()
      Gets the renderArea id.

      Returns:
      the ID identifying the renderArea

    • getNumListeners

      public int getNumListeners()
      Gets the number of RenderAreaListener.

      Returns:
      number of RenderAreaListener.

    • sendMessage

      public boolean sendMessage(String message, Collection<Connection> excludedConnections)
      Sends a text message to the renderArea connections.

      Parameters:
      message - : the message to be sent to all connections of the renderArea

      excludedConnections - : an excluded connections array

      Returns:
      true if the message has been successfully sent to all connections, otherwise returns false.

    • closeConnectionsAndDispose

      public void closeConnectionsAndDispose()
      Closes all connections of the renderArea and disposes it. If connections are still open, this method will close them and dispose the renderArea. While executing this method, the listeners ServiceListener.onDisposingRenderArea and ServiceListener.onDisposedRenderArea will be triggered and a DISPOSED disconnect message will be sent to all clients of the renderArea. The listener RenderAreaListener.onClosedConnection will not be triggered after closing connections.

      See isDisposed().

    • getGLContext

      public SoGLContext getGLContext()
      Gets the OpenGL context associated with the renderArea. This object is created automatically by RemoteViz.

      In the ServiceSettings.INDEPENDENT_SERVICE mode, this method returns null.

      Returns:
      the OpenGL context

    • getWidth

      public int getWidth()
      Gets the renderArea width.

      Returns:
      the renderArea width

    • sendMessage

      public boolean sendMessage(Collection<Byte> buffer, Collection<Connection> excludedConnections)
      Sends a binary message to the renderArea connections.

      Parameters:
      buffer - : the binary buffer to be sent to all connections of the renderArea

      excludedConnections - : an excluded connections array

      Returns:
      true if the message has been successfully sent to all connections, otherwise returns false.

    • resize

      public void resize(int width, int height)
      Resizes the renderArea at a specific size. After resizing, a notification will be sent to all the renderArea clients. The minimum size is (128, 128) and the maximum size is (3840, 2160). If the size is inferior or superior to the limit, it will be adjusted automatically.
      Parameters:
      width - : new width of the renderArea

      height - : new height of the renderArea
      See Also:

    • getSceneManager

      public SoSceneManager getSceneManager()
      Gets the Open Inventor scene manager associated with the renderArea. This object is created automatically by RemoteViz.

      In the ServiceSettings.INDEPENDENT_SERVICE mode, this method returns null.

      Returns:
      the sceneManager

    • removeAllListeners

      public void removeAllListeners()
      Removes all RenderAreaListeners.

    • getNumConnections

      public int getNumConnections()
      Gets the number of connections (see Connection) that exist for this renderArea.

      Returns:
      the number of connections

    • addListener

      public void addListener(RenderAreaListener listener)
      Adds a RenderAreaListener to manage the renderArea.

      Parameters:
      listener - : object that listens to the renderArea events

    • getTouchManager

      public SoTouchManager getTouchManager()
      Gets the Open Inventor touch manager associated with the renderArea. This object is created automatically by RemoteViz.

      In the ServiceSettings.INDEPENDENT_SERVICE mode, this method returns null.

      Returns:
      the touchManager

    • removeListener

      public void removeListener(RenderAreaListener listener)
      Removes a RenderAreaListener.

      Parameters:
      listener - : object that listens to the renderArea events