Class TunnelingVignetteController

Provides methods for ITunnelingVignetteProvider components to control the tunneling vignette material.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

TunnelingVignetteController

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit.Locomotion.Comfort

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[AddComponentMenu("XR/Locomotion/Tunneling Vignette Controller", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Comfort.TunnelingVignetteController.html")]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public class TunnelingVignetteController : MonoBehaviour

Properties

currentParameters

(Read Only) The current VignetteParameters that is controlling the tunneling vignette material.

Declaration

public VignetteParameters currentParameters { get; }

Property Value

Type	Description
VignetteParameters

defaultParameters

The default VignetteParameters of this TunnelingVignetteController.

Declaration

public VignetteParameters defaultParameters { get; set; }

Property Value

Type	Description
VignetteParameters

locomotionVignetteProviders

List to store LocomotionVignetteProvider instances that trigger the tunneling vignette on their locomotion state changes.

Declaration

public List<LocomotionVignetteProvider> locomotionVignetteProviders { get; set; }

Property Value

Type	Description
List<LocomotionVignetteProvider>

Methods

Awake()

See MonoBehaviour.

Declaration

protected virtual void Awake()

BeginTunnelingVignette(ITunnelingVignetteProvider)

Queues an ITunnelingVignetteProvider to trigger the ease-in vignette effect.

Declaration

public void BeginTunnelingVignette(ITunnelingVignetteProvider provider)

Parameters

Type	Name	Description
ITunnelingVignetteProvider	provider	The ITunnelingVignetteProvider that contains information of VignetteParameters.

Remarks

Unity will automatically sort all providers by their aperture size to prioritize the control from the one with the smallest aperture size if multiple providers are calling this method.

EndTunnelingVignette(ITunnelingVignetteProvider)

Queues an ITunnelingVignetteProvider to trigger the ease-out vignette effect.

Declaration

public void EndTunnelingVignette(ITunnelingVignetteProvider provider)

Parameters

Type	Name	Description
ITunnelingVignetteProvider	provider	The ITunnelingVignetteProvider that contains information of VignetteParameters.

Remarks

Unity will automatically sort all providers by their aperture size to prioritize the control from the one with the smallest aperture size if multiple providers are calling this method.

Reset()

See MonoBehaviour.

Declaration

[Conditional("UNITY_EDITOR")]
protected virtual void Reset()

Update()

See MonoBehaviour.

Declaration

protected virtual void Update()