CIGI Host Control Role Parameters

Detailed Description

Collaboration diagram for CIGI Host Control Role Parameters:

Variables
constexpr const char *	makVre::CigiHostControlConfig::displayConfiguration = "displayConfiguration"
constexpr const char *	makVre::CigiHostControlConfig::framerateLimit = "framerateLimit"
constexpr const char *	makVre::CigiHostControlConfig::hostConfig = "hostConfig"
constexpr const char *	makVre::CigiHostControlConfig::hostSimAddress = "hostSimAddress"
constexpr const char *	makVre::CigiHostControlConfig::igAddress = "igAddress"
constexpr const char *	makVre::CigiHostControlConfig::maxFireFxDistance = "maxFireFxDistance"
constexpr const char *	makVre::CigiHostControlConfig::maxViewDistance = "maxViewDistance"

Variable Documentation

displayConfiguration

const char* makVre::CigiHostControlConfig::displayConfiguration = "displayConfiguration"

constexpr

Parameter Name	displayConfiguration
Parameter Description	Display configuration (.dcx) file path for defining view windows and parameters.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["cigiHostControl"] = { 
   ... 
   displayConfiguration = ""; 
   ... 
};

framerateLimit

const char* makVre::CigiHostControlConfig::framerateLimit = "framerateLimit"

constexpr

Parameter Name	framerateLimit
Parameter Description	Framerate limit for CIGI host communication (0.0 for no limit).
Parameter Type	double
Parameter Default	0.0
Required?	No

Example Role Config Usage:

["cigiHostControl"] = { 
   ... 
   framerateLimit = 0.0; 
   ... 
};

hostConfig

const char* makVre::CigiHostControlConfig::hostConfig = "hostConfig"

constexpr

Parameter Name	hostConfig
Parameter Description	Required host configuration file path for CIGI session parameters.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["cigiHostControl"] = { 
   ... 
   hostConfig = ""; 
   ... 
};

hostSimAddress

const char* makVre::CigiHostControlConfig::hostSimAddress = "hostSimAddress"

constexpr

Parameter Name	hostSimAddress
Parameter Description	Host simulation address for the target backend (optional).
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["cigiHostControl"] = { 
   ... 
   hostSimAddress = ""; 
   ... 
};

igAddress

const char* makVre::CigiHostControlConfig::igAddress = "igAddress"

constexpr

Parameter Name	igAddress
Parameter Description	Image generator address for CIGI communication (optional).
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["cigiHostControl"] = { 
   ... 
   igAddress = ""; 
   ... 
};

maxFireFxDistance

const char* makVre::CigiHostControlConfig::maxFireFxDistance = "maxFireFxDistance"

constexpr

Parameter Name	maxFireFxDistance
Parameter Description	Maximum distance for fire effects rendering in view definitions.
Parameter Type	float
Parameter Default	0.0
Required?	No

Example Role Config Usage:

["cigiHostControl"] = { 
   ... 
   maxFireFxDistance = 0.0; 
   ... 
};

maxViewDistance

const char* makVre::CigiHostControlConfig::maxViewDistance = "maxViewDistance"

constexpr

Parameter Name	maxViewDistance
Parameter Description	Maximum view distance for view definitions.
Parameter Type	float
Parameter Default	0.0
Required?	No

Example Role Config Usage:

["cigiHostControl"] = { 
   ... 
   maxViewDistance = 0.0; 
   ... 
};