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 SurfacePulse

    Script for generating pulse shader effect on the surface.

    Inheritance
    Object
    SurfacePulse
    Implements
    IMixedRealityPointerHandler
    Namespace: Microsoft.MixedReality.Toolkit.Experimental.SurfacePulse
    Assembly: cs.temp.dll.dll
    Syntax
    public class SurfacePulse : MonoBehaviour, IMixedRealityPointerHandler

    Properties

    AutoStart

    Declaration
    public bool AutoStart { get; set; }
    Property Value
    Type Description
    Boolean

    OriginFollowCamera

    Declaration
    public bool OriginFollowCamera { get; set; }
    Property Value
    Type Description
    Boolean

    OriginParamName

    Declaration
    public string OriginParamName { get; set; }
    Property Value
    Type Description
    String

    ParamName

    Shader parameter name to drive the pulse radius

    Declaration
    public string ParamName { get; set; }
    Property Value
    Type Description
    String

    PulseDuration

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

    PulseOnSelect

    Declaration
    public bool PulseOnSelect { get; set; }
    Property Value
    Type Description
    Boolean

    PulseRepeatMinDelay

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

    SurfaceMat

    Declaration
    public Material SurfaceMat { get; set; }
    Property Value
    Type Description
    Material

    Methods

    OnPointerClicked(MixedRealityPointerEventData)

    Declaration
    public void OnPointerClicked(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    OnPointerDown(MixedRealityPointerEventData)

    Declaration
    public void OnPointerDown(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    OnPointerDragged(MixedRealityPointerEventData)

    Declaration
    public void OnPointerDragged(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    OnPointerUp(MixedRealityPointerEventData)

    Declaration
    public void OnPointerUp(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    PulseOnce()

    Declaration
    public void PulseOnce()

    ResetPulseMaterial()

    Declaration
    public void ResetPulseMaterial()

    SetLocalOrigin(Vector3)

    Declaration
    public void SetLocalOrigin(Vector3 origin)
    Parameters
    Type Name Description
    Vector3 origin

    StartPulsing()

    Declaration
    public void StartPulsing()

    StopPulsing(Boolean)

    Declaration
    public void StopPulsing(bool bFinishCurrentPulse = true)
    Parameters
    Type Name Description
    Boolean bFinishCurrentPulse

    Implements

    IMixedRealityPointerHandler
    In This Article
    Back to top Generated by DocFX