VGISConfig Struct Reference
[VGISConfiguration]

VGISConfig contains various configuration information for the interactive VGIS application. More...

List of all members.

Public Attributes

Configurable Data Members
These members can be set as part of a VGIS program's run-time configuration (see VGISConfiguration). Path Interpretation discusses path interpretation (e.g. Default Parent Dir).

char * inputDevicesDir
 This directory contains input device configuration files for the host computer.
char * interfacePath
 This path is a semi-colon separate list of directories contains interface configuration files.
char * navigationFile
 This is the name of the navigation configuration file .
int mouseButtons
 [Windows] This determines whether the navigation interface should use 2 or 3 buttons.
vgis_boolean_t enableScheduler
 [Windows] If there are fewer than 2 processors and this is true, then on NT 4.0 the special VGIS thread scheduler is enabled.
vgis_boolean_t enableWeather
 Determines whether weather visualization rendering is enabled.
vgis_boolean_t X11SupportsThreads
 On some platforms we can't get X11 working with threads.

Detailed Description

VGISConfig contains various configuration information for the interactive VGIS application.

The interactive VGIS application contains one instance of VGISConfig called _VGISConfig plus additional Config structures.

See VGISConfiguration for general instructions related to initializating a VGIS program's configuration structures. Path Interpretation discusses path interpretation (e.g. Default Parent Dir).

Warning:
Configuration information specific to single VGIS libraries belongs elsewhere-- in a xxx_config structure for that library (see CommonConfig,ter_config_t, etc.)
Todo:
Ideally VGISConfig should generally NOT be included or linked by ANY VGIS libraries, rather only the code in src/vgis/main. The libraries tshould have their own xxxx_config structure (see CommonCofig,ter_config_t, etc.) There are still a number of members in VGISConfig that need to be moved out of here and the include's and links to this file's .lib should be removed. Zachary Wartell did this for 90% of the data members and is delegating the rest to those responsible for the specific VGISConfig data members.When this is complete remove the above todo comment.

Member Data Documentation

vgis_boolean_t VGISConfig::enableScheduler
 

[Windows] If there are fewer than 2 processors and this is true, then on NT 4.0 the special VGIS thread scheduler is enabled.

Note currently, under Windows 2000 this scheduler kills performance. So under Windows 2000 this flag will actually be turned off.

Initialize Options:

  • Default: TRUE
  • Config File: YES
  • Command Line: (-enableScheduler | -es ) <TRUE | FALSE>

Todo:
delete/deprecate this as soon as we finish move to POSIX thread API

vgis_boolean_t VGISConfig::enableWeather
 

Determines whether weather visualization rendering is enabled.

Initialize Options:

  • Default: FALSE
  • Config File: YES
  • Command Line: (-enableWeather | -ew ) <TRUE | FALSE>

Todo:
move this into volume.lib configuration

char* VGISConfig::inputDevicesDir
 

This directory contains input device configuration files for the host computer.

Initialize Options:

Default Parent Dir*: VGISConfig::systemDir

char* VGISConfig::interfacePath
 

This path is a semi-colon separate list of directories contains interface configuration files.

Interface configuration files are searched for in each directory in this path. The order in which the directories are listed determines the order in which they are searched. When searching for an interface configuration file, the file is loaded from the first directory containing the file.

Initialize Options:

  • Config File: YES
  • Command Line: (-interfacePath | -ip) <DirNames>

Default Parent Dir: CommonConfig::userDir

int VGISConfig::mouseButtons
 

[Windows] This determines whether the navigation interface should use 2 or 3 buttons.

Initialize Options:

  • Default: 3
  • Config File: YES
  • Command Line: (-mouseButton | -mb ) <integer>

char* VGISConfig::navigationFile
 

This is the name of the navigation configuration file .

Initialize Options:

  • Default: first file named "vgis.nav" found in VGISConfig::interfacePath
  • Command Line: (-navigationFile | -nf) <FileName>
  • Config File: YES

Default Parent Dir: first directory in VGISConfig::interfacePath containing the file.

vgis_boolean_t VGISConfig::X11SupportsThreads
 

On some platforms we can't get X11 working with threads.

Therefore we need this run-time check to disable various bits of code that require it.

  • Default: determined at run-time from X11 library.

The documentation for this struct was generated from the following file:
Generated by doxygen written by Dimitri van Heesch, © 1997-2001