Class LocomotionVignetteProvider

Represents an ITunnelingVignetteProvider with a LocomotionProvider.

Inheritance
Object
LocomotionVignetteProvider
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[Serializable]
public class LocomotionVignetteProvider : ITunnelingVignetteProvider

Properties

enabled

Whether to enable this LocomotionProvider to trigger the tunneling vignette effects.

Declaration
public bool enabled { get; set; }
Property Value
Type Description
Boolean

locomotionProvider

The LocomotionProvider to trigger the tunneling vignette effects based on its LocomotionPhase.

Declaration
public LocomotionProvider locomotionProvider { get; set; }
Property Value
Type Description
LocomotionProvider

overrideDefaultParameters

If enabled, Unity will override the value of defaultParameters and instead use the customized VignetteParameters defined by this class.

Declaration
public bool overrideDefaultParameters { get; set; }
Property Value
Type Description
Boolean
See Also

overrideParameters

The VignetteParameters that this LocomotionVignetteProvider uses to control the vignette when the property to override defaultParameters is enabled.

Declaration
public VignetteParameters overrideParameters { get; set; }
Property Value
Type Description
VignetteParameters
See Also

vignetteParameters

Represents the parameter values that this provider wants to set for the tunneling vignette effect. A value of null indicates the defaultParameters should be used.

Declaration
public VignetteParameters vignetteParameters { get; }
Property Value
Type Description
VignetteParameters
Implements