Class ProximityLight

Utility component to animate and visualize a light that can be used with the "MixedRealityToolkit/Standard" shader "_ProximityLight" feature.

Inheritance

Object

ProximityLight

Implements

MonoBehaviour

Namespace: Microsoft.MixedReality.Toolkit.Utilities

Assembly: cs.temp.dll.dll

Syntax

public class ProximityLight : MonoBehaviour, MonoBehaviour

Properties

Settings

Declaration

public ProximityLight.LightSettings Settings { get; set; }

Property Value

Type	Description
ProximityLight.LightSettings

Settings

Declaration

public ProximityLight.LightSettings Settings { get; set; }

Property Value

Type	Description
ProximityLight.LightSettings

Methods

Pulse(Single, Single, Single)

Initiates a pulse, if one is not already occurring, which simulates a user touching a surface.

Declaration

public void Pulse(float pulseDuration = 0.2F, float fadeBegin = 0.8F, float fadeSpeed = 10F)

Parameters

Type	Name	Description
Single	pulseDuration	How long in seconds should the pulse animate over.
Single	fadeBegin	At what point during the pulseDuration should the pulse begin to fade out as a percentage. Range should be [0, 1].
Single	fadeSpeed	The speed to fade in and out.

Pulse(Single, Single, Single)

Initiates a pulse, if one is not already occurring, which simulates a user touching a surface.

Declaration

public void Pulse(float pulseDuration = 0.2F, float fadeBegin = 0.8F, float fadeSpeed = 10F)

Parameters

Type	Name	Description
Single	pulseDuration	How long in seconds should the pulse animate over.
Single	fadeBegin	At what point during the pulseDuration should the pulse begin to fade out as a percentage. Range should be [0, 1].
Single	fadeSpeed	The speed to fade in and out.

Implements

MonoBehaviour