VR-Forces 4.0.4 Class Documentation
Classes | Public Member Functions | Protected Attributes
makVrv::DtVrvApplicationConfiguration Class Reference

This owns a list of display engine configurations. More...

Inheritance diagram for makVrv::DtVrvApplicationConfiguration:
Inheritance graph
[legend]

List of all members.

Classes

struct  UIConfiguration

Public Member Functions

 DtVrvApplicationConfiguration ()
 CTOR.
 DtVrvApplicationConfiguration (const DtVrvApplicationConfiguration &)
 Copy CTOR.
DtVrvApplicationConfigurationoperator= (const DtVrvApplicationConfiguration &)
 Assignment Op.
virtual ~DtVrvApplicationConfiguration ()
 DTOR.
bool loadPlugins ()
 Do we load plugins.
void setLoadPlugins (bool enable)
 Set whether the IG loads plugins during initialization.
void addPluginFile (const std::string &file)
 Add a plug-in file not located in the plugin directory.
const std::list< std::string > & pluginFiles () const
 Get a list of additional plugin files.
void excludePluginFile (const std::string &file)
 Exclude a plug-in file, typically localed in the plugin directory.
const std::list< std::string > & excludedPluginFiles () const
 Get a list of plugins not to load.
const UIConfigurationmasterModeUIConfiguration () const
UIConfigurationmasterModeUIConfiguration ()
void setMasterModeMenuConfiguration (const DtMenuConfiguration &menuConfig)
const DtMenuConfigurationmasterModeMenuConfiguration () const
DtMenuConfigurationmasterModeMenuConfiguration ()
void setMasterModeToolbarConfiguration (const DtToolbarConfiguration &toolbarConfig)
const DtToolbarConfigurationmasterModeToolbarConfiguration () const
DtToolbarConfigurationmasterModeToolbarConfiguration ()
void setMasterModePageConfiguration (const DtPageConfiguration &pageConfig)
const DtPageConfigurationmasterModePageConfiguration () const
DtPageConfigurationmasterModePageConfiguration ()
const UIConfigurationslaveModeUIConfiguration () const
UIConfigurationslaveModeUIConfiguration ()
void setSlaveModeMenuConfiguration (const DtMenuConfiguration &menuConfig)
const DtMenuConfigurationslaveModeMenuConfiguration () const
DtMenuConfigurationslaveModeMenuConfiguration ()
void setSlaveModeToolbarConfiguration (const DtToolbarConfiguration &toolbarConfig)
const DtToolbarConfigurationslaveModeToolbarConfiguration () const
DtToolbarConfigurationslaveModeToolbarConfiguration ()
void setSlaveModePageConfiguration (const DtPageConfiguration &pageConfig)
const DtPageConfigurationslaveModePageConfiguration () const
DtPageConfigurationslaveModePageConfiguration ()
DtDeInitializer buildInitializer ()
 Generate a DtDeInitializer from the app config state.
void setDriverConfiguration (const DtDriverConfiguration &)
 Set the driver configuration.
void setGuiConfiguration (const DtGuiConfiguration &)
 Set the driver configuration.
void setInputDriverConfiguration (const DtInputDriverConfiguration &config)
 Set the input driver configuration.
const std::string & displayName () const
 Returns the name of the active local display configuration.
void setDisplayEngineName (const std::string &name)
 Set the active local display engine configuration.
DtDeInitializer::DeMode deMode () const
 Return myDeMode;.
void setDeMode (DtDeInitializer::DeMode mode)
 Set myDeMode.
void setDeFeatures (DtDeInitializer::DeFeatures features)
 Set the de feature flags.
void setDefaultDrivers (const DtDeInitializer::DriverInstanceList &drivers)
 Set the driver instance list.
const
DtDeInitializer::DriverInstanceList
defaultDrivers () const
 Get the default driver list.
void setDeConfiguration (const DtDeConfiguration &config)
 Set the initial de configuration.
DtDeConfigurationdeConfiguration ()
 Get the initial de configuration.
const DtDeConfigurationdeConfiguration () const
 Get the initial de configuration.
void setCoordinateSystem (const std::string &coordinateSystem, const std::string &parameters)
 Set the coordinate system and parameters.
const std::string & coordinateSystem () const
 Get the name of the coordinate system.
const std::string & coordinateSystemParameters () const
 Get the parameters of the coordinate system.
void setNotifyLevel (DtDebugLog::PrintLevel level)
 Set the initial notify level of print output.
DtDebugLog::PrintLevel notifyLevel () const
 Get the initial notify level of print output.
void setLogFileName (const std::string &filename)
 Set the log file name.
const std::string & logFileName () const
 Get the name of the output log.
void setAutoLoadDrivers (bool autoLoad)
 Set whether saved drivers in the driver directory should be automatically loaded.
bool autoLoadDrivers () const
 Get whether saved drivers in the driver directory should be automatically loaded.
void setAutoStartDrivers (const std::vector< std::string > &names)
 Set the auto start drivers.
const std::vector< std::string > & autoStartDrivers () const
 Get the auto start drivers.
void setAuthorizationCodeMap (const DtDeInitializer::AuthorizationCodeMap &map)
 Assigns the authorization code mapping.
void addAuthorizationCodeMapping (const std::string &key, const std::string &value)
 Adds an authorization code mapping.
void removeAuthorizationCodeMapping (const std::string &key)
 Removes an authorization code mapping.
const std::string * findAuthorizationCodeValue (const std::string &key) const
 Find an authorization code value from a key.
void setObserverStateMap (const DtDeInitializer::ObserverStateMap &osm)
 Set the ObserverStateMap. Used by DtInputDriver when creating observers.
const
DtDeInitializer::ObserverStateMap
observerStateMap () const
 Get the ObserverStateMap. Used by DtInputDriver when creating observers.
const std::vector< std::string > & mappingFilesToLoad () const
 Get the mapping files to load.
void setMappingFilesToLoad (const std::vector< std::string > &)
 Set the mapping files to load.
const
DtDeInitializer::DisplayConnections
displayConnections () const
 Get the list of connections to make.
DtDeInitializer::DisplayConnectionsdisplayConnections ()
void setDisplayConnections (const DtDeInitializer::DisplayConnections &displayConnections)
void setAutoLoadFile (const std::string &file)
 Set the file to automatically load.
const std::string & autoLoadFile () const
 Get the file to automatically load.
void setStartFullScreen (bool)
 Set whether the application should start up in fullscreen mode.
bool startFullScreen () const
 Get whether the application should start up in fullscreen mode.
void addDefaultSettingsRecord (const std::string &recordName, const DtBaseRecordHolder &record)
 Add a new record holder.
void removeDefaultSettingsRecord (const std::string &record)
 Remove a default record.
const DtBaseRecordHolderfindDefaultSettingsRecord (const std::string &name) const
 Find a settings default records.
void setConstrainToTerrain (bool constrain)
 Set the observers to initially constrain to terrain.
bool constrainToTerrain () const
void setSpeedScaling (bool scale)
 Set the observers to initially scale speed.
bool speedScaling () const
void setVertexSelectsParent (bool selectsParent)
 set whether vertex selection selects the vertex' parent
bool vertexSelectsParent () const
void setDoubleBuffering (bool buffer)
 Set whether to double buffer the windows.
bool doubleBuffer () const
void setNoVSync (bool sync)
 Set whether to vsync the windows.
bool noVSync () const
void setFrameRate (unsigned int framesPerSec)
 Set the fixed framerate of the windows.
unsigned int frameRate () const
void setPathConfiguration (const DtDePathConfiguration &pathConfig)
 Set the initial path configuration.
DtDePathConfigurationpathConfiguration ()
 Access the initial path configuration.
const DtDePathConfigurationpathConfiguration () const
 Access the initial path configuration.
virtual void setSupportEmail (const std::string &supportEmail)
 About box configuration.
virtual const std::string & supportEmail () const
virtual void setSupportPhoneNumber (const std::string &phoneNumber)
virtual const std::string & supportPhoneNumber () const
virtual void setSalesEmail (const std::string &email)
virtual const std::string & salesEmail () const
virtual void setAddressFirstLine (const std::string &address1)
virtual const std::string & addressFirstLine () const
virtual void setAddressSecondLine (const std::string &address2)
virtual const std::string & addressSecondLine () const
virtual void setAddressThirdLine (const std::string &address3)
virtual const std::string & addressThirdLine () const
virtual void setSlogan (const std::string &)
virtual const std::string & slogan () const
virtual void setWeblink (const std::string &link)
virtual const std::string & weblink () const
virtual void setSvnRevision (const std::string &rev)
virtual const std::string & svnRevision () const
virtual void setBuildDate (const std::string &date)
virtual const std::string & buildDate () const
virtual void setAboutBoxImage (const std::string &fname)
virtual const std::string & aboutBoxImage () const
virtual void setAdditionalCopyright (const std::string &copyRightString)
virtual const std::string & additionalCopyright () const
void setAssembleUserInterfaceComponents (bool flag)
 Set/Get whether the application creates all the registered user interface components for the IG instance's mode.
bool assembleUserInterfaceComponents () const
 Set/Get whether the application creates all the registered user interface components for the IG instance's mode.
void setApplicationName (const std::string &appName)
 Set/Get the application name.
const std::string & applicationName () const
 Set/Get the application name.
void setApplicationVersion (const std::string &v)
 Set/Get the application version (default 1.0).
const std::string & applicationVersion () const
 Set/Get the application version (default 1.0).
void setShowQuitDialogOnClose (bool show)
 Set/Get whether or not to show quit dialog when main last window is closed.
bool showQuitDialogOnClose () const
 Set/Get whether or not to show quit dialog when main last window is closed.
void setApplicationIcon (const std::string &appIcon)
 Set/Get the application icon.
const std::string & applicationIcon () const
 Set/Get the application icon.
const DtDriverConfigurationdriverConfiguration () const
 Get the driver configuration.
DtDriverConfigurationdriverConfiguration ()
 Get the driver configuration.
const DtGuiConfigurationguiConfiguration () const
 Get the driver configuration.
DtGuiConfigurationguiConfiguration ()
 Get the driver configuration.
const DtInputDriverConfigurationinputDriverConfiguration () const
 Get the input driver configuration.
DtInputDriverConfigurationinputDriverConfiguration ()
 Get the input driver configuration.

Protected Attributes

std::string myBuildDate
std::string myApplicationName
std::string myApplicationIcon
bool myLoadPluginsFlag
bool myLoadingIgUserInterfaceFlag
std::list< std::string > myPluginFiles
std::list< std::string > myExcludedPluginFiles
bool myShowQuitDialogOnClose
std::string myApplicationVersion
DtDriverConfiguration myDriverConfiguration
 To feed into a DtDeInitializer:
DtGuiConfiguration myGuiConfiguration
DtInputDriverConfiguration myInputDriverConfiguration
std::string myDisplayEngineName
DtDePathConfiguration myPathConfiguration
DtDeConfiguration myDeConfiguration
DtDeInitializer::DeMode myDeMode
DtDeInitializer::DriverInstanceList myDriverInstances
std::string myCoordinateSystem
std::string myCoordinateSystemParameters
int myNotifyLevel
std::string myLogFileName
bool myAutoLoadDriversFlag
DtDeInitializer::AuthorizationCodeMap myAuthorizationCodeMap
std::vector< std::string > myAutoStartDrivers
DtDeInitializer::ObserverStateMap myObserverStateMap
std::vector< std::string > myMappingFilesToLoad
DtDeInitializer::DisplayConnections myDisplayConnections
std::string myAutoLoadFile
bool myFullScreenFlag
bool myConstrainToTerrainFlag
bool mySpeedScalingFlag
bool myVertexSelectsParentFlag
bool myDoubleBufferFlag
bool myNoVSyncFlag
unsigned int myFrameRate
DtDeInitializer::DefaultRecordMap myDefaultRecords
DtDeInitializer::DeFeatures myFeatures
UIConfiguration myMasterModeUIConfiguration
UIConfiguration mySlaveModeUIConfiguration
std::string mySupportEmail
 About box strings.
std::string mySupportPhoneNumber
std::string mySalesEmail
std::string myAddressFirstLine
std::string myAddressSecondLine
std::string myAddressThirdLine
std::string mySlogan
std::string myWeblink
std::string mySvnRevision
std::string myAboutBoxImage
std::string myAdditionalCopyright

Detailed Description

This owns a list of display engine configurations.


Constructor & Destructor Documentation

CTOR.

Copy CTOR.

DTOR.


Member Function Documentation

DtVrvApplicationConfiguration& makVrv::DtVrvApplicationConfiguration::operator= ( const DtVrvApplicationConfiguration )

Assignment Op.

Do we load plugins.

Set whether the IG loads plugins during initialization.

void makVrv::DtVrvApplicationConfiguration::addPluginFile ( const std::string &  file)

Add a plug-in file not located in the plugin directory.

const std::list<std::string>& makVrv::DtVrvApplicationConfiguration::pluginFiles ( ) const

Get a list of additional plugin files.

Exclude a plug-in file, typically localed in the plugin directory.

const std::list<std::string>& makVrv::DtVrvApplicationConfiguration::excludedPluginFiles ( ) const

Get a list of plugins not to load.

Set/Get whether the application creates all the registered user interface components for the IG instance's mode.

Set/Get whether the application creates all the registered user interface components for the IG instance's mode.

void makVrv::DtVrvApplicationConfiguration::setApplicationName ( const std::string &  appName)

Set/Get the application name.

Set/Get the application name.

Set/Get the application version (default 1.0).

Set/Get the application version (default 1.0).

Set/Get whether or not to show quit dialog when main last window is closed.

Set/Get whether or not to show quit dialog when main last window is closed.

void makVrv::DtVrvApplicationConfiguration::setApplicationIcon ( const std::string &  appIcon)

Set/Get the application icon.

Set/Get the application icon.

Generate a DtDeInitializer from the app config state.

Get the driver configuration.

Get the driver configuration.

Set the driver configuration.

Get the driver configuration.

Get the driver configuration.

Set the driver configuration.

Get the input driver configuration.

Get the input driver configuration.

Set the input driver configuration.

Returns the name of the active local display configuration.

Set the active local display engine configuration.

Return myDeMode;.

Set myDeMode.

Set the de feature flags.

Set the driver instance list.

Get the default driver list.

Set the initial de configuration.

Get the initial de configuration.

Get the initial de configuration.

void makVrv::DtVrvApplicationConfiguration::setCoordinateSystem ( const std::string &  coordinateSystem,
const std::string &  parameters 
)

Set the coordinate system and parameters.

Get the name of the coordinate system.

Get the parameters of the coordinate system.

Set the initial notify level of print output.

Get the initial notify level of print output.

void makVrv::DtVrvApplicationConfiguration::setLogFileName ( const std::string &  filename)

Set the log file name.

Get the name of the output log.

Set whether saved drivers in the driver directory should be automatically loaded.

Get whether saved drivers in the driver directory should be automatically loaded.

void makVrv::DtVrvApplicationConfiguration::setAutoStartDrivers ( const std::vector< std::string > &  names)

Set the auto start drivers.

const std::vector<std::string>& makVrv::DtVrvApplicationConfiguration::autoStartDrivers ( ) const

Get the auto start drivers.

Assigns the authorization code mapping.

void makVrv::DtVrvApplicationConfiguration::addAuthorizationCodeMapping ( const std::string &  key,
const std::string &  value 
)

Adds an authorization code mapping.

Removes an authorization code mapping.

const std::string* makVrv::DtVrvApplicationConfiguration::findAuthorizationCodeValue ( const std::string &  key) const

Find an authorization code value from a key.

Returns NULL if key isn't found.

Set the ObserverStateMap. Used by DtInputDriver when creating observers.

Get the ObserverStateMap. Used by DtInputDriver when creating observers.

const std::vector<std::string>& makVrv::DtVrvApplicationConfiguration::mappingFilesToLoad ( ) const

Get the mapping files to load.

void makVrv::DtVrvApplicationConfiguration::setMappingFilesToLoad ( const std::vector< std::string > &  )

Set the mapping files to load.

Get the list of connections to make.

void makVrv::DtVrvApplicationConfiguration::setAutoLoadFile ( const std::string &  file)

Set the file to automatically load.

Get the file to automatically load.

Set whether the application should start up in fullscreen mode.

Get whether the application should start up in fullscreen mode.

void makVrv::DtVrvApplicationConfiguration::addDefaultSettingsRecord ( const std::string &  recordName,
const DtBaseRecordHolder record 
)

Add a new record holder.

Remove a default record.

Find a settings default records.

Set the observers to initially constrain to terrain.

Set the observers to initially scale speed.

set whether vertex selection selects the vertex' parent

Set whether to double buffer the windows.

Set whether to vsync the windows.

void makVrv::DtVrvApplicationConfiguration::setFrameRate ( unsigned int  framesPerSec)

Set the fixed framerate of the windows.

Set the initial path configuration.

Access the initial path configuration.

Access the initial path configuration.

virtual void makVrv::DtVrvApplicationConfiguration::setSupportEmail ( const std::string &  supportEmail) [virtual]

About box configuration.

virtual const std::string& makVrv::DtVrvApplicationConfiguration::supportEmail ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setSupportPhoneNumber ( const std::string &  phoneNumber) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::supportPhoneNumber ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setSalesEmail ( const std::string &  email) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::salesEmail ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setAddressFirstLine ( const std::string &  address1) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::addressFirstLine ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setAddressSecondLine ( const std::string &  address2) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::addressSecondLine ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setAddressThirdLine ( const std::string &  address3) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::addressThirdLine ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setSlogan ( const std::string &  ) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::slogan ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setWeblink ( const std::string &  link) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::weblink ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setSvnRevision ( const std::string &  rev) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::svnRevision ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setBuildDate ( const std::string &  date) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::buildDate ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setAboutBoxImage ( const std::string &  fname) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::aboutBoxImage ( ) const [virtual]
virtual void makVrv::DtVrvApplicationConfiguration::setAdditionalCopyright ( const std::string &  copyRightString) [virtual]
virtual const std::string& makVrv::DtVrvApplicationConfiguration::additionalCopyright ( ) const [virtual]

Member Data Documentation

std::list<std::string> makVrv::DtVrvApplicationConfiguration::myPluginFiles [protected]

To feed into a DtDeInitializer:

std::vector<std::string> makVrv::DtVrvApplicationConfiguration::myAutoStartDrivers [protected]

About box strings.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)