com.openinventor.remoteviz.rendering

Class Service

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.Service

public class Service
extends Inventor

Defines the RemoteViz rendering service. This class uses the singleton pattern restricting its instantiation to a single unique object in the program (see instance). To use RemoteViz, the service has to be opened with the method "Open". The implementation of class ServiceListener enables you to manage the service events.

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

Method Summary

Modifier and Type	Method and Description
void	addListener(ServiceListener listener) Adds a ServiceListener.
boolean	close() Closes the rendering service.
void	createRenderArea(java.lang.String id, int width, int height, RenderAreaHardware renderAreaHardware) Creates a renderArea.
void	dispatch() This method has to be used with the ServiceSettings.INVENTOR_SERVICE and ServiceSettings.INDEPENDENT_SERVICE mode in a loop.
Client	getClient(int index) Gets a Client from index.
Client	getClient(java.lang.String id) Gets a Client from id.
int	getNumClients() Gets the number of clients.
int	getNumListeners() Gets the number of ServiceListener.
int	getNumRenderAreas() Gets the number of renderAreas.
RenderArea	getRenderArea(int index) Gets a RenderArea from index.
RenderArea	getRenderArea(java.lang.String id) Gets a RenderArea from id.
ServiceSettings	getSettings() Gets the settings of the service.
static Service	instance() Renderering service instance (Singleton)
boolean	isRunning() This method is used to know if the rendering service is running.
boolean	open(ServiceSettings instanceSettings) Opens the rendering service.
void	removeAllListeners() Removes all ServiceListeners.
void	removeListener(ServiceListener listener) Removes a ServiceListener.

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

Method Detail

open

public boolean open(ServiceSettings instanceSettings)

Opens the rendering service.

Parameters:

instanceSettings - : the settings of the instance. This object cannot be null and will be copied. See also:

Service.getSettings

Returns:

true if successful, otherwise returns false.

getClient

public Client getClient(int index)

Gets a Client from index. Range is [0..getNumClients - 1].

Parameters:

index - : index identifying the client

Returns:

the client object if the index exists, otherwise returns null.

close

public boolean close()

Closes the rendering service. If renderAreas still exist, this method will dispose them and close the rendering service.

Returns:

true if successful, otherwise returns false.

getNumClients

public int getNumClients()

Gets the number of clients.

Returns:

the number clients attached to the service.

getSettings

public ServiceSettings getSettings()

Gets the settings of the service.

Returns:

the service settings object

instance

public static Service instance()

Renderering service instance (Singleton)

Returns:

the service instance

dispatch

public void dispatch()

This method has to be used with the ServiceSettings.INVENTOR_SERVICE and ServiceSettings.INDEPENDENT_SERVICE mode in a loop. It processes all waiting RemoteViz events.

getClient

public Client getClient(java.lang.String id)

Gets a Client from id. Range is [0..getNumClients - 1].

Parameters:

id - : ID identifying the client

Returns:

the client object if the id exists, otherwise returns null.

getRenderArea

public RenderArea getRenderArea(int index)

Gets a RenderArea from index. Range is [0..getNumRenderAreas - 1].

Parameters:

index - : index identifying the renderArea

Returns:

the renderArea object if the index exists, otherwise returns null.

removeListener

public void removeListener(ServiceListener listener)

Removes a ServiceListener.

Parameters:

listener - : object that listens to the service events

getNumRenderAreas

public int getNumRenderAreas()

Gets the number of renderAreas.

Returns:

the renderArea number of the Instance.

addListener

public void addListener(ServiceListener listener)

Adds a ServiceListener.

Parameters:

listener - : object that listens to the service events

getRenderArea

public RenderArea getRenderArea(java.lang.String id)

Gets a RenderArea from id. Range is [0..getNumRenderAreas - 1].

Parameters:

id - : ID identifying the RenderArea

Returns:

the renderArea object if the id exists, otherwise returns null.

getNumListeners

public int getNumListeners()

Gets the number of ServiceListener.

Returns:

number of ServiceListener.

isRunning

public boolean isRunning()

This method is used to know if the rendering service is running.

Returns:

true if running; otherwise returns false.

removeAllListeners

public void removeAllListeners()

Removes all ServiceListeners.

createRenderArea

public void createRenderArea(java.lang.String id,
                             int width,
                             int height,
                             RenderAreaHardware renderAreaHardware)

Creates a renderArea.
This method is optional. The other way to create a renderArea is to return true to the callback ServiceListener.onPendingCreateRenderArea
If the renderArea already exists, the call will be ignored.

Parameters:

id - : ID identifying the RenderArea

width - : renderArea width

height - : renderArea height

renderAreaHardware - : renderArea hardware settings. This object will be copied.