Interface IProximityEffectObjectProvider

Interface for defining a proximity object provider used in ProximityEffect of BoundsControl ProximityEffectObjectProviders are responsible for providing gameobjects that are scaled / visually altered in ProximityEffect.

Namespace: Microsoft.MixedReality.Toolkit.Experimental.UI.BoundsControl

Assembly: cs.temp.dll.dll

Syntax

public interface IProximityEffectObjectProvider

Properties

IsActive

Returns true if the provider has any visible objects

Declaration

bool IsActive { get; set; }

Property Value

Type	Description
Boolean

ProximityObjectsChanged

Allow for accessing / subscribing to the changed event for objects that show a proximity effect

Declaration

ProximityObjectsChangedEvent ProximityObjectsChanged { get; }

Property Value

Type	Description
ProximityObjectsChangedEvent

Methods

ForEachProximityObject(Action<Transform>)

This method allows iterating over the proximity scaled visuals. It should return the gameobject the scaling should be applied to.

Declaration

void ForEachProximityObject(Action<Transform> action)

Parameters

Type	Name	Description
Action<Transform>	action

GetBaseMaterial()

Base Material is applied to any proximity scaled object whenever in medium or far/no proximity mode

Declaration

Material GetBaseMaterial()

Returns

Type	Description
Material

GetHighlightedMaterial()

Provides the highlighted material that gets applied to any proximity scaled object in close proximity mode

Declaration

Material GetHighlightedMaterial()

Returns

Type	Description
Material

GetObjectSize()

Returns the original object size of the provided proximity scaled objects

Declaration

float GetObjectSize()

Returns

Type	Description
Single