The initialization configuration for the makVrv::DtDe. More...

Inheritance diagram for makVrv::DtDeInitializer:

Classes
struct	DisplayConnection
Public Types
enum	DeMode { NoMode = 0, MasterMode = 1, SlaveMode = 2, DeMode_end }
enum	DeFeatures { Features_None = 0, Features_2D = 1, Features_3D = 2, Features_XR = Features_3D \| Features_2D, DeFeatures_end }
	Defines the features, features should be masked. More...
typedef std::vector< std::pair < std::string, DtConfiguration > >	DriverInstanceList
	A driver instance list is a list of pairs where the first parameter is the class name of the driver and the second parameter is the configuration.
typedef std::map< std::string, std::string >	AuthorizationCodeMap
	A map of authorization keys and their values.
typedef std::vector< std::pair < std::string, makArchives::DtObserverStateRecord > >	ObserverStateMap
	A map of observer names, to DtObserverStateRecords.
typedef std::map< std::string, DtBaseRecordHolder * >	DefaultRecordMap
	A map of default records.
typedef std::vector < DisplayConnection >	DisplayConnections
Public Member Functions
	DtDeInitializer (const std::string &name="")
	Constructor.
	DtDeInitializer (const DtDeInitializer &initializer)
	Copy Constructor.
DtDeInitializer &	operator= (const DtDeInitializer &initializer)
	Assignment Op.
virtual	~DtDeInitializer ()
	Destructor.
void	setFeatures (DeFeatures features)
	Set the features.
DeFeatures	features () const
	Get the current features.
bool	featureSupported (DeFeatures feature) const
	Check to see if a feature is supported.
void	setDriverConfiguration (const DtDriverConfiguration &)
	Set the driver configuration.
void	setGuiConfiguration (const DtGuiConfiguration &config)
	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	setDefaultDrivers (const DriverInstanceList &drivers)
	Set the driver instance list.
const DriverInstanceList &	defaultDrivers () const
	Get the default driver list.
void	setDeConfiguration (const DtDeConfiguration &config)
	Set the initial de configuration.
DtDeConfiguration &	deConfiguration ()
	Get the initial de configuration.
const DtDeConfiguration &	deConfiguration () 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 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 ObserverStateMap &osm)
	Set the ObserverStateMap. Used by DtInputDriver when creating observers.
const 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 DisplayConnections &	displayConnections () const
	Get the list of connections to make.
DisplayConnections &	displayConnections ()
void	setDisplayConnections (const 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.
template<typename RecordType >
bool	findDefaultSettingsRecord (const std::string &name, RecordType &record) 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 selecting a vertex actually selects its parent object.
bool	vertexSelectsParent () const
void	setDoubleBuffering (bool buffer)
	Set whether to double buffer the windows.
bool	doubleBuffer () const
void	setVSync (bool sync)
	Set whether to vsync the windows.
bool	vsync () const
void	setFixedFrameRate (unsigned int framesPerSecond)
	Set the number of frames per second to render.
unsigned int	fixedFrameRate () const
void	setPathConfiguration (const DtDePathConfiguration &pathConfig)
	Set the initial path configuration.
DtDePathConfiguration &	pathConfiguration ()
	Access the initial path configuration.
const DtDePathConfiguration &	pathConfiguration () const
	Access the initial path configuration.
void	setInitLibXml (bool enabled)
	Enable or disable initialization of libxml2 for multi-threading during display engine initialization.
bool	initLibXml () const
	Get status of initialization of libxml2 for multi-threading during display engine initialization.
void	setCheckForData (bool check)
	Set whether to check for the existence of data.
bool	checkForData () const
	Get whether to check for the existence of data.
Get the driver configuration.
const DtDriverConfiguration &	driverConfiguration () const
DtDriverConfiguration &	driverConfiguration ()
const DtGuiConfiguration &	guiConfiguration () const
DtGuiConfiguration &	guiConfiguration ()
Get the input driver configuration.
const DtInputDriverConfiguration &	inputDriverConfiguration () const
DtInputDriverConfiguration &	inputDriverConfiguration ()
Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);.
Protected Attributes
DtDriverConfiguration	myDriverConfiguration
DtGuiConfiguration	myGuiConfiguration
DtInputDriverConfiguration	myInputDriverConfiguration
std::string	myDisplayEngineName
DtDePathConfiguration	myPathConfiguration
DtDeConfiguration	myDeConfiguration
DeMode	myDeMode
DriverInstanceList	myDriverInstances
std::string	myCoordinateSystem
std::string	myCoordinateSystemParameters
int	myNotifyLevel
std::string	myLogFileName
bool	myAutoLoadDriversFlag
AuthorizationCodeMap	myAuthorizationCodeMap
	Note, this member should probably not be serialized.
std::vector< std::string >	myAutoStartDrivers
ObserverStateMap	myObserverStateMap
std::vector< std::string >	myMappingFilesToLoad
DisplayConnections	myDisplayConnections
std::string	myAutoLoadFile
bool	myFullScreenFlag
bool	myConstrainToTerrainFlag
bool	mySpeedScalingFlag
bool	myVertexSelectsParentFlag
bool	myDoubleBufferFlag
bool	myVSyncFlag
unsigned int	myFrameRate
bool	myInitLibXml
bool	myCheckForData
DefaultRecordMap	myDefaultRecords
DeFeatures	myFeatures

Detailed Description

The initialization configuration for the makVrv::DtDe.

Member Typedef Documentation

typedef std::vector<std::pair<std::string,DtConfiguration> > makVrv::DtDeInitializer::DriverInstanceList

A driver instance list is a list of pairs where the first parameter is the class name of the driver and the second parameter is the configuration.

typedef std::map<std::string, std::string> makVrv::DtDeInitializer::AuthorizationCodeMap

A map of authorization keys and their values.

Certain plug-ins check and validate their key and value before loading.

typedef std::vector<std::pair<std::string, makArchives::DtObserverStateRecord> > makVrv::DtDeInitializer::ObserverStateMap

A map of observer names, to DtObserverStateRecords.

typedef std::map<std::string,DtBaseRecordHolder*> makVrv::DtDeInitializer::DefaultRecordMap

A map of default records.

typedef std::vector<DisplayConnection> makVrv::DtDeInitializer::DisplayConnections

Member Enumeration Documentation

enum makVrv::DtDeInitializer::DeMode

Enumerator:

NoMode
MasterMode
SlaveMode
DeMode_end	Similar to the end iterator,. this enum is one past the end.

enum makVrv::DtDeInitializer::DeFeatures

Defines the features, features should be masked.

By default the DeInitializer only has 3D features.

Enumerator:

Features_None
Features_2D
Features_3D
Features_XR
DeFeatures_end

Constructor & Destructor Documentation

makVrv::DtDeInitializer::DtDeInitializer ( const std::string & name = "" )

Constructor.

Defaults to MasterMode.

makVrv::DtDeInitializer::DtDeInitializer ( const DtDeInitializer & initializer )

Copy Constructor.

virtual makVrv::DtDeInitializer::~DtDeInitializer ( ) [virtual]

Destructor.

Member Function Documentation

DtDeInitializer& makVrv::DtDeInitializer::operator= ( const DtDeInitializer & initializer )

Assignment Op.

void makVrv::DtDeInitializer::setFeatures ( DeFeatures features )

Set the features.

DeFeatures makVrv::DtDeInitializer::features ( ) const

Get the current features.

bool makVrv::DtDeInitializer::featureSupported ( DeFeatures feature ) const

Check to see if a feature is supported.

const DtDriverConfiguration& makVrv::DtDeInitializer::driverConfiguration ( ) const

DtDriverConfiguration& makVrv::DtDeInitializer::driverConfiguration ( )

void makVrv::DtDeInitializer::setDriverConfiguration ( const DtDriverConfiguration & )

Set the driver configuration.

const DtGuiConfiguration& makVrv::DtDeInitializer::guiConfiguration ( ) const

DtGuiConfiguration& makVrv::DtDeInitializer::guiConfiguration ( )

void makVrv::DtDeInitializer::setGuiConfiguration ( const DtGuiConfiguration & config )

Set the driver configuration.

const DtInputDriverConfiguration& makVrv::DtDeInitializer::inputDriverConfiguration ( ) const

DtInputDriverConfiguration& makVrv::DtDeInitializer::inputDriverConfiguration ( )

void makVrv::DtDeInitializer::setInputDriverConfiguration ( const DtInputDriverConfiguration & config )

Set the input driver configuration.

const std::string& makVrv::DtDeInitializer::displayName ( ) const

Returns the name of the active local display configuration.

void makVrv::DtDeInitializer::setDisplayEngineName ( const std::string & name )

Set the active local display engine configuration.

DtDeInitializer::DeMode makVrv::DtDeInitializer::deMode ( ) const

Return myDeMode;.

void makVrv::DtDeInitializer::setDeMode ( DtDeInitializer::DeMode mode )

Set myDeMode.

void makVrv::DtDeInitializer::setDefaultDrivers ( const DriverInstanceList & drivers )

Set the driver instance list.

const DriverInstanceList& makVrv::DtDeInitializer::defaultDrivers ( ) const

Get the default driver list.

void makVrv::DtDeInitializer::setDeConfiguration ( const DtDeConfiguration & config )

Set the initial de configuration.

DtDeConfiguration& makVrv::DtDeInitializer::deConfiguration ( )

Get the initial de configuration.

const DtDeConfiguration& makVrv::DtDeInitializer::deConfiguration ( ) const

Get the initial de configuration.

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

Set the coordinate system and parameters.

const std::string& makVrv::DtDeInitializer::coordinateSystem ( ) const

Get the name of the coordinate system.

const std::string& makVrv::DtDeInitializer::coordinateSystemParameters ( ) const

Get the parameters of the coordinate system.

void makVrv::DtDeInitializer::setNotifyLevel ( DtDebugLog::PrintLevel level )

Set the initial notify level of print output.

DtDebugLog::PrintLevel makVrv::DtDeInitializer::notifyLevel ( ) const

Get the initial notify level of print output.

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

Set the log file name.

const std::string& makVrv::DtDeInitializer::logFileName ( ) const

Get the name of the output log.

void makVrv::DtDeInitializer::setAutoLoadDrivers ( bool autoLoad )

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

bool makVrv::DtDeInitializer::autoLoadDrivers ( ) const

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

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

Set the auto start drivers.

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

Get the auto start drivers.

void makVrv::DtDeInitializer::setAuthorizationCodeMap ( const AuthorizationCodeMap & map )

Assigns the authorization code mapping.

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

Adds an authorization code mapping.

void makVrv::DtDeInitializer::removeAuthorizationCodeMapping ( const std::string & key )

Removes an authorization code mapping.

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

Find an authorization code value from a key.

Returns NULL if key isn't found.

void makVrv::DtDeInitializer::setObserverStateMap ( const ObserverStateMap & osm )

Set the ObserverStateMap. Used by DtInputDriver when creating observers.

const ObserverStateMap& makVrv::DtDeInitializer::observerStateMap ( ) const

Get the ObserverStateMap. Used by DtInputDriver when creating observers.

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

Get the mapping files to load.

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

Set the mapping files to load.

const DisplayConnections& makVrv::DtDeInitializer::displayConnections ( ) const

Get the list of connections to make.

DisplayConnections& makVrv::DtDeInitializer::displayConnections ( )

void makVrv::DtDeInitializer::setDisplayConnections ( const DisplayConnections & displayConnections )

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

Set the file to automatically load.

const std::string& makVrv::DtDeInitializer::autoLoadFile ( ) const

Get the file to automatically load.

void makVrv::DtDeInitializer::setStartFullScreen ( bool )

Set whether the application should start up in fullscreen mode.

bool makVrv::DtDeInitializer::startFullScreen ( ) const

Get whether the application should start up in fullscreen mode.

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

Add a new record holder.

void makVrv::DtDeInitializer::removeDefaultSettingsRecord ( const std::string & record )

Remove a default record.

template<typename RecordType >

bool makVrv::DtDeInitializer::findDefaultSettingsRecord	(	const std::string &	name,
		RecordType &	record
	)		const `[inline]`

Find a settings default records.

References makVrv::DtRecordHolder< Record >::record().

Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults().

void makVrv::DtDeInitializer::setConstrainToTerrain ( bool constrain )

Set the observers to initially constrain to terrain.

bool makVrv::DtDeInitializer::constrainToTerrain ( ) const

void makVrv::DtDeInitializer::setSpeedScaling ( bool scale )

Set the observers to initially scale speed.

bool makVrv::DtDeInitializer::speedScaling ( ) const

void makVrv::DtDeInitializer::setVertexSelectsParent ( bool selectsParent )

Set whether selecting a vertex actually selects its parent object.

bool makVrv::DtDeInitializer::vertexSelectsParent ( ) const

void makVrv::DtDeInitializer::setDoubleBuffering ( bool buffer )

Set whether to double buffer the windows.

bool makVrv::DtDeInitializer::doubleBuffer ( ) const

void makVrv::DtDeInitializer::setVSync ( bool sync )

Set whether to vsync the windows.

bool makVrv::DtDeInitializer::vsync ( ) const

void makVrv::DtDeInitializer::setFixedFrameRate ( unsigned int framesPerSecond )

Set the number of frames per second to render.

If this is equal to zero than a variable framerate is used.

unsigned int makVrv::DtDeInitializer::fixedFrameRate ( ) const

void makVrv::DtDeInitializer::setPathConfiguration ( const DtDePathConfiguration & pathConfig )

Set the initial path configuration.

DtDePathConfiguration& makVrv::DtDeInitializer::pathConfiguration ( )

Access the initial path configuration.

const DtDePathConfiguration& makVrv::DtDeInitializer::pathConfiguration ( ) const

Access the initial path configuration.

void makVrv::DtDeInitializer::setInitLibXml ( bool enabled )

Enable or disable initialization of libxml2 for multi-threading during display engine initialization.

bool makVrv::DtDeInitializer::initLibXml ( ) const

Get status of initialization of libxml2 for multi-threading during display engine initialization.

void makVrv::DtDeInitializer::setCheckForData ( bool check )

Set whether to check for the existence of data.

bool makVrv::DtDeInitializer::checkForData ( ) const

Get whether to check for the existence of data.

template<class Archive >

void makVrv::DtDeInitializer::_serialize	(	Archive &	ar,
		const unsigned int	version
	)		`[inline, protected]`

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);.

Serialize this class.

Reimplemented from makVrv::DtConfiguration.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.