PulseShaderSpatialMeshHandler Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.UI.PulseShader

Assembly:: Microsoft.MixedReality.Toolkit.SDK.dll

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.

Script for triggering the pulse shader effect on the spatial mesh.

C++

public ref class PulseShaderSpatialMeshHandler : Microsoft::MixedReality::Toolkit::UI::PulseShader::PulseShaderHandler, Microsoft::MixedReality::Toolkit::Input::IMixedRealityPointerHandler, UnityEngine::EventSystems::IEventSystemHandler

public class PulseShaderSpatialMeshHandler : Microsoft.MixedReality.Toolkit.UI.PulseShader.PulseShaderHandler, Microsoft.MixedReality.Toolkit.Input.IMixedRealityPointerHandler, UnityEngine.EventSystems.IEventSystemHandler

type PulseShaderSpatialMeshHandler = class
    inherit PulseShaderHandler
    interface IMixedRealityPointerHandler
    interface IEventSystemHandler

Public Class PulseShaderSpatialMeshHandler
Inherits PulseShaderHandler
Implements IEventSystemHandler, IMixedRealityPointerHandler

Inheritance: UnityEngine.MonoBehaviour

PulseShaderHandler
PulseShaderSpatialMeshHandler

Implements: IMixedRealityPointerHandler UnityEngine.EventSystems.IEventSystemHandler

Constructors

PulseShaderSpatialMeshHandler()

Properties

AutoStart	Automatically begin repeated pulsing. (Inherited from PulseShaderHandler)
OriginFollowCamera	Set the origin of the pulse animation to the main camera location.
OriginParamName	Shader parameter name to set the pulse origin, in local space. (Inherited from PulseShaderHandler)
ParamName	Shader parameter name to drive the pulse radius. (Inherited from PulseShaderHandler)
PulseAnimationDuration	How long in seconds the pulse should animate. (Inherited from PulseShaderHandler)
PulseOnSelect	Trigger the pulse shader animation on select (air-tap/pinch) of the spatial mesh.
PulseRepeatMinDelay	Minimum time to wait between each pulse. (Inherited from PulseShaderHandler)
SurfaceMat	The material to animate. (Inherited from PulseShaderHandler)

Methods

ApplyPulseRadiusToMaterial(Single)	(Inherited from PulseShaderHandler)
OnDestroy()	(Inherited from PulseShaderHandler)
OnPointerClicked(MixedRealityPointerEventData)
OnPointerDown(MixedRealityPointerEventData)
OnPointerDragged(MixedRealityPointerEventData)
OnPointerUp(MixedRealityPointerEventData)
PulseOnce(Boolean)	(Inherited from PulseShaderHandler)
ResetPulseMaterial()	(Inherited from PulseShaderHandler)
SetLocalOrigin(Vector3)	(Inherited from PulseShaderHandler)
Start()	(Inherited from PulseShaderHandler)
StartPulsing()	(Inherited from PulseShaderHandler)
StopPulsing(Boolean)	(Inherited from PulseShaderHandler)
TriggerAnimationOnSpatialMesh(Vector3)
Update()

Applies to

Product	Versions
MRTK2 Unity 2018	2.6.0, 2.7.0
MRTK2 Unity 2019	2.6.0, 2.7.0, 2.8.0
MRTK2 Unity 2020	2.6.0, 2.7.0, 2.8.0

Share via