SbConfig Class Reference

ScaleViz Stores the configuration of the display system and the MultiPipe extension. More...

#include <Inventor/MP/Xt/SbConfig.h>

List of all members.

Public Member Functions

 SbConfig ()
 ~SbConfig ()
char * getConfigFile (void)
void setConfigFile (char *fileName)
int readConfigFile (void)
SoSeparatorgetConfigTree (void)
int getNbPipes (void)
SbPipegetPipe (int pipeID)
SbPipegetPipe (SbPipe::mpView view)
SbPipegetPipe (Window win)
SbPipegetPipe (SoWidget glw)
SbPipegetPipe (Display *dpy)
int getIndex (SbPipe *pipe)
void printInfo (void)
void setAppName (char *appName)
void xtRealize (void)
void computeVirtualSize (void)
SbVec2s getVirtualSize (void)
SbVec2s getVirtualCoordinates (SbVec2s mouseCoord, SbPipe *pipe)
void setEventPipe (SbPipe *pipe)
int isEventFromPipe (void)
SbBox3f computeSubViewVolume (int pipeID)
GLXContext getSharedContext (void)
void setSharedContext (GLXContext ctx)
SbBool isPerPipeStereo (void)
void setPerPipeStereo (SbBool trueOrFalse)
SbBool isSequentialRendering (void)
void setSequentialRendering (SbBool trueOrFalse)
SbBool isInsideOut (void)
void setInsideOut (SbBool trueOrFalse)
SoTrackerReadergetTrackerReader (void)
SoControllerReadergetControllerReader (void)
SbVec3f getDefaultCameraPosition (void)
SbVec3f getDefaultObjectPosition (void)
float getObjectMaxDim (void)
float getInterEyeDistance (void)
void setInterEyeDistance (float value)
int getWandTrackerId (void)
int getHeadTrackerId (void)
void setWandTrackerId (int value)
void setHeadTrackerId (int value)
SbBool isHeadTracking (void)
void setHeadTracking (int value)
void getWandFile (SbString &str)
void setWandFile (SbString wandiv)

Deprecated



SoDEPRECATED GLXContext getOverlaySharedContext (void)
SoDEPRECATED void setOverlaySharedContext (GLXContext ctx)
SoDEPRECATED void setOverlayColormap (int startIndex, int num, XColor *xcol)

Detailed Description

ScaleViz Stores the configuration of the display system and the MultiPipe extension.

NOTE: This class does not exist in Open Inventor 10.0 and later.

Each MPGLWidget creates an SbConfig. SbConfig reads the MultiPipe configuration file and stores all the information about the physical configuration of the display system: window information, tracking information, and behavioral information.

MultiPipe 2.0 uses a new configuration file format based on the Open Inventor file format. The nodes used in MultiPipe configuration file are: SoFlatScreen, SoScreen, SoTracker, and SoMPConfig.

Here is a sample configuration file that defines left and right "screens" with a small amount of overlap.

   #Inventor V2.1 ascii
       
       Separator {
       
       SoFlatScreen {
          name "LEFT"
          display "0.1"
          view LEFT
          rightOverlap 0.01
       }
       SoFlatScreen {
          name "RIGHT"
          display "0.0"
          view RIGHT
          leftOverlap -0.01
       }
       }

SEE ALSO

SoFlatScreen, SoMPConfig, SoScreen, SoTracker


Constructor & Destructor Documentation

SbConfig::SbConfig (  ) 

Constructor.

SbConfig::~SbConfig (  ) 

Destructor.


Member Function Documentation

SbBox3f SbConfig::computeSubViewVolume ( int  pipeID  ) 

Computes how to narrow the view volume.

void SbConfig::computeVirtualSize ( void   ) 

Computes the size of the virtual display.

char* SbConfig::getConfigFile ( void   ) 

Returns the name of the MultiPipe configuration file.

SoSeparator* SbConfig::getConfigTree ( void   ) 

Gets the scene graph describing the MultiPipe configuration.

SoControllerReader* SbConfig::getControllerReader ( void   ) 

Returns controller reader object specified in the configuration file.

SbVec3f SbConfig::getDefaultCameraPosition ( void   )  [inline]

Returns the default camera position.

This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

SbVec3f SbConfig::getDefaultObjectPosition ( void   )  [inline]

Returns the default object position.

This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

int SbConfig::getHeadTrackerId ( void   )  [inline]

Returns the identifier used to track the head.

This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

int SbConfig::getIndex ( SbPipe pipe  ) 

Gets the index of a pipe.

float SbConfig::getInterEyeDistance ( void   )  [inline]

Returns the inter-eye distance.

This distance is used to offset the camera during stereo rendering. This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

int SbConfig::getNbPipes ( void   ) 

Gets the number of pipes (i.e., MultiPipe windows) used in the current configuration.

float SbConfig::getObjectMaxDim ( void   )  [inline]

Returns the radius of the sphere the model is scaled to during the initialization process.

This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

SoDEPRECATED GLXContext SbConfig::getOverlaySharedContext ( void   ) 

Returns the overlay shared context.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
SbPipe* SbConfig::getPipe ( Display dpy  ) 

Returns the first pipe in display.

SbPipe* SbConfig::getPipe ( SoWidget  glw  ) 

Gets the pipe object of specified widget.

SbPipe* SbConfig::getPipe ( Window  win  ) 

Gets the pipe object of specified window.

SbPipe* SbConfig::getPipe ( SbPipe::mpView  view  ) 

Gets the pipe object of specified view.

SbPipe* SbConfig::getPipe ( int  pipeID  ) 

Gets the pipe object of specified index.

GLXContext SbConfig::getSharedContext ( void   ) 

Returns the shared context.

SoTrackerReader* SbConfig::getTrackerReader ( void   ) 

Returns tracker reader object specified in the configuration file.

SbVec2s SbConfig::getVirtualCoordinates ( SbVec2s  mouseCoord,
SbPipe pipe 
)

Gets coordinates within the virtual display.

SbVec2s SbConfig::getVirtualSize ( void   ) 

Gets the size of the virtual display.

void SbConfig::getWandFile ( SbString str  ) 
int SbConfig::getWandTrackerId ( void   )  [inline]

Returns the identifier used to track the wand.

This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

int SbConfig::isEventFromPipe ( void   ) 

This function returns TRUE if the event being processed occurred in a MultiPipe window.

SbBool SbConfig::isHeadTracking ( void   ) 

Returns TRUE if headtracking is enabled, else returns FALSE.

SbBool SbConfig::isInsideOut ( void   ) 

Returns TRUE if insideOut mode is enabled.

SbBool SbConfig::isPerPipeStereo ( void   ) 

Returns TRUE if PerPipeStereo mode is enabled.

SbBool SbConfig::isSequentialRendering ( void   ) 

Returns TRUE if sequential rendering mode is enabled (no threads).

void SbConfig::printInfo ( void   ) 

Prints the configuration.

int SbConfig::readConfigFile ( void   ) 

Reads the configuration file.

void SbConfig::setAppName ( char *  appName  ) 

It's necessary to have the application name in order to open several displays with Xt.

void SbConfig::setConfigFile ( char *  fileName  ) 

Sets the name of the MultiPipe configuration file.

void SbConfig::setEventPipe ( SbPipe pipe  ) 

SbConfig is told where the XEvent happened (in which MultiPipe window) with setEventPipe.

This used to compute mouse coordinates in Flat Screen Mode.

void SbConfig::setHeadTrackerId ( int  value  )  [inline]

Sets the identifier used to track the head.

This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

void SbConfig::setHeadTracking ( int  value  ) 

Sets the sensor id that tracks the head.

Default value is 0. If value is -1, headtracking is disabled.

void SbConfig::setInsideOut ( SbBool  trueOrFalse  ) 

Sets InsideOut mode.

void SbConfig::setInterEyeDistance ( float  value  )  [inline]

Sets the inter-eye distance.

This distance is used to offset the camera during stereo rendering. This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

SoDEPRECATED void SbConfig::setOverlayColormap ( int  startIndex,
int  num,
XColor *  xcol 
)

Sets the overlay colormap that is shared by all MultiPipe windows.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
SoDEPRECATED void SbConfig::setOverlaySharedContext ( GLXContext  ctx  ) 

Sets the overlay shared context.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
void SbConfig::setPerPipeStereo ( SbBool  trueOrFalse  ) 

Sets PerPipeStereo mode.

void SbConfig::setSequentialRendering ( SbBool  trueOrFalse  ) 

Sets sequential rendering mode.

void SbConfig::setSharedContext ( GLXContext  ctx  ) 

Sets the shared context.

void SbConfig::setWandFile ( SbString  wandiv  ) 
void SbConfig::setWandTrackerId ( int  value  )  [inline]

Sets the identifier used to track the wand.

This parameter is initialized in the configuration file in the SoTracker node. MultiPipe immersive only.

void SbConfig::xtRealize ( void   ) 

Realize each MultiPipe window's Xt hierarchy.


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

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