com.openinventor.remoteviz.clients.nodes

Class SoRemoteVizClient.ServiceMessageEventArg

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.clients.nodes.SoRemoteVizClient.ServiceMessageEventArg

All Implemented Interfaces:

SbEventArg

Enclosing class:

SoRemoteVizClient

public static class SoRemoteVizClient.ServiceMessageEventArg
extends Inventor
implements SbEventArg

Structure given when a ServiceMessage event is raised. Please refer to onServiceMessage event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoRemoteVizClient.ServiceMessageEventArg.States

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
ServiceMessageEventArg(SoRemoteVizClient source, SoRemoteVizClient.ServiceMessageEventArg.States state, SbVec2s renderAreaSize, java.lang.String details) Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDetails() Returns details of the event.
SbVec2s	getRenderAreaSize() Returns the renderArea size.
SoRemoteVizClient	getSource() Returns the SoRemoteVizClient node that triggered the event.
SoRemoteVizClient.ServiceMessageEventArg.States	getState() Returns the connection state with the service.
void	setValue(SoRemoteVizClient.ServiceMessageEventArg copyFrom)

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceMessageEventArg

public ServiceMessageEventArg(SoRemoteVizClient source,
                              SoRemoteVizClient.ServiceMessageEventArg.States state,
                              SbVec2s renderAreaSize,
                              java.lang.String details)

Default constructor.

Method Detail

getState

public SoRemoteVizClient.ServiceMessageEventArg.States getState()

Returns the connection state with the service.

setValue

public void setValue(SoRemoteVizClient.ServiceMessageEventArg copyFrom)

getSource

public SoRemoteVizClient getSource()

Returns the SoRemoteVizClient node that triggered the event.

Specified by:

getSource in interface SbEventArg

getRenderAreaSize

public SbVec2s getRenderAreaSize()

Returns the renderArea size.

getDetails

public java.lang.String getDetails()

Returns details of the event. If State is equal to DISCONNECTED: This parameter is the disconnected reason. It can take the following values "DISPOSED", "REFUSED", "KICKED", "LICENSE" and "NETWORKFAILURE". If State is equal to FINISH_BANDWIDTH_CALIBRATION: This parameter is the network bandwidth calibration value (in bit/s). Else if State is equal to FINISH_LATENCY_CALIBRATION: This parameter is the network latency calibration value (in ms). Else this parameter is empty.