App Launcher Component Role Parameters

Detailed Description

Collaboration diagram for App Launcher Component Role Parameters:

Variables
constexpr const char *	makVre::AppLauncherComponentConfig::application = "application"
constexpr const char *	makVre::AppLauncherComponentConfig::arguments = "arguments"
constexpr const char *	makVre::AppLauncherComponentConfig::height = "height"
constexpr const char *	makVre::AppLauncherComponentConfig::positionX = "positionX"
constexpr const char *	makVre::AppLauncherComponentConfig::positionY = "positionY"
constexpr const char *	makVre::AppLauncherComponentConfig::shutdownOnDisengage = "shutdownOnDisengage"
constexpr const char *	makVre::AppLauncherComponentConfig::vreBackOnTopDelay = "vreBackOnTopDelay"
constexpr const char *	makVre::AppLauncherComponentConfig::width = "width"
constexpr const char *	makVre::AppLauncherComponentConfig::windowTitle = "windowTitle"
constexpr const char *	makVre::AppLauncherComponentConfig::workingDirectory = "workingDirectory"

Variable Documentation

application

const char* makVre::AppLauncherComponentConfig::application = "application"

constexpr

Parameter Name	application
Parameter Description	Path to the application executable to launch when engaging in the role.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   application = ""; 
   ... 
};

arguments

const char* makVre::AppLauncherComponentConfig::arguments = "arguments"

constexpr

Parameter Name	arguments
Parameter Description	Command-line arguments to pass to the launched application.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   arguments = ""; 
   ... 
};

height

const char* makVre::AppLauncherComponentConfig::height = "height"

constexpr

Parameter Name	height
Parameter Description	Desired height in pixels for the launched application window.
Parameter Type	int
Parameter Default	768
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   height = 768; 
   ... 
};

positionX

const char* makVre::AppLauncherComponentConfig::positionX = "positionX"

constexpr

Parameter Name	positionX
Parameter Description	Desired X position in pixels for the launched application window.
Parameter Type	int
Parameter Default	100
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   positionX = 100; 
   ... 
};

positionY

const char* makVre::AppLauncherComponentConfig::positionY = "positionY"

constexpr

Parameter Name	positionY
Parameter Description	Desired Y position in pixels for the launched application window.
Parameter Type	int
Parameter Default	300
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   positionY = 300; 
   ... 
};

shutdownOnDisengage

const char* makVre::AppLauncherComponentConfig::shutdownOnDisengage = "shutdownOnDisengage"

constexpr

Parameter Name	shutdownOnDisengage
Parameter Description	Whether to terminate the launched application when disengaging from the role.
Parameter Type	bool
Parameter Default	true
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   shutdownOnDisengage = true; 
   ... 
};

vreBackOnTopDelay

const char* makVre::AppLauncherComponentConfig::vreBackOnTopDelay = "vreBackOnTopDelay"

constexpr

Parameter Name	vreBackOnTopDelay
Parameter Description	Delay in seconds before bringing the VR Engage window back to the foreground after launching the application.
Parameter Type	float
Parameter Default	8.0
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   vreBackOnTopDelay = 8.0; 
   ... 
};

width

const char* makVre::AppLauncherComponentConfig::width = "width"

constexpr

Parameter Name	width
Parameter Description	Desired width in pixels for the launched application window.
Parameter Type	int
Parameter Default	1024
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   width = 1024; 
   ... 
};

windowTitle

const char* makVre::AppLauncherComponentConfig::windowTitle = "windowTitle"

constexpr

Parameter Name	windowTitle
Parameter Description	Window title of the launched application used for finding and positioning the window.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   windowTitle = ""; 
   ... 
};

workingDirectory

const char* makVre::AppLauncherComponentConfig::workingDirectory = "workingDirectory"

constexpr

Parameter Name	workingDirectory
Parameter Description	Working directory for the launched application process.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["appLauncherComponent"] = { 
   ... 
   workingDirectory = ""; 
   ... 
};