SoScaleViz Class Reference
[ScaleViz]

ScaleViz ScaleViz initialization More...

#include <ScaleViz/SoScaleViz.h>

List of all members.

Public Types

enum  CompositingType {
  NONE = 0,
  TILE = 1 << 0,
  DEPTH = 1 << 1
}
typedef void InitCallback (void)

Static Public Member Functions

static SbString getProductName ()
static const char * getVersion ()
static const char * getCompactVersion ()
static const char * getCompilationDate ()
static void init ()
static void finish ()
static bool isInitialized ()
static bool isUsingVnc ()
static CompositingType isComposing ()
static bool isRunningCluster ()
static bool isOiru ()
static int getNumRenderUnits ()
static bool isLocalRedraw ()
static bool addConfig (SoScaleVizConfig *config)
static SoNONUNICODE bool addConfigFromFile (const char *filename)
static bool addConfigFromFile (const SbString &filename)
static bool removeConfig (SoScaleVizConfig *config)
static int32_t removeConfigFromFile (const char *filename)
static bool setSelectedConfiguration (SoScaleVizConfig *config)
static bool setSelectedConfiguration (SbString &configName)
static SoScaleVizConfiggetSelectedConfiguration ()
static SoScaleVizConfiggetConfiguration (const int32_t index)
static int32_t getConfigurationCount ()
static void connect ()
static void disconnect ()
static bool isConnected ()
static bool isRemoteEnabled ()

Deprecated



static SoDEPRECATED bool isUsingDMX ()
static SoDEPRECATED void registerInit (SbString moduleName, InitCallback *initFunction)

Detailed Description

ScaleViz ScaleViz initialization

This class performs ScaleViz initialization.


Member Typedef Documentation

typedef void SoScaleViz::InitCallback(void)

Indicates which function is responsible for registering classes of the given module.


Member Enumeration Documentation

Enumerator:
NONE 
TILE 
DEPTH 

Member Function Documentation

static bool SoScaleViz::addConfig ( SoScaleVizConfig config  )  [static]

Adds a new configuration to ScaleViz.

Returns false if the configuration is not valid (e.g., if there are syntax errors).

static bool SoScaleViz::addConfigFromFile ( const SbString filename  )  [static]

Adds a new configuration to ScaleViz.

Returns false if the configuration is not valid (e.g., if there are syntax errors).

static SoNONUNICODE bool SoScaleViz::addConfigFromFile ( const char *  filename  )  [static]

Adds a new configuration to ScaleViz.

Returns false if the configuration is not valid (e.g., if there are syntax errors).

Non Unicode List:
This function should not be used in a Unicode application.
static void SoScaleViz::connect (  )  [static]

Launches the connection process using the active configuration.

static void SoScaleViz::disconnect (  )  [static]

Disconnects from the cluster.

static void SoScaleViz::finish (  )  [static]

Shuts down the ScaleViz module, which includes freeing any internal static memory that it allocated.

Finish methods must be called in the reverse order of the init method calls:

static const char* SoScaleViz::getCompactVersion (  )  [static]

Returns a character string identifying the version of extension.

("major.minor").

static const char* SoScaleViz::getCompilationDate (  )  [static]

Returns the compilation date of the current version.

static SoScaleVizConfig* SoScaleViz::getConfiguration ( const int32_t  index  )  [static]

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

static int32_t SoScaleViz::getConfigurationCount (  )  [static]

Returns the number of registered configurations.

static int SoScaleViz::getNumRenderUnits (  )  [static]

Returns the number of render units currently running.

static SbString SoScaleViz::getProductName (  )  [static]

Returns a character string identifying the name of the extension.

static SoScaleVizConfig* SoScaleViz::getSelectedConfiguration (  )  [static]

Returns the currently selected configuration.

static const char* SoScaleViz::getVersion (  )  [static]

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

static void SoScaleViz::init (  )  [static]

Initializes ScaleViz.

Initialization is handled automatically by Open Inventor. It is not necessary to call this method in a user application.

static CompositingType SoScaleViz::isComposing (  )  [static]

Returns the compositing type currently used (if any).

static bool SoScaleViz::isConnected (  )  [static]

Returns true when ScaleViz is connected to the cluster.

static bool SoScaleViz::isInitialized (  )  [static]

Returns TRUE if SoScaleViz::init has been called.

static bool SoScaleViz::isLocalRedraw (  )  [static]

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

static bool SoScaleViz::isOiru (  )  [static]

Returns TRUE if running on part of an OIRU.

static bool SoScaleViz::isRemoteEnabled (  )  [static]

Returns true if remote rendering is enabled (see OIV_REMOTE_ENABLE).

bool SoScaleViz::isRunningCluster (  )  [inline, static]

Returns TRUE if using ScaleViz cluster mode.

static SoDEPRECATED bool SoScaleViz::isUsingDMX (  )  [static]

Returns TRUE if using a DMX configuration.

Deprecated:

Deprecated since Open Inventor 8000
DMX is not supported anymore.
static bool SoScaleViz::isUsingVnc (  )  [static]

Returns TRUE if using a Vnc configuration.

static SoDEPRECATED void SoScaleViz::registerInit ( SbString  moduleName,
InitCallback initFunction 
) [static]

Indicates which function is responsible for registering classes of the given module.

Deprecated:

Deprecated since Open Inventor 8000
Not used anymore
static bool SoScaleViz::removeConfig ( SoScaleVizConfig config  )  [static]

Removes configuration from ScaleViz.

Returns true if the configuration has been successfully removed.

static int32_t SoScaleViz::removeConfigFromFile ( const char *  filename  )  [static]

Remove all configurations defined using the passed filename.

Returns the number of removed configurations.

static bool SoScaleViz::setSelectedConfiguration ( SbString configName  )  [static]

Specifies the ScaleViz configuration to launch at connection time.

Returns false if the specified configuration is not available or cannot be selected.

static bool SoScaleViz::setSelectedConfiguration ( SoScaleVizConfig config  )  [static]

Specifies the ScaleViz configuration to launch at connection time.

Returns false if the specified configuration is not available or cannot be selected.


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 22 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/