IProximityEffectObjectProvider Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public interface class IProximityEffectObjectProviderpublic interface IProximityEffectObjectProvidertype IProximityEffectObjectProvider = interfacePublic Interface IProximityEffectObjectProvider- Derived
Properties
| IsActive |
Returns true if the provider has any visible objects |
| ProximityObjectsChanged |
Allow for accessing / subscribing to the changed event for objects that show a proximity effect |
Methods
| ForEachProximityObject(Action<Transform>) |
This method allows iterating over the proximity scaled visuals. It should return the gameobject the scaling should be applied to. |
| GetBaseMaterial() |
Base Material is applied to any proximity scaled object whenever in medium or far/no proximity mode |
| GetHighlightedMaterial() |
Provides the highlighted material that gets applied to any proximity scaled object in close proximity mode |
| GetObjectSize() |
Returns the original object size of the provided proximity scaled objects |