Version 3.2.0

3.2.0

Breaking Changes

The following commits introduce changes that break functionality if upgrading from version 3.1.0

• SDKManager
  • runtime SDK switching using SDK Setups (f544015)
• Interaction
  • leave usage when disabling InteractUse (60bd7b5)
  • update interact touch parameter to make sense (5fde9ab)

Bug Fixes

• ObjectFollow
  • runtime usage (again) (06b948b)
  • runtime usage (0b5d97b)
• SDK
  • allow setup at runtime (adc796e)
  • add null reference check (d3fa259)
  • support Utilities SDK version 1.12.0 (95c33ff)
  • prevent increasing haptics duration on Oculus Touch (d69d37f)
  • fix angular and velocity calculations (cb3c49f)
  • ensure simulator controllers are set up on scene change (2323c7b)
  • prevent null exception on simulator when switching scene (6c6d0e5)
  • provide grip axis for oculus touch on steamvr (f6264ad)
  • ensure object references are populated on enable (46c3939)
  • prevent crash when switching scene with simulator (32a589c)
  • provide alternative way of getting unknown assembly types (fa0849a)
  • prevent crash on sdk setup when actual headset is null (e6b92f4)
  • prevent crash using simulator prefab (fa6026e)
  • only add SteamVR_UpdatePoses for Unity 5.6 (43638c8)
  • ensure simulator returns correct transform for headset (20a5267)
  • remove erroneous parameter from boundary methods (77a667d)
  • ensure SteamVR boundary mesh is generated correctly (0c3b73e)
  • controller null reference exception (bb5ce86)
  • name based controller lookup (bb77e48)
  • ensure SteamVR works by default in Unity 5.6 (0b3b185)
  • ensure simulator returns valid play area vertices array (3fc07e6)
  • find inactive game objects and components (ff6885c)
  • SteamVR defines (3522e81)
  • SteamVR defines (eb96658)
• Pointer
  • prevent crash when closing steam menu (2b5280c)
  • provide default boundary data if none available (9c2f1ac)
  • ensure material change is done correctly (0676113)
  • reset destination hit info on activate (cf205d2)
  • trigger enter/exit events when controller not required (923c595)
  • defer controller setup to Update method (b744ade)
  • reduce BEAM_ADJUST_OFFSET distance in renderer (56b6354)
  • prevent null exception when pointer has no renderer (4e483f5)
  • ensure object interactor is set by global scale (ffa49fe)
• SDKSetup
  • changes because of auto populate not serializing (66af4fb)
• PlayerObject
  • update existing object type (2a584ec)
• RoomExtender
  • prevent error on drawing gizmo in editor (a5c7a1c)
• UpdatePrompt
  • prevent null path to version file (bad7ff9)
  • allow to move VRTK installation (e6fa7f6)
• EventSystem
  • screen space overlay desktop camera (again) (de12336)
  • screen space overlay desktop camera (613b711)
• setupWindow
  • increase window height (71d62bc)
• Internal
  • ensure tracked controller index is set correctly (e4e5b58)
• Examples
  • prevent spawning multiple arrows when holding bow (c14d36f)
  • remove auto populate from custom controller model scene (0dfa6b9)
• Climbing
  • reset body collision and false fall end triggers (a3c2ac0)
  • scaled throw from climb (357c427)
• ScreenFade
  • ensure alpha does not get locked at 1f (7c841b6)
  • ensure screen fade reaches full opacity (dcd6945)
• SharedMethods
  • standalone build errors (fd65298)
• DeviceFinder
  • headset type recognition (90fb497)
  • make sure to use correct headset transform (9731aa5)
• Presence
  • reduce GetComponent calls in body physics update (57e9451)
  • remove console warning in position rewind (df4ad1a)
  • prevent crashes when switching scenes with body physics (b94d453)
  • ensure position rewind does not go through walls (ebcd139)
  • ensure is moving isn't always toggled on in body phsyics (8add2f3)
  • prevent position rewind when body physics collisions off (08827b4)
  • apply new collision tracker to PlayArea for body physics (02005cd)
  • use lower precision on checking y position for falling (3073686)
  • set crouch rewind threshold to stop fall through floor (9e6f305)
• RoomExtender_PlayAreaGizmo
  • null play area (1dd32c6)
• ControllerEvents
  • prevent events emitting if object not active (1f8ab76)
• UICanvas
  • RectTransform in 5.5.2p2 and 5.6 (0aee3b2)
  • ghost in layout group (478ffbf)
  • unusable in Unity 5.6 (1d2b1ef)
• SDKManager
  • SDK Setup load/unload crashes on scene changes (f302adc)
  • SDK Setup unloading (841432c)
  • honour script enable states (cf48f33)
  • allow -vrmode none to load Simulator SDK Setup (04d49b7)
  • standalone build errors (35f7ead)
  • duplicated errors on SDK changes undo (98d8779)
  • ignore enabled state for symbol management (689fc7d)
  • undo and redo (b2c0fa8)
  • populate object references (47f4462)
  • handle scene reload (b0927ca)
  • move method to editor only (5d58cfe)
  • enable auto populate button at all times (dd4152d)
• TrackedController
  • ensure to set public index parameter (8d5e856)
• Controls
  • rebuild grabbable slider object to work with snapping (e10be5a)
  • prevent error in panel menu on disable (f0da6cd)
• Tooltips
  • make retry init variables public (28a8393)
  • force initialise tooltips when controller ready (b177373)
  • initialise tips when controller is enabled (f3d1ba3)
• DOCUMENTATION
  • provide missing text for empty returns (7ab57f4)
• AdaptiveQuality
  • index out of bounds when using Oculus Utilities (fc5b146)
• FPSViewer
  • ensure correct SDK camera is set as canvas camera (7c26a2a)
• Utilities
  • new vive keyword for headset discovery in device finder (90765ed)
  • prevent sdk change event unregistering on disable (ee141c0)
  • ensure sdk manager reference is gloabl for object alias (256e601)
  • prevent error with sdk object alias on destroy (96334dd)
  • allow for trigger colliders to be ignored by casts (93ff8dc)
  • ensure custom raycast doesn't force infinity length (b5c0d45)
• GETTING_STARTED.md
  • update oculus utilities download link (553db28)
• Shaders
  • prevent unity auto updating shader code (cc287dc)
• Locomotion
  • prevent current destination point being set to null (021e92c)
  • replace timeSinceLevelLoad to prevent stuck timer (3f4d2da)
  • prevent exception with missing player rewind (c690c32)
  • typo in destination point locked cursor game object (1b60bac)
  • ensure rewind on climb collision resets correctly (2c9a61c)
  • ensure snap to nearest floor is called with climbing (deec4eb)
  • move in place left controller only check (f5708a0)
  • emit dash teleport events at the correct time (98f6ef1)
  • remove teleport exclusions from example scene (fc51ae5)
  • ensure play area collider is found in children (e719f44)
  • support multiple terrains with teleport (a7ce7ff)
  • use correct axis check in touchpad control (1ebc2c9)
  • always force small blink on distance blink delay (98e52ac)
  • make SteamVR the default for the mesh teleport example (16f33e4)
  • ensure current destination point is reset to null (5841ec3)
  • prevent unexpected change in direction in MoveInPlace (cca33de)
  • allow terrain Y not to be 0 for teleporting to work (03630c4)
• SnapDropZone
  • allow multiple valid objects to hover at same time (1bbe2b4)
  • prevent enter zone event firing multiple times (f2869be)
  • force unsnap if snapped object leaves collider (20573ef)
  • do not require grabbed state on unhighlight (a202eed)
  • clean up on destroy of snapped object (3b707f9)
  • prevent default snap at edit time (fb896bc)
  • allow for child colliders to activate drop zone (0bce6c3)
  • prevent highlight turning off when set to always on (e765255)
• ControllerReference
  • prevent getting reference in OnEnable (9a98d09)
• Editor
  • ensure script icons use editor texture (420d844)
• Shader
  • prevent shader upgrade code error in Unity 5.6 (4ddc71b)
• OculusAvatar
  • only set up once (4f678f0)
  • define symbol (14b4196)
• Simulator
  • reset unwanted rotations in simulator rig prefab (0246fb4)
  • add simple neck model. (431d641)
  • missing headset fade implementations (bbf0a03)
  • support headset fading (2a12be0)
  • typo (85c3bec)
  • null headset in Editor (d344279)
  • render model null (5945921)
  • rebuild simulator prefab to work on Unity 5.4 (6df8af6)
  • fix view rotation jump when returning from editor (ef0a387)
• Haptics
  • ensure haptics cancel correctly when called again (3fe6e15)
• Logger
  • prevent custom logger being destroyed on awake (230f0ec)
  • usage when serialization runs (3d9e7bf)
  • saved to scene in Editor (a0256d9)
  • prevent crash on parameter mismatch (38c1c2f)
• Interaction
  • prevent secondary joint break causing force release (c43ea26)
  • reset collision state when clearing ignored colliders (17b012e)
  • prevent secondary grab when isGrabbable is false (059cb3e)
  • recognize touchpad axis movement on oculus touch (b213073)
  • prevent error when exiting after haptics (c6994c2)
  • ensure to wake rigidbody when removed from drop zone (90e829d)
  • ensure touch rigidbody settings are always applied (c133fe0)
  • ensure joint break force is set correct on drop zones (505e1d6)
  • stop disable code running if object starts disabled (43d2953)
  • ensure touch listeners are registered on interact use (80520da)
  • remove rigidbody requirement from snap drop zones (54fb412)
  • update interact touch parameter to make sense (5fde9ab)
  • force secondary controller release on primary drop (88ea725)
  • allow grab on force snapped item after ungrab (96239c0)
  • prevent ungrab event being emitted if not grabbed (b4b8171)
  • remove register touch listeners from update (2e4cb13)
  • check if touched collider is child of touched object (fccddb6)
  • prevent crash if no ignored colliders are present (bfa9382)
  • remove erroneous Debug.Log (00c2a1f)
  • pass relevant VRTK_InteractX to interactable object (61f2f07)
  • prevent null reference exceptions (d797104)
  • leave usage when disabling InteractUse (60bd7b5)
• Structure
  • replace FindChild with Find (3a63a78)
  • remove underscores from enum entries (78b2335)
• UIPointer
  • ensure toggle does not execute if on existing state (f108ac2)
  • ensure pointer events are cleaned with invalid state (e846e2d)
  • ensure the controller is not null before accessing (6109744)
• SceneChanger
  • wrong SDK usage and errors (5eba4a4)
• CurveGenerator
  • ensure unity does not override 5.5 code (2bf3dc0)
  • prevent unity auto updating code (899c2d3)

Features

• Controller
  • add audio haptics (3b50262)
• ControllerEvents
  • provide alternative events for obsolete aliases (ea7ba80)
• ControllerReference
  • add new way of referencing controllers (d564410)
• ControllerTooltips
  • provide option to auto hide tooltips (cca0b97)
• Controls
  • add Released event to Button control (505b594)
• DestinationMarker
  • add hover event (47aea93)
• DestinationPoint
  • allow rotation of point to affect destination (09f6aae)
  • emit on enter and exit destination marker event (0a0ef53)
• Haptics
  • extract haptics out of ControllerActions (529196f)
• Interaction
  • move methods from SharedMethods to specific scripts (39e63cb)
  • deprecate menu toggle button alias (3d12ca0)
  • allow dependencies to be injected (9c7df87)
  • add snap zone events Mirror the events from SnapDropZone to the InteractableObject because at times its more useful to observe these actions from the point of view of the object being manipulated. An example might be an object that changes shape depending if it's hovering over or snapped to a drop zone. (c7a95af)
  • add object touch auto interact script (c7867b1)
  • move global grab/use buttons to grab/use scripts (ea3cb92)
  • add lower threshold for controller axis events (7ff336c)
  • allow sub colliders to be ignored on interactables (362084c)
  • allow custom idle checks (4919ca4)
• Locomotion
  • rename force teleport to teleport and add new method (9a8d97f)
  • hide direction indicator on destination point (902eb3c)
  • add option to ignore snap to floor on teleporter (713b47c)
  • allow force destination in force teleport method (1bd9926)
  • add method to force teleport. (2065a7f)
  • add specific controller direction for move in place (a374937)
  • allow move in place to not require button press (97d06c7)
  • add optional location offset for destination point (061af40)
  • add option for custom blink fade colour on teleport (3e6e4ec)
• Logger
  • add custom logger to better handle log events (2aa1f1e)
• Pointer
  • move direction indicator into base renderer (f0b9edb)
  • valid/invalid location objects for direction indicator (f4fa331)
  • allow valid/invalid color to change direction indicator (1f0c66a)
  • emit event when pointer state is valid or invalid (56ae2af)
  • add ability to hide play area cursor on invalid location (d12d7d0)
  • allow bezier pointer to utilise line renderer (106ece3)
  • add variable downward length on bezier pointer (468d6db)
  • allow custom valid/invalid play area cursor object (f00bee0)
  • add customisable play area cursor game object (8016231)
  • add pointer direction indicator prefab (da93d45)
  • add method to reset pointer objects at runtime (1786310)
  • add selection on hover parameter (63083a2)
  • add selection delay parameter (4791c03)
  • expose policy list as public on destination marker (8296110)
• Presence
  • allow custom body/feed colliders for body physics (d7dd7f3)
  • provide collision sweep detection for body physics (9cf962a)
  • option to ignore trigger colliders for head collisions (f2e7fa6)
  • option to ignore game object collisions to body physics (440ad28)
  • add policy list to position rewind (d4445f2)
  • option to use body colliders when doing player rewind (adb3ffe)
  • add time till fade parameter on headset collision fade (0d13a4e)
  • add methods to get body physics rigidbody velocities (23d980f)
  • add step height support to body physics (d774c5a)
  • add custom raycast option to headset controller aware (603e6e7)
• SDK
  • add methods to get/set boundary draw status (fa1fd3c)
  • allow additional tracked controller usage (ea345ef)
  • add FixedUpdate routine for controller and headset (a5e9925)
  • remove force tracking origin on Oculus SDK camera rig (cd7fea9)
  • allow for dynamic SDK discovery (025605f)
  • add Ximmerse SDK as a new SDK option (1a67a95)
• SDKBridge
  • cache invalidation (9f2090b)
• SDKManager
  • load the previously used SDK Setup (1b17929)
  • runtime SDK switching using SDK Setups (f544015)
  • allow disabling non-SDK symbols (5163fb7)
  • disable inspector fields when auto-populating (2d8c97f)
  • clear scripting define symbols (ca7504b)
• Simulator
  • add sprint and new distance grab mode (9aa6e49)
  • lock mouse by default and hints background (7e2ce97)
  • allow the simulator to lock the cursor when in use (3871cb6)
  • add mouse input mode that requires a button press (7b7995b)
  • add F1 control hint toggle (4a1439b)
  • add context sensitive key mapping control hints (bce93db)
  • allow WASD movement key bindings to be changed (3d91db4)
• SnapDropZone
  • allow cloning snapped object on unsnap (c009276)
  • add getter method for drop zone object (3079a08)
  • add default snapped object option (64644a6)
• StraightPointerRenderer
  • add maximum cursor scale (7436607)
• Structure
  • add events for all current actions (75debee)
  • provide getter methods for auto gen objects (b366d69)
  • add components to component menu (b28da7e)
  • add context appropriate icons to VRTK scripts (d6fe3ab)
  • add standard method for naming generated objects (9bd7f88)
• SupportInfo
  • add VR settings (effff8a)
  • add window to list and copy info for support (447ef38)
• Tooltips
  • add option to make text always face the headset (87934ef)
• UIPointer
  • include RaycastResult in UI Pointer event (3af3dec)
• UpdatePrompt
  • manual update checking and improvements (d7cc00e)
• Utilities
  • simplify headset checking in device finder (21a6d70)
  • ability to modify transform orientation based on sdk (a55dd41)
  • add sdk object alias script for following SDK objects (d9c9c57)
  • add OnPreCull option for tranform follow (b697195)
  • add custom raycast script for customising rays (61e1fe7)
• Version
  • add versioned symbols for VRTK (8712027)
• setupWindow
  • support multi selection (4728c3a)

Performance Improvements

• UpdatePrompt
  • only check for updates every 6 hours (cc521ce)