com.openinventor.scaleviz

Class SoScaleViz

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.scaleviz.SoScaleViz

public class SoScaleViz
extends Inventor

ScaleViz initialization. This class performs ScaleViz initialization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoScaleViz.CompositingTypes

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEPTH Deprecated. Use SoScaleViz.CompositingTypes.DEPTH instead.
static int	NONE Deprecated. Use SoScaleViz.CompositingTypes.NONE instead.
static int	TILE Deprecated. Use SoScaleViz.CompositingTypes.TILE instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
static boolean	addConfig(SoScaleVizConfig config) Adds a new configuration to ScaleViz.
static boolean	addConfigFromFile(java.lang.String filename) Adds a new configuration to ScaleViz.
static void	connect() Launches the connection process using the active configuration.
static void	disconnect() Disconnects from the cluster.
static java.lang.String	getCompactVersion() Returns a character string identifying the version of extension.
static java.lang.String	getCompilationDate() Returns the compilation date of the current version.
static SoScaleVizConfig	getConfiguration(int index) Returns the i-th configuration from the list of registered configurations.
static int	getConfigurationCount() Returns the number of registered configurations.
static int	getNumRenderUnits() Returns the number of render units currently running.
static java.lang.String	getProductName() Returns a character string identifying the name of the extension.
static SoScaleVizConfig	getSelectedConfiguration() Returns the currently selected configuration.
static java.lang.String	getVersion() Returns a character string identifying the version of extension ("major.minor.patch_number").
static SoScaleViz.CompositingTypes	isComposing() Returns the compositing type currently used (if any).
static boolean	isConnected() Returns true when ScaleViz is connected to the cluster.
static boolean	isLocalRedraw() Returns true if a redraw is done on the application side.
static boolean	isOiru() Returns true if running on part of an OIRU.
static boolean	isRemoteEnabled() Returns true if remote rendering is enabled (see OIV_REMOTE_ENABLE)
static boolean	isRunningCluster() Returns true if using ScaleViz cluster mode.
static boolean	isUsingVnc() Returns true if using a Vnc configuration.
static boolean	removeConfig(SoScaleVizConfig config) Removes configuration from ScaleViz.
static int	removeConfigFromFile(java.lang.String filename) Remove all configurations defined using the passed filename.
static boolean	setSelectedConfiguration() Specifies the ScaleViz configuration to launch at connection time.
static boolean	setSelectedConfiguration(SoScaleVizConfig config) Specifies the ScaleViz configuration to launch at connection time.

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

Field Detail

NONE

@Deprecated
public static final int NONE

Deprecated. Use SoScaleViz.CompositingTypes.NONE instead.

TILE

@Deprecated
public static final int TILE

Deprecated. Use SoScaleViz.CompositingTypes.TILE instead.

DEPTH

@Deprecated
public static final int DEPTH

Deprecated. Use SoScaleViz.CompositingTypes.DEPTH instead.

Method Detail

getCompilationDate

public static java.lang.String getCompilationDate()

Returns the compilation date of the current version.

connect

public static void connect()

Launches the connection process using the active configuration.

addConfigFromFile

public static boolean addConfigFromFile(java.lang.String filename)

Adds a new configuration to ScaleViz. Returns false if the configuration is not valid (e.g., if there are syntax errors).

getCompactVersion

public static java.lang.String getCompactVersion()

Returns a character string identifying the version of extension. ("major.minor").

getProductName

public static java.lang.String getProductName()

Returns a character string identifying the name of the extension.

isRemoteEnabled

public static boolean isRemoteEnabled()

Returns true if remote rendering is enabled (see OIV_REMOTE_ENABLE)

isConnected

public static boolean isConnected()

Returns true when ScaleViz is connected to the cluster.

disconnect

public static void disconnect()

Disconnects from the cluster.

getVersion

public static java.lang.String getVersion()

Returns a character string identifying the version of extension ("major.minor.patch_number").

getConfigurationCount

public static int getConfigurationCount()

Returns the number of registered configurations.

isOiru

public static boolean isOiru()

Returns true if running on part of an OIRU.

removeConfig

public static boolean removeConfig(SoScaleVizConfig config)

Removes configuration from ScaleViz. Returns true if the configuration has been successfully removed.

isRunningCluster

public static boolean isRunningCluster()

Returns true if using ScaleViz cluster mode.

getNumRenderUnits

public static int getNumRenderUnits()

Returns the number of render units currently running.

addConfig

public static boolean addConfig(SoScaleVizConfig config)

Adds a new configuration to ScaleViz. Returns false if the configuration is not valid (e.g., if there are syntax errors).

isLocalRedraw

public static boolean isLocalRedraw()

Returns true if a redraw is done on the application side.

setSelectedConfiguration

public static boolean setSelectedConfiguration()

Specifies the ScaleViz configuration to launch at connection time. Returns false if the specified configuration is not available or cannot be selected.

getSelectedConfiguration

public static SoScaleVizConfig getSelectedConfiguration()

Returns the currently selected configuration.

getConfiguration

public static SoScaleVizConfig getConfiguration(int index)

Returns the i-th configuration from the list of registered configurations.

isUsingVnc

public static boolean isUsingVnc()

Returns true if using a Vnc configuration.

removeConfigFromFile

public static int removeConfigFromFile(java.lang.String filename)

Remove all configurations defined using the passed filename. Returns the number of removed configurations.

isComposing

public static SoScaleViz.CompositingTypes isComposing()

Returns the compositing type currently used (if any).

setSelectedConfiguration

public static boolean setSelectedConfiguration(SoScaleVizConfig config)

Specifies the ScaleViz configuration to launch at connection time. Returns false if the specified configuration is not available or cannot be selected.