VR-Engage  2.2
Loading...
Searching...
No Matches
Look Around Observer Updater Role Parameters

Detailed Description

Collaboration diagram for Look Around Observer Updater Role Parameters:

Variables

constexpr const char * LookAroundObserverUpdaterConfig::attachedLocationOffset = "attachedLocationOffset"
 
constexpr const char * LookAroundObserverUpdaterConfig::attachedOrientationOffset = "attachedOrientationOffset"
 
constexpr const char * LookAroundObserverUpdaterConfig::enableBinoculars = "enableBinoculars"
 
constexpr const char * LookAroundObserverUpdaterConfig::enableLookAround = "enableLookAround"
 
constexpr const char * LookAroundObserverUpdaterConfig::enableNVG = "enableNVG"
 
constexpr const char * LookAroundObserverUpdaterConfig::observerName = "observerName"
 
constexpr const char * LookAroundObserverUpdaterConfig::pitchRange = "pitchRange"
 
constexpr const char * LookAroundObserverUpdaterConfig::snapBackTimeJoystick = "snapBackTimeJoystick"
 
constexpr const char * LookAroundObserverUpdaterConfig::snapBackTimeMouse = "snapBackTimeMouse"
 
constexpr const char * LookAroundObserverUpdaterConfig::supplementalSavedViewData = "supplementalSavedViewData"
 
constexpr const char * LookAroundObserverUpdaterConfig::yawRange = "yawRange"
 

Variable Documentation

◆ attachedLocationOffset

const char* LookAroundObserverUpdaterConfig::attachedLocationOffset = "attachedLocationOffset"
constexpr
Parameter NameattachedLocationOffset
Parameter DescriptionPosition offset from the center point in meters for observer attachment.
Parameter TypeDtVector
Parameter Default"DtVector::zero()"
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
attachedLocationOffset = "DtVector::zero()";
...
};

◆ attachedOrientationOffset

const char* LookAroundObserverUpdaterConfig::attachedOrientationOffset = "attachedOrientationOffset"
constexpr
Parameter NameattachedOrientationOffset
Parameter DescriptionOrientation offset of the observer relative to the attached model.
Parameter TypeDtQuaternion
Parameter Default"DtQuaternion()"
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
attachedOrientationOffset = "DtQuaternion()";
...
};

◆ enableBinoculars

const char* LookAroundObserverUpdaterConfig::enableBinoculars = "enableBinoculars"
constexpr
Parameter NameenableBinoculars
Parameter DescriptionEnable binoculars functionality when using this updater.
Parameter Typebool
Parameter Defaultfalse
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
enableBinoculars = false;
...
};

◆ enableLookAround

const char* LookAroundObserverUpdaterConfig::enableLookAround = "enableLookAround"
constexpr
Parameter NameenableLookAround
Parameter DescriptionEnable freelook capability for observer movement.
Parameter Typebool
Parameter Defaultfalse
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
enableLookAround = false;
...
};

◆ enableNVG

const char* LookAroundObserverUpdaterConfig::enableNVG = "enableNVG"
constexpr
Parameter NameenableNVG
Parameter DescriptionEnable night vision goggles when using this updater.
Parameter Typebool
Parameter Defaultfalse
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
enableNVG = false;
...
};

◆ observerName

const char* LookAroundObserverUpdaterConfig::observerName = "observerName"
constexpr
Parameter NameobserverName
Parameter DescriptionName of the observer to use for view management.
Parameter Typestring
Parameter Default"Observer 1"
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
observerName = "Observer 1";
...
};

◆ pitchRange

const char* LookAroundObserverUpdaterConfig::pitchRange = "pitchRange"
constexpr
Parameter NamepitchRange
Parameter DescriptionTable defining min/max pitch angles in degrees for observer movement.
Parameter Typetable
Parameter Default""
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
pitchRange = "";
...
};

◆ snapBackTimeJoystick

const char* LookAroundObserverUpdaterConfig::snapBackTimeJoystick = "snapBackTimeJoystick"
constexpr
Parameter NamesnapBackTimeJoystick
Parameter DescriptionTime in seconds to snap back observer to initial viewpoint when using joystick.
Parameter Typedouble
Parameter Default0.1
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
snapBackTimeJoystick = 0.1;
...
};

◆ snapBackTimeMouse

const char* LookAroundObserverUpdaterConfig::snapBackTimeMouse = "snapBackTimeMouse"
constexpr
Parameter NamesnapBackTimeMouse
Parameter DescriptionTime in seconds to snap back observer to initial viewpoint when using mouse.
Parameter Typedouble
Parameter Default0.25
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
snapBackTimeMouse = 0.25;
...
};

◆ supplementalSavedViewData

const char* LookAroundObserverUpdaterConfig::supplementalSavedViewData = "supplementalSavedViewData"
constexpr
Parameter NamesupplementalSavedViewData
Parameter DescriptionAdditional configuration data for saved views with look-around settings.
Parameter Typetable
Parameter Default""
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
supplementalSavedViewData = "";
...
};

◆ yawRange

const char* LookAroundObserverUpdaterConfig::yawRange = "yawRange"
constexpr
Parameter NameyawRange
Parameter DescriptionTable defining min/max yaw angles in degrees for observer movement.
Parameter Typetable
Parameter Default""
Required?No

Example Role Config Usage:

["lookAroundObserverUpdater"] = {
...
yawRange = "";
...
};