We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

Search Results for

    Show / Hide Table of Contents

    Class ProximityEffectConfiguration

    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.

    Inheritance
    Object
    ProximityEffectConfiguration
    Namespace: Microsoft.MixedReality.Toolkit.UI.BoundsControl
    Assembly: cs.temp.dll.dll
    Syntax
    public class ProximityEffectConfiguration : ScriptableObject

    Properties

    CloseGrowRate

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

    Declaration
    public float CloseGrowRate { get; set; }
    Property Value
    Type Description
    Single

    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

    Declaration
    public float CloseScale { get; set; }
    Property Value
    Type Description
    Single

    FarGrowRate

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

    Declaration
    public float FarGrowRate { get; set; }
    Property Value
    Type Description
    Single

    FarScale

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

    Declaration
    public float FarScale { get; set; }
    Property Value
    Type Description
    Single

    MediumGrowRate

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

    Declaration
    public float MediumGrowRate { get; set; }
    Property Value
    Type Description
    Single

    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.

    Declaration
    public float MediumScale { get; set; }
    Property Value
    Type Description
    Single

    ObjectCloseProximity

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

    Declaration
    public float ObjectCloseProximity { get; set; }
    Property Value
    Type Description
    Single

    ObjectMediumProximity

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

    Declaration
    public float ObjectMediumProximity { get; set; }
    Property Value
    Type Description
    Single

    ProximityEffectActive

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

    Declaration
    public bool ProximityEffectActive { get; set; }
    Property Value
    Type Description
    Boolean
    In This Article
    Back to top Generated by DocFX