Class LocomotionVignetteProvider

Represents an ITunnelingVignetteProvider with a LocomotionProvider.

Inheritance

object

LocomotionVignetteProvider

Implements

ITunnelingVignetteProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[Serializable]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
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
bool

locomotionProvider

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

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
bool

See Also

overrideParameters

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

overrideDefaultParameters

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

ITunnelingVignetteProvider