{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"SDK_HyperealVRHeadset","type":"basic","slug":"sdk_hyperealvrheadset","excerpt":"","body":"## Overview\n\nThe HyperealVR Headset SDK script provides a bridge to the HyperealVR SDK.\n\n## Class Methods\n\n### ProcessUpdate/1\n\n  > `public override void ProcessUpdate(Dictionary<string, object> options)`\n\n * Parameters\n   * `Dictionary<string, object> options` - A dictionary of generic options that can be used to within the update.\n * Returns\n   * _none_\n\nThe ProcessUpdate method enables an SDK to run logic for every Unity Update\n\n### ProcessFixedUpdate/1\n\n  > `public override void ProcessFixedUpdate(Dictionary<string, object> options)`\n\n * Parameters\n   * `Dictionary<string, object> options` - A dictionary of generic options that can be used to within the fixed update.\n * Returns\n   * _none_\n\nThe ProcessFixedUpdate method enables an SDK to run logic for every Unity FixedUpdate\n\n### GetHeadset/0\n\n  > `public override Transform GetHeadset()`\n\n * Parameters\n   * _none_\n * Returns\n   * `Transform` - A transform of the object representing the headset in the scene.\n\nThe GetHeadset method returns the Transform of the object that is used to represent the headset in the scene.\n\n### GetHeadsetCamera/0\n\n  > `public override Transform GetHeadsetCamera()`\n\n * Parameters\n   * _none_\n * Returns\n   * `Transform` - A transform of the object holding the headset camera in the scene.\n\nThe GetHeadsetCamera method returns the Transform of the object that is used to hold the headset camera in the scene.\n\n### GetHeadsetType/0\n\n  > `public override string GetHeadsetType()`\n\n * Parameters\n   * _none_\n * Returns\n   * `string` - The string of the headset connected.\n\nThe GetHeadsetType method returns a string representing the type of headset connected.\n\n### GetHeadsetVelocity/0\n\n  > `public override Vector3 GetHeadsetVelocity()`\n\n * Parameters\n   * _none_\n * Returns\n   * `Vector3` - A Vector3 containing the current velocity of the headset.\n\nThe GetHeadsetVelocity method is used to determine the current velocity of the headset.\n\n### GetHeadsetAngularVelocity/0\n\n  > `public override Vector3 GetHeadsetAngularVelocity()`\n\n * Parameters\n   * _none_\n * Returns\n   * `Vector3` - A Vector3 containing the current angular velocity of the headset.\n\nThe GetHeadsetAngularVelocity method is used to determine the current angular velocity of the headset.\n\n### HeadsetFade/3\n\n  > `public override void HeadsetFade(Color color, float duration, bool fadeOverlay = false)`\n\n * Parameters\n   * `Color color` - The colour to fade to.\n   * `float duration` - The amount of time the fade should take to reach the given colour.\n   * `bool fadeOverlay` - Determines whether to use an overlay on the fade.\n * Returns\n   * _none_\n\nThe HeadsetFade method is used to apply a fade to the headset camera to progressively change the colour.\n\n### HasHeadsetFade/1\n\n  > `public override bool HasHeadsetFade(Transform obj)`\n\n * Parameters\n   * `Transform obj` - The Transform to check to see if a camera fade is available on.\n * Returns\n   * `bool` - Returns true if the headset has fade functionality on it.\n\nThe HasHeadsetFade method checks to see if the given game object (usually the camera) has the ability to fade the viewpoint.\n\n### AddHeadsetFade/1\n\n  > `public override void AddHeadsetFade(Transform camera)`\n\n * Parameters\n   * `Transform camera` - The Transform to with the camera on to add the fade functionality to.\n * Returns\n   * _none_\n\nThe AddHeadsetFade method attempts to add the fade functionality to the game object with the camera on it.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f8ae6fd653400031d94e2","project":"571fa55ca0acd42000af9545","version":{"version":"3.3.0","version_clean":"3.3.0","codename":"Mangalica","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"HyperealVR SDK","slug":"hyperealvr-sdk","order":22,"from_sync":false,"reference":false,"_id":"5b1f8aab9c683000032979e7","project":"571fa55ca0acd42000af9545","version":"5b1f8576c2505d00031254db","createdAt":"2018-06-12T08:56:11.280Z","__v":0},"user":"571fa519db52d01700f5cf3d","createdAt":"2018-06-12T08:57:10.872Z","githubsync":"","__v":0,"parentDoc":null}

Overview

Prefabs

Pointers

Pointer Renderers

Locomotion

Object Control Actions

Interactors

Interactables

Highlighters

Grab Attach Mechanics

Secondary Controller Grab Actions

Presence

UI

Controllables

Utilities

Base SDK

Fallback SDK

Simulator SDK

SteamVR SDK

OculusVR SDK

Daydream SDK

Ximmerse SDK

HyperealVR SDK

WindowsMR SDK

Unity SDK

SDK_HyperealVRHeadset

## Overview The HyperealVR Headset SDK script provides a bridge to the HyperealVR SDK. ## Class Methods ### ProcessUpdate/1 > `public override void ProcessUpdate(Dictionary<string, object> options)` * Parameters * `Dictionary<string, object> options` - A dictionary of generic options that can be used to within the update. * Returns * _none_ The ProcessUpdate method enables an SDK to run logic for every Unity Update ### ProcessFixedUpdate/1 > `public override void ProcessFixedUpdate(Dictionary<string, object> options)` * Parameters * `Dictionary<string, object> options` - A dictionary of generic options that can be used to within the fixed update. * Returns * _none_ The ProcessFixedUpdate method enables an SDK to run logic for every Unity FixedUpdate ### GetHeadset/0 > `public override Transform GetHeadset()` * Parameters * _none_ * Returns * `Transform` - A transform of the object representing the headset in the scene. The GetHeadset method returns the Transform of the object that is used to represent the headset in the scene. ### GetHeadsetCamera/0 > `public override Transform GetHeadsetCamera()` * Parameters * _none_ * Returns * `Transform` - A transform of the object holding the headset camera in the scene. The GetHeadsetCamera method returns the Transform of the object that is used to hold the headset camera in the scene. ### GetHeadsetType/0 > `public override string GetHeadsetType()` * Parameters * _none_ * Returns * `string` - The string of the headset connected. The GetHeadsetType method returns a string representing the type of headset connected. ### GetHeadsetVelocity/0 > `public override Vector3 GetHeadsetVelocity()` * Parameters * _none_ * Returns * `Vector3` - A Vector3 containing the current velocity of the headset. The GetHeadsetVelocity method is used to determine the current velocity of the headset. ### GetHeadsetAngularVelocity/0 > `public override Vector3 GetHeadsetAngularVelocity()` * Parameters * _none_ * Returns * `Vector3` - A Vector3 containing the current angular velocity of the headset. The GetHeadsetAngularVelocity method is used to determine the current angular velocity of the headset. ### HeadsetFade/3 > `public override void HeadsetFade(Color color, float duration, bool fadeOverlay = false)` * Parameters * `Color color` - The colour to fade to. * `float duration` - The amount of time the fade should take to reach the given colour. * `bool fadeOverlay` - Determines whether to use an overlay on the fade. * Returns * _none_ The HeadsetFade method is used to apply a fade to the headset camera to progressively change the colour. ### HasHeadsetFade/1 > `public override bool HasHeadsetFade(Transform obj)` * Parameters * `Transform obj` - The Transform to check to see if a camera fade is available on. * Returns * `bool` - Returns true if the headset has fade functionality on it. The HasHeadsetFade method checks to see if the given game object (usually the camera) has the ability to fade the viewpoint. ### AddHeadsetFade/1 > `public override void AddHeadsetFade(Transform camera)` * Parameters * `Transform camera` - The Transform to with the camera on to add the fade functionality to. * Returns * _none_ The AddHeadsetFade method attempts to add the fade functionality to the game object with the camera on it.