Edit

Share via

ProximityEffectConfiguration Class

  • Reference

Definition

Namespace:
Microsoft.MixedReality.Toolkit.UI.BoundsControl
Assembly:
Microsoft.MixedReality.Toolkit.SDK.dll

Shareable configuration for a proximity effect that can be used with BoundsControl ProximityEffect scales and switches out materials for registered objects whenever a pointer is in proximity. Scaling is done on three different stages: far / medium and close proximity whereas material switching will only be done on close proximity.

public ref class ProximityEffectConfiguration : UnityEngine::ScriptableObject
[UnityEngine.CreateAssetMenu(fileName="ProximityEffect", menuName="Mixed Reality Toolkit/Bounds Control/Proximity Effect")]
public class ProximityEffectConfiguration : UnityEngine.ScriptableObject
[UnityEngine.CreateAssetMenu(fileName="ProximityEffect", menuName="Mixed Reality/Toolkit/Bounds Control/Proximity Effect")]
public class ProximityEffectConfiguration : UnityEngine.ScriptableObject
[<UnityEngine.CreateAssetMenu(fileName="ProximityEffect", menuName="Mixed Reality Toolkit/Bounds Control/Proximity Effect")>]
type ProximityEffectConfiguration = class
    inherit ScriptableObject
[<UnityEngine.CreateAssetMenu(fileName="ProximityEffect", menuName="Mixed Reality/Toolkit/Bounds Control/Proximity Effect")>]
type ProximityEffectConfiguration = class
    inherit ScriptableObject
Public Class ProximityEffectConfiguration
Inherits ScriptableObject
Inheritance
UnityEngine.ScriptableObject
ProximityEffectConfiguration
Attributes
UnityEngine.CreateAssetMenuAttribute

Constructors

ProximityEffectConfiguration()

Properties

CloseGrowRate

Rate a proximity scaled object scales when the hand moves from close proximity to object center
CloseScale

A Proximity-enabled object scales by this amount when a hand moves into the Close Proximity range. Default is 1.5, larger object size
FarGrowRate

Rate a proximity scaled object scales when the hand moves from medium to far proximity.
FarScale

A Proximity-enabled object scales by this amount when a hand moves out of range. Default is 0, invisible object.
MediumGrowRate

Rate a proximity scaled object scales when the hand moves from medium to close proximity.
MediumScale

A Proximity-enabled object scales by this amount when a hand moves into the Medium Proximity range. Default is 1.0, original object size.
ObjectCloseProximity

Distance the hand has to be in to start the close proximity scaling effect.
ObjectMediumProximity

Distance the hand has to be in to start scaling objects.
ProximityEffectActive

Determines whether proximity feature (scaling and material toggling) is activated

Applies to