mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class Distorter

    Inheritance
    Object
    Distorter
    DistorterBulge
    DistorterGravity
    DistorterSimplex
    DistorterSphere
    DistorterWiggly
    Implements
    IComparable<Distorter>
    MonoBehaviour
    Namespace: Microsoft.MixedReality.Toolkit.Physics
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class Distorter : MonoBehaviour, IComparable<Distorter>, MonoBehaviour

    Properties

    DistortionEnabled

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

    DistortionEnabled

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

    DistortOrder

    Declaration
    public int DistortOrder { get; set; }
    Property Value
    Type Description
    Int32

    DistortOrder

    Declaration
    public int DistortOrder { get; set; }
    Property Value
    Type Description
    Int32

    DistortStrength

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

    DistortStrength

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

    Methods

    CompareTo(Distorter)

    Declaration
    public int CompareTo(Distorter other)
    Parameters
    Type Name Description
    Distorter other
    Returns
    Type Description
    Int32

    CompareTo(Distorter)

    Declaration
    public int CompareTo(Distorter other)
    Parameters
    Type Name Description
    Distorter other
    Returns
    Type Description
    Int32

    DistortPoint(Vector3, Single)

    Distorts a world-space point Automatically applies DistortStrength and ensures that strength never exceeds 1

    Declaration
    public Vector3 DistortPoint(Vector3 point, float strength = 1F)
    Parameters
    Type Name Description
    Vector3 point
    Single strength
    Returns
    Type Description
    Vector3

    DistortPoint(Vector3, Single)

    Distorts a world-space point Automatically applies DistortStrength and ensures that strength never exceeds 1

    Declaration
    public Vector3 DistortPoint(Vector3 point, float strength = 1F)
    Parameters
    Type Name Description
    Vector3 point
    Single strength
    Returns
    Type Description
    Vector3

    DistortPointInternal(Vector3, Single)

    Internal function where position distortion is done

    Declaration
    protected abstract Vector3 DistortPointInternal(Vector3 point, float strength)
    Parameters
    Type Name Description
    Vector3 point
    Single strength
    Returns
    Type Description
    Vector3

    DistortPointInternal(Vector3, Single)

    Internal function where position distortion is done

    Declaration
    protected abstract Vector3 DistortPointInternal(Vector3 point, float strength)
    Parameters
    Type Name Description
    Vector3 point
    Single strength
    Returns
    Type Description
    Vector3

    DistortScale(Vector3, Single)

    Distorts a world-space scale Automatically applies DistortStrength and ensures that strength never exceeds 1

    Declaration
    public Vector3 DistortScale(Vector3 scale, float strength = 1F)
    Parameters
    Type Name Description
    Vector3 scale
    Single strength
    Returns
    Type Description
    Vector3

    DistortScale(Vector3, Single)

    Distorts a world-space scale Automatically applies DistortStrength and ensures that strength never exceeds 1

    Declaration
    public Vector3 DistortScale(Vector3 scale, float strength = 1F)
    Parameters
    Type Name Description
    Vector3 scale
    Single strength
    Returns
    Type Description
    Vector3

    DistortScaleInternal(Vector3, Single)

    Internal function where scale distortion is done

    Declaration
    protected abstract Vector3 DistortScaleInternal(Vector3 point, float strength)
    Parameters
    Type Name Description
    Vector3 point
    Single strength
    Returns
    Type Description
    Vector3

    DistortScaleInternal(Vector3, Single)

    Internal function where scale distortion is done

    Declaration
    protected abstract Vector3 DistortScaleInternal(Vector3 point, float strength)
    Parameters
    Type Name Description
    Vector3 point
    Single strength
    Returns
    Type Description
    Vector3

    OnDisable()

    Declaration
    protected virtual void OnDisable()

    OnDisable()

    Declaration
    protected virtual void OnDisable()

    OnEnable()

    Declaration
    protected virtual void OnEnable()

    OnEnable()

    Declaration
    protected virtual void OnEnable()

    Implements

    IComparable<>
    MonoBehaviour
    In This Article
    • Properties
      • DistortionEnabled
      • DistortionEnabled
      • DistortOrder
      • DistortOrder
      • DistortStrength
      • DistortStrength
    • Methods
      • CompareTo(Distorter)
      • CompareTo(Distorter)
      • DistortPoint(Vector3, Single)
      • DistortPoint(Vector3, Single)
      • DistortPointInternal(Vector3, Single)
      • DistortPointInternal(Vector3, Single)
      • DistortScale(Vector3, Single)
      • DistortScale(Vector3, Single)
      • DistortScaleInternal(Vector3, Single)
      • DistortScaleInternal(Vector3, Single)
      • OnDisable()
      • OnDisable()
      • OnEnable()
      • OnEnable()
    • Implements
    Back to top Generated by DocFX