Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-04-11 06:32:09 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #15926 from ctrlaltdavid/DOC-115

Browse source 
DOC-115: Comfort mode JSDoc
This commit is contained in:
jennaingersoll 2019-07-22 10:46:11 -07:00 committed by GitHub
commit abe1ce288c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
interface/src/scripting/HMDScriptingInterface.h
View file

@ -66,6 +66,25 @@ class QScriptEngine;
* <code>false</code>.
* @property {Rect} playArea=0,0,0,0 - The size and position of the HMD play area in sensor coordinates. <em>Read-only.</em>
* @property {Vec3[]} sensorPositions=[]] - The positions of the VR system sensors in sensor coordinates. <em>Read-only.</em>
*
* @property {number} visionSqueezeRatioX=0.0 - The amount of vision squeeze for the x-axis when moving, range <code>0.0</code>
* &ndash; <code>1.0</code>.
* @property {number} visionSqueezeRatioY=0.0 - The amount of vision squeeze for the y-axis when moving, range <code>0.0</code>
* &ndash; <code>1.0</code>.
* @property {number} visionSqueezeTurningXFactor=0.51 - The additional amount of vision squeeze for the x-axis when turning,
* range <code>0.0</code> &ndash; <code>1.0</code>.
* @property {number} visionSqueezeTurningYFactor=0.36 - <em>Currently unused.</em>
* @property {number} visionSqueezeUnSqueezeDelay=0.2 - The delay in undoing the vision squeeze effect after motion stops, in
* seconds.
* @property {number} visionSqueezeUnSqueezeSpeed=3.0 - How quickly the vision squeeze effect fades, once
* <code>visionSqueezeUnSqueezeDelay</code> has passed.
* @property {number} visionSqueezeTransition=0.25 - How tightly vision is squeezed, range <code>0.01</code> &ndash;
* <code>0.7</code>.
* @property {number} visionSqueezePerEye=1 - <code>1</code> if each eye gets a tube to see through, <code>0</code> if the face
* gets a tube.
* @property {number} visionSqueezeGroundPlaneY=0.0 - Adjusts how far below the camera the vision squeeze grid is displayed at.
* @property {number} visionSqueezeSpotlightSize=6.0 - The diameter of the circle of vision squeeze grid that is illuminated
* around the camera.
*/
class HMDScriptingInterface : public AbstractHMDScriptingInterface, public Dependency {
Q_OBJECT