com.openinventor.remoteviz.rendering

Class RenderAreaListener

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.RenderAreaListener

public class RenderAreaListener
extends Inventor

This class can be overridden by an application to receive notifications from a RenderArea.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
RenderAreaListener() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	onClosedConnection(RenderArea renderArea, java.lang.String connectionId, boolean aborted) Triggered when a client disconnects.
void	onInitializedConnection(RenderArea renderArea, Connection sender, FrameEncoders frameEncoders) Triggered when the connection and the frame encoders are initialized successfully.
boolean	onKeyDown(RenderArea renderArea, Connection sender, int x, int y, SoKeyboardEvent.Keys key) Triggered when a KeyDown event is received from the client.
boolean	onKeyUp(RenderArea renderArea, Connection sender, int x, int y, SoKeyboardEvent.Keys key) Triggered when a KeyUp event is received from the client.
boolean	onMouseDoubleClick(RenderArea renderArea, Connection sender, int x, int y, SoMouseButtonEvent.Buttons button) Triggered when a MouseDoubleClick event is received from the client.
boolean	onMouseDown(RenderArea renderArea, Connection sender, int x, int y, SoMouseButtonEvent.Buttons button) Triggered when a MouseDown event is received from the client.
boolean	onMouseEnter(RenderArea renderArea, Connection sender, int x, int y) Triggered when a MouseEnter event is received from the client.
boolean	onMouseLeave(RenderArea renderArea, Connection sender, int x, int y) Triggered when a MouseLeave event is received from the client.
boolean	onMouseMove(RenderArea renderArea, Connection sender, int x, int y) Triggered when a MouseMove event is received from the client.
boolean	onMouseUp(RenderArea renderArea, Connection sender, int x, int y, SoMouseButtonEvent.Buttons button) Triggered when a MouseUp event is received from the client.
boolean	onMouseWheel(RenderArea renderArea, Connection sender, int x, int y, int delta) Triggered when client wheel button is rotated.
void	onOpenedConnection(RenderArea renderArea, Connection connection, FrameEncoders frameEncoders) Triggered when a client connects.
void	onPostRender(RenderArea renderArea) Triggered when a rendering is done.
boolean[]	onPreRender(RenderArea renderArea, boolean clearWindow, boolean clearZbuffer) Triggered before a rendering is done.
void	onReceivedMessage(RenderArea renderArea, Connection sender, java.lang.String message) Triggered when a message is received from a client.
void	onRefusedEncoder(RenderArea renderArea, Connection sender, FrameEncoders encoders) Triggered when a frame encoder cannot be initialized.
boolean	onRequestedFrame(RenderArea renderArea, Connection sender, SbRasterImage rasterImage) Triggered when a new frame is requested by a connection.
void	onRequestedSize(RenderArea renderArea, Connection sender, int width, int height) Triggered when a client requests a new renderArea size.
void	onResize(RenderArea renderArea, int width, int height) Triggered when the renderArea is resized.
boolean	onTouchEnd(RenderArea renderArea, Connection sender, int id, int x, int y) Triggered when a TouchEnd event is received from the client.
boolean	onTouchMove(RenderArea renderArea, Connection sender, int id, int x, int y) Triggered when a TouchMove event is received from the client.
boolean	onTouchStart(RenderArea renderArea, Connection sender, int id, int x, int y) Triggered when a TouchStart event is received from the client.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RenderAreaListener

public RenderAreaListener()

Default constructor.

Method Detail

onMouseEnter

public boolean onMouseEnter(RenderArea renderArea,
                            Connection sender,
                            int x,
                            int y)

Triggered when a MouseEnter event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onMouseLeave

public boolean onMouseLeave(RenderArea renderArea,
                            Connection sender,
                            int x,
                            int y)

Triggered when a MouseLeave event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onMouseWheel

public boolean onMouseWheel(RenderArea renderArea,
                            Connection sender,
                            int x,
                            int y,
                            int delta)

Triggered when client wheel button is rotated.

Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

delta - : abstract value which indicates how far the wheel turned

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onMouseUp

public boolean onMouseUp(RenderArea renderArea,
                         Connection sender,
                         int x,
                         int y,
                         SoMouseButtonEvent.Buttons button)

Triggered when a MouseUp event is received from the client.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

button - : The button that was pressed when the mouse event was fired.

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onInitializedConnection

public void onInitializedConnection(RenderArea renderArea,
                                    Connection sender,
                                    FrameEncoders frameEncoders)

Triggered when the connection and the frame encoders are initialized successfully.

Parameters:

renderArea - : the RenderArea requested by the connection

sender - : the Connection

frameEncoders - : frame encoders that have been initialized by the connection

onMouseDown

public boolean onMouseDown(RenderArea renderArea,
                           Connection sender,
                           int x,
                           int y,
                           SoMouseButtonEvent.Buttons button)

Triggered when a MouseDown event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

button - : The button that was pressed when the mouse event was fired.

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onMouseMove

public boolean onMouseMove(RenderArea renderArea,
                           Connection sender,
                           int x,
                           int y)

Triggered when a MouseMove event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onMouseDoubleClick

public boolean onMouseDoubleClick(RenderArea renderArea,
                                  Connection sender,
                                  int x,
                                  int y,
                                  SoMouseButtonEvent.Buttons button)

Triggered when a MouseDoubleClick event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

button - : The button that was pressed when the mouse event was fired.

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onRequestedFrame

public boolean onRequestedFrame(RenderArea renderArea,
                                Connection sender,
                                SbRasterImage rasterImage)

Triggered when a new frame is requested by a connection. To send a new frame to the client, set the pixel buffer of the raster image using a buffer object. If the buffer object of the raster image is NULL, no frame will be sent to the client. This method only works when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
IMPORTANT: This callback is executed in a separate thread for each connection requesting a frame.

Parameters:

renderArea - : the RenderArea of the Connection

sender - : the connection that requests a new frame

rasterImage - : contains the RGB raster image to render.

isInteractive - : This value can be modified to indicate if an user interaction is in progress. Default value is true.
If true (interactive frame), the frame will be compressed with the interactive frame encoder and a quality adapted to the bandwidth setting.
If false (still frame), the frame will be compressed with the still frame encoder and the best available quality.

See Also:

ServiceSettings.setRunMode

onPreRender

public boolean[] onPreRender(RenderArea renderArea,
                             boolean clearWindow,
                             boolean clearZbuffer)

Triggered before a rendering is done.
Default behavior : do the rendering by returning true.
In the ServiceSettings.INDEPENDENT_SERVICE mode, this callback is never triggered.

Parameters:

renderArea - : the RenderArea that will perform the rendering.

clearWindow - : if true, this clears the graphics window before rendering

clearZbuffer - : if true, the z buffer will be cleared before rendering

Returns:

false to abort the rendering.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the rendering will be not aborted.

onTouchEnd

public boolean onTouchEnd(RenderArea renderArea,
                          Connection sender,
                          int id,
                          int x,
                          int y)

Triggered when a TouchEnd event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

id - : touch identifier

x - : horizontal coordinate

y - : vertical coordinate

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onPostRender

public void onPostRender(RenderArea renderArea)

Triggered when a rendering is done.
Default behavior : do nothing
In the ServiceSettings.INDEPENDENT_SERVICE mode, this callback is never triggered.

Parameters:

renderArea - : the RenderArea that performed the rendering.

onClosedConnection

public void onClosedConnection(RenderArea renderArea,
                               java.lang.String connectionId,
                               boolean aborted)

Triggered when a client disconnects.
Default behavior : dispose the renderArea if all the connections are closed.

Parameters:

renderArea - : the RenderArea

connectionId - : ID identifying the connection

aborted - : true if the network connection was closed unexpectedly by the client or has been lost.

onOpenedConnection

public void onOpenedConnection(RenderArea renderArea,
                               Connection connection,
                               FrameEncoders frameEncoders)

Triggered when a client connects.
If a frame encoder cannot be initialized, RenderAreaListener.onRefusedEncoder will be triggered. Otherwise, RenderAreaListener.onInitializedConnection will be triggered.

Parameters:

renderArea - : the RenderArea requested by the connection

connection - : the Connection

frameEncoders - : frame encoders for interactive and still frames
Supported couple of frame encoders (still/interactive): JPEG/JPEG, PNG/JPEG, H264_NVENC/H264_NVENC, H264_OPENH264/H264_OPENH264
Default behavior: PNG/JPEG.

onReceivedMessage

public void onReceivedMessage(RenderArea renderArea,
                              Connection sender,
                              java.lang.String message)

Triggered when a message is received from a client.
Default behavior : do nothing

Parameters:

renderArea - : the RenderArea requested by the connection

sender - : the Connection that receives the text message

message - : the received message sent by the client

onTouchMove

public boolean onTouchMove(RenderArea renderArea,
                           Connection sender,
                           int id,
                           int x,
                           int y)

Triggered when a TouchMove event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

id - : touch identifier

x - : horizontal coordinate

y - : vertical coordinate

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onKeyDown

public boolean onKeyDown(RenderArea renderArea,
                         Connection sender,
                         int x,
                         int y,
                         SoKeyboardEvent.Keys key)

Triggered when a KeyDown event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

key - : pressed key

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onRefusedEncoder

public void onRefusedEncoder(RenderArea renderArea,
                             Connection sender,
                             FrameEncoders encoders)

Triggered when a frame encoder cannot be initialized.
If this case occurs, set another frame encoder. The status of encoders explains the reason for refusal.
Default behavior: try to load others encoders automatically (fallback): H264_NVENC/H264_NVENC => H264_OPENH264/H264_OPENH264 => PNG/JPEG => JPEG/JPEG

Parameters:

renderArea - : the RenderArea of the Connection

sender - : the connection that requests frame encoders

encoders - : frame encoders refused by the connection

onKeyUp

public boolean onKeyUp(RenderArea renderArea,
                       Connection sender,
                       int x,
                       int y,
                       SoKeyboardEvent.Keys key)

Triggered when a KeyUp event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

x - : horizontal coordinate

y - : vertical coordinate

key - : released key

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onResize

public void onResize(RenderArea renderArea,
                     int width,
                     int height)

Triggered when the renderArea is resized. See RenderArea.resize(). Default behavior : Do nothing.

Parameters:

renderArea - : the resized RenderArea

width - : new width of the renderArea

height - : new height of the renderArea

onTouchStart

public boolean onTouchStart(RenderArea renderArea,
                            Connection sender,
                            int id,
                            int x,
                            int y)

Triggered when a TouchStart event is received from the client.
Default behavior : accept the event by returning true.

Parameters:

renderArea - : the RenderArea that will process the event

sender - : the connection that sent the event

id - : touch identifier

x - : horizontal coordinate

y - : vertical coordinate

Returns:

true to process the event, it will apply a SoHandleEventAction to the scene graph.
This return value does not have any influence when the ServiceSettings.INDEPENDENT_SERVICE mode is enabled.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the event will be processed.

onRequestedSize

public void onRequestedSize(RenderArea renderArea,
                            Connection sender,
                            int width,
                            int height)

Triggered when a client requests a new renderArea size. To resize the renderArea, call the method RenderArea.resize.
Default behavior : resize the renderArea to the requested size.

onResize, RenderArea.resize

Parameters:

renderArea - : the RenderArea of the Connection

sender - : the connection that made the size request

width - : requested width

height - : requested height