Unigine.Plugins.Oculus Class

#ifdef HAS_OCULUS
	// engine.oculus functions
#endif

Oculus Class

Enums

AXIS#

Name	Description
INDEX_TRIGGER = 0	Left and right finger trigger values, in the range 0.0 to 1.0f. A value of 1.0 means that the trigger is fully depressed.
HAND_TRIGGER = 1	Left and right hand trigger values, in the range 0.0 to 1.0f. Hand trigger is often used to grab items. A value of 1.0 means that the trigger is fully depressed.
THUMBSTICK = 2	Horizontal and vertical thumbstick axis values, in the range -1.0f to 1.0f. The API automatically applies the deadzone, so developers don’t need to handle it explicitly.
INDEX_TRIGGER_NO_DEADZONE = 3	Left and right finger trigger values, in the range 0.0 to 1.0f, without a deadzone. A value of 1.0 means that the trigger is fully depressed.
HAND_TRIGGER_NO_DEADZONE = 4	Left and right hand trigger values, in the range 0.0 to 1.0f, without a deadzone. Hand trigger is often used to grab items. A value of 1.0 means that the trigger is fully depressed.
THUMBSTICK_NO_DEADZONE = 5	Horizontal and vertical thumbstick axis values, in the range -1.0f to 1.0f, without a deadzone.

TOUCH#

Name	Description
A = 1	User is touching A button on the right controller.
B = 2	User is touching B button on the right controller.
RTHUMB = 4	User has a finger on the thumb stick of the right controller.
RTHUMB_REST = 8	User has a finger on the textured thumb rest of the right controller.
RINDEX_TRIGGER = 16	User is touching the index finger trigger on the right controller.
RINDEX_POINTING = 32	User's right index finger is pointing forward past the trigger.
RTHUMB_UP = 64	User's right thumb is up and away from buttons on the controller, a gesture that can be interpreted as right thumbs up.
X = 256	User is touching X button on the left controller.
Y = 512	User is touching Y button on the left controller.
LTHUMB = 1024	User has a finger on the thumb stick of the left controller.
LTHUMB_REST = 2048	User has a finger on the textured thumb rest of the left controller.
LINDEX_TRIGGER = 4096	User is touching the index finger trigger on the left controller.
LINDEX_POINTING = 8192	User's left index finger is pointing forward past the trigger.
LTHUMB_UP = 16384	User's left thumb is up and away from buttons on the controller, a gesture that can be interpreted as left thumbs up.

BUTTON#

Name	Description
A = 1	A button on the right Touch controller.
B = 2	B button on the right Touch controller.
RTHUMB = 4	Thumb stick button on the right Touch controller.
RSHOULDER = 8	Shoulder button on the right Touch controller.
X = 256	X button on the left Touch controller.
Y = 512	Y button on the left Touch controller.
LTHUMB = 1024	Thumb stick button on the left Touch controller.
LSHOULDER = 2048	Shoulder button on the left Touch controller.
UP = 65536	The Up button on the remote controller.
DOWN = 131072	The Down button on the remote controller.
LEFT = 262144	The Left button on the remote controller.
RIGHT = 524288	The Right button on the remote controller.
ENTER = 1048576	Enter button on the left Touch controller. This is equivalent to the Start button on the Xbox controller.
BACK = 2097152	The Back button on the remote controller.
VOLUP = 4194304	The Volup button on the remote controller.
VOLDOWN = 8388608	The Voldown button on the remote controller.
HOME = 16777216	The Home button on the remote controller.

DEVICE#

Name	Description
HMD = 0	Oculus head-mounted display.
CONTROLLER_LEFT = 1	Left controller.
CONTROLLER_RIGHT = 2	Right controller.

VIEWPORT#

Name	Description
BLACK_SCREEN = 0	No image (black screen).
MONO = 1	Mono image.
STEREO = 2	Stereo image (left and right eye).
STEREO_FINAL = 3	Stereoscopic spherical image.

Properties

float PositionScale#

Oculus.VIEWPORT ViewportMode#

bool Enabled#

bool IsVisible#

uint TrackingStatus#

quat LeveledTrackerRotation#

vec3 LeveledTrackerPosition#

quat TrackerRotation#

vec3 TrackerPosition#

vec3 HeadAngularAcceleration#

vec3 HeadLinearAcceleration#

vec3 HeadAngularVelocity#

vec3 HeadLinearVelocity#

quat HeadRotation#

vec3 HeadPosition#

string HmdSerialNumber#

int HmdHeight#

int HmdWidth#

int AvailableTrackingCaps#

int AvailableHmdCaps#

int DefaultTrackingCaps#

int DefaultHmdCaps#

float HmdTrackerZFar#

float HmdTrackerZNear#

float HmdTrackerVFov#

float HmdTrackerHFov#

int HmdFirmwareMinor#

int HmdFirmwareMajor#

int HmdProductID#

int HmdVendorID#

string HmdManufacturer#

string HmdProductName#

int HmdType#

string Version#

bool HeadPositionLock#

bool HeadRotationLock#

Members

---

vec2 GetControllerAxis ( Oculus.DEVICE device, Oculus.AXIS axis ) #

Returns the coordinates of the specified controller axis along the X and Y axes.

Arguments

• Oculus.DEVICE device - Device ID, one of the DEVICE variables.
• Oculus.AXIS axis - One of the AXIS variables.

Return value

X and Y in the range of [-1;1] ([0;1] for a trigger).

bool GetControllerButtonPressed ( Oculus.BUTTON button ) #

Returns the value indicating if the specified button is pressed.

Arguments

• Oculus.BUTTON button - A button, one of the BUTTON variables.

Return value

true if the button is pressed; otherwise - false.

bool GetControllerButtonTouched ( Oculus.TOUCH button ) #

Returns the value indicating if the specified button is touched.

Arguments

• Oculus.TOUCH button - A button, one of the TOUCH variables.

Return value

true if the button is touched; otherwise - false.

void SetControllerVibration ( Oculus.DEVICE device, ushort duration, float amplitude ) #

Sets the vibration of the given duration and amplitude.

Arguments

• Oculus.DEVICE device - Device ID, one of the DEVICE variables.
• ushort duration - Duration of the vibration.
• float amplitude - Amplitude of the vibration.

vec3 GetDeviceAngularVelocity ( Oculus.DEVICE device ) #

Returns a device angular velocity, in radians per second.

Arguments

• Oculus.DEVICE device - Device ID, one of the DEVICE variables.

Return value

Angular velocity.

bool IsDeviceConnected ( Oculus.DEVICE device ) #

Returns a value indicating if the device connected to the slot.

Arguments

• Oculus.DEVICE device - Device ID, one of the DEVICE variables.

Return value

true - connected; false - not connected.

mat4 GetDevicePose ( Oculus.DEVICE device ) #

Returns a single pose for a tracked device.

Arguments

• Oculus.DEVICE device - Device ID, one of the DEVICE variables.

Return value

Identity matrix.

vec3 GetDeviceVelocity ( Oculus.DEVICE device ) #

Returns a device velocity in tracker space, in meters per second.

Arguments

• Oculus.DEVICE device - Device ID, one of the DEVICE variables.

Return value

Velocity.

bool IsPoseValid ( Oculus.DEVICE device ) #

Returns a value indicating if the device pose is valid.

Arguments

• Oculus.DEVICE device - Device ID, one of the DEVICE variables.

Return value

true - valid; false - invalid.

vec4 GetHmdDefaultFov ( int num ) #

Returns the default optical field of view for the specified eye.

Arguments

• int num - Eye: 0 for the left eye, 1 for the right eye.

Return value

Default field of view.

vec4 GetHmdMaxFov ( int num ) #

Returns the maximum optical field of view that can be practically rendered for the specified eye.

Arguments

• int num - Eye: 0 for the left eye, 1 for the right eye.

Return value

Maximum field of view.

void ResetTracking ( ) #

Re-centers the sensor position and orientation: the (x,y,z) positional components and the yaw component of orientation. The roll and pitch components are always determined by gravity and cannot be redefined. See also ovr_RecenterTrackingOrigin method in the OVR_CAPI.h file reference.

vec4 GetEyeFov ( int num ) #

Returns the current field of view of the given eye.

Arguments

• int num - Eye: 0 for the left eye, 1 for the right eye.

Return value

Eye field of view.

vec3 GetEyePosition ( int num ) #

Returns the current position of the given eye. The returned value was already multiplied by the current world scale.

Arguments

• int num - Eye: 0 for the left eye, 1 for the right eye.

Return value

The eye position.

quat GetEyeRotation ( int num ) #

Returns the current orientation of the given eye.

Arguments

• int num - Eye: 0 for the left eye, 1 for the right eye.

Return value

The eye orientation.

vec3 GetHandPosition ( int num ) #

Returns the current position of the given hand. The returned value was already multiplied by the current world scale.

Arguments

• int num - Hand: 0 for the left hand, 1 for the right hand.

quat GetHandRotation ( int num ) #

Returns the current orientation of the given hand.

Arguments

• int num - Hand: 0 for the left hand, 1 for the right hand.

void Render ( Player player, ivec2 size, bool render_window ) #

Arguments

• Player player
• ivec2 size
• bool render_window