Class TunnelingVignetteController
Provides methods for ITunnelingVignetteProvider components to control the tunneling vignette material.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[AddComponentMenu("XR/Locomotion/Tunneling Vignette Controller", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.4/api/UnityEngine.XR.Interaction.Toolkit.TunnelingVignetteController.html")]
public class TunnelingVignetteController : MonoBehaviourProperties
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 a 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 a 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()