{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"VRTK_TunnelOverlay","type":"basic","slug":"vrtk_tunneloverlay","excerpt":"","body":"## Overview\n\nApplys a tunnel overlay effect to the active VR camera when the play area is moving or rotating to reduce potential nausea caused by simulation sickness.\n\n**Script Usage:**\n * Place the `VRTK_TunnelOverlay` script on any active scene GameObject.\n\n  > This implementation is based on a project made by SixWays at https://github.com/SixWays/UnityVrTunnelling\n\n## Inspector Parameters\n\n * **Minimum Rotation:** Minimum rotation speed for the effect to activate (degrees per second).\n * **Maximum Rotation:** Maximum rotation speed for the effect have its max settings applied (degrees per second).\n * **Minimum Speed:** Minimum movement speed for the effect to activate.\n * **Maximum Speed:** Maximum movement speed where the effect will have its max settings applied.\n * **Effect Color:** The color to use for the tunnel effect.\n * **Effect Skybox:** An optional skybox texture to use for the tunnel effect.\n * **Initial Effect Size:** The initial amount of screen coverage the tunnel to consume without any movement.\n * **Maximum Effect Size:** Screen coverage at the maximum tracked values.\n * **Feather Size:** Feather effect size around the cut-off as fraction of screen.\n * **Smoothing Time:** Smooth out radius over time.","updates":[],"order":13,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f8f789c68300003297a67","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":"Locomotion","slug":"locomotion","order":4,"from_sync":false,"reference":false,"_id":"5b1f8576c2505d0003125428","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","createdAt":"2017-01-01T16:41:26.797Z","__v":0},"user":"571fa519db52d01700f5cf3d","createdAt":"2018-06-12T09:16:40.062Z","githubsync":"","__v":0,"parentDoc":null}

VRTK_TunnelOverlay


## Overview Applys a tunnel overlay effect to the active VR camera when the play area is moving or rotating to reduce potential nausea caused by simulation sickness. **Script Usage:** * Place the `VRTK_TunnelOverlay` script on any active scene GameObject. > This implementation is based on a project made by SixWays at https://github.com/SixWays/UnityVrTunnelling ## Inspector Parameters * **Minimum Rotation:** Minimum rotation speed for the effect to activate (degrees per second). * **Maximum Rotation:** Maximum rotation speed for the effect have its max settings applied (degrees per second). * **Minimum Speed:** Minimum movement speed for the effect to activate. * **Maximum Speed:** Maximum movement speed where the effect will have its max settings applied. * **Effect Color:** The color to use for the tunnel effect. * **Effect Skybox:** An optional skybox texture to use for the tunnel effect. * **Initial Effect Size:** The initial amount of screen coverage the tunnel to consume without any movement. * **Maximum Effect Size:** Screen coverage at the maximum tracked values. * **Feather Size:** Feather effect size around the cut-off as fraction of screen. * **Smoothing Time:** Smooth out radius over time.