mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class VectorExtensions

    Extension methods for Unity's Vector struct

    Inheritance
    Object
    VectorExtensions
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit
    Assembly: cs.temp.dll.dll
    Syntax
    public static class VectorExtensions

    Methods

    Average(ICollection<Vector2>)

    Declaration
    public static Vector2 Average(this ICollection<Vector2> vectors)
    Parameters
    Type Name Description
    ICollection<Vector2> vectors
    Returns
    Type Description
    Vector2

    Average(ICollection<Vector2>)

    Declaration
    public static Vector2 Average(this ICollection<Vector2> vectors)
    Parameters
    Type Name Description
    ICollection<Vector2> vectors
    Returns
    Type Description
    Vector2

    Average(ICollection<Vector3>)

    Declaration
    public static Vector3 Average(this ICollection<Vector3> vectors)
    Parameters
    Type Name Description
    ICollection<Vector3> vectors
    Returns
    Type Description
    Vector3

    Average(ICollection<Vector3>)

    Declaration
    public static Vector3 Average(this ICollection<Vector3> vectors)
    Parameters
    Type Name Description
    ICollection<Vector3> vectors
    Returns
    Type Description
    Vector3

    Average(IEnumerable<Vector2>)

    Declaration
    public static Vector2 Average(this IEnumerable<Vector2> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector2> vectors
    Returns
    Type Description
    Vector2

    Average(IEnumerable<Vector2>)

    Declaration
    public static Vector2 Average(this IEnumerable<Vector2> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector2> vectors
    Returns
    Type Description
    Vector2

    Average(IEnumerable<Vector3>)

    Declaration
    public static Vector3 Average(this IEnumerable<Vector3> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector3> vectors
    Returns
    Type Description
    Vector3

    Average(IEnumerable<Vector3>)

    Declaration
    public static Vector3 Average(this IEnumerable<Vector3> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector3> vectors
    Returns
    Type Description
    Vector3

    CloseEnough(Vector3, Vector3, Single)

    Determines if the distance between two vectors is within a given tolerance.

    Declaration
    public static bool CloseEnough(Vector3 v1, Vector3 v2, float distanceTolerance)
    Parameters
    Type Name Description
    Vector3 v1

    The first vector.

    Vector3 v2

    The second vector.

    Single distanceTolerance

    The maximum distance that will cause this to return true.

    Returns
    Type Description
    Boolean

    True if the distance between the two vectors is within the tolerance, false otherwise.

    CylindricalMapping(Vector3, Single)

    Get the relative mapping based on a source Vec3 and a radius for cylinder mapping.

    Declaration
    public static Vector3 CylindricalMapping(Vector3 source, float radius)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to cylinder

    Single radius

    This is a Single for the radius of the cylinder

    Returns
    Type Description
    Vector3

    CylindricalMapping(Vector3, Single)

    Get the relative mapping based on a source Vec3 and a radius for cylinder mapping.

    Declaration
    public static Vector3 CylindricalMapping(Vector3 source, float radius)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to cylinder

    Single radius

    This is a Single for the radius of the cylinder

    Returns
    Type Description
    Vector3

    Div(Vector2, Vector2)

    Declaration
    public static Vector2 Div(this Vector2 value, Vector2 scale)
    Parameters
    Type Name Description
    Vector2 value
    Vector2 scale
    Returns
    Type Description
    Vector2

    Div(Vector2, Vector2)

    Declaration
    public static Vector2 Div(this Vector2 value, Vector2 scale)
    Parameters
    Type Name Description
    Vector2 value
    Vector2 scale
    Returns
    Type Description
    Vector2

    Div(Vector3, Vector3)

    Declaration
    public static Vector3 Div(this Vector3 value, Vector3 scale)
    Parameters
    Type Name Description
    Vector3 value
    Vector3 scale
    Returns
    Type Description
    Vector3

    Div(Vector3, Vector3)

    Declaration
    public static Vector3 Div(this Vector3 value, Vector3 scale)
    Parameters
    Type Name Description
    Vector3 value
    Vector3 scale
    Returns
    Type Description
    Vector3

    InverseTransformPoint(Vector3, Vector3, Quaternion, Vector3)

    Declaration
    public static Vector3 InverseTransformPoint(this Vector3 point, Vector3 translation, Quaternion rotation, Vector3 lossyScale)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 translation
    Quaternion rotation
    Vector3 lossyScale
    Returns
    Type Description
    Vector3

    InverseTransformPoint(Vector3, Vector3, Quaternion, Vector3)

    Declaration
    public static Vector3 InverseTransformPoint(this Vector3 point, Vector3 translation, Quaternion rotation, Vector3 lossyScale)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 translation
    Quaternion rotation
    Vector3 lossyScale
    Returns
    Type Description
    Vector3

    IsValidVector(Vector3)

    Declaration
    public static bool IsValidVector(this Vector3 vector)
    Parameters
    Type Name Description
    Vector3 vector
    Returns
    Type Description
    Boolean

    IsValidVector(Vector3)

    Declaration
    public static bool IsValidVector(this Vector3 vector)
    Parameters
    Type Name Description
    Vector3 vector
    Returns
    Type Description
    Boolean

    Median(ICollection<Vector2>)

    Declaration
    public static Vector2 Median(this ICollection<Vector2> vectors)
    Parameters
    Type Name Description
    ICollection<Vector2> vectors
    Returns
    Type Description
    Vector2

    Median(ICollection<Vector2>)

    Declaration
    public static Vector2 Median(this ICollection<Vector2> vectors)
    Parameters
    Type Name Description
    ICollection<Vector2> vectors
    Returns
    Type Description
    Vector2

    Median(ICollection<Vector3>)

    Declaration
    public static Vector3 Median(this ICollection<Vector3> vectors)
    Parameters
    Type Name Description
    ICollection<Vector3> vectors
    Returns
    Type Description
    Vector3

    Median(ICollection<Vector3>)

    Declaration
    public static Vector3 Median(this ICollection<Vector3> vectors)
    Parameters
    Type Name Description
    ICollection<Vector3> vectors
    Returns
    Type Description
    Vector3

    Median(IEnumerable<Vector2>)

    Declaration
    public static Vector2 Median(this IEnumerable<Vector2> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector2> vectors
    Returns
    Type Description
    Vector2

    Median(IEnumerable<Vector2>)

    Declaration
    public static Vector2 Median(this IEnumerable<Vector2> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector2> vectors
    Returns
    Type Description
    Vector2

    Median(IEnumerable<Vector3>)

    Declaration
    public static Vector3 Median(this IEnumerable<Vector3> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector3> vectors
    Returns
    Type Description
    Vector3

    Median(IEnumerable<Vector3>)

    Declaration
    public static Vector3 Median(this IEnumerable<Vector3> vectors)
    Parameters
    Type Name Description
    IEnumerable<Vector3> vectors
    Returns
    Type Description
    Vector3

    Mul(Vector2, Vector2)

    Declaration
    public static Vector2 Mul(this Vector2 value, Vector2 scale)
    Parameters
    Type Name Description
    Vector2 value
    Vector2 scale
    Returns
    Type Description
    Vector2

    Mul(Vector2, Vector2)

    Declaration
    public static Vector2 Mul(this Vector2 value, Vector2 scale)
    Parameters
    Type Name Description
    Vector2 value
    Vector2 scale
    Returns
    Type Description
    Vector2

    Mul(Vector3, Vector3)

    Declaration
    public static Vector3 Mul(this Vector3 value, Vector3 scale)
    Parameters
    Type Name Description
    Vector3 value
    Vector3 scale
    Returns
    Type Description
    Vector3

    Mul(Vector3, Vector3)

    Declaration
    public static Vector3 Mul(this Vector3 value, Vector3 scale)
    Parameters
    Type Name Description
    Vector3 value
    Vector3 scale
    Returns
    Type Description
    Vector3

    RadialMapping(Vector3, Single, Single, Int32, Int32, Int32, Int32)

    Get the relative mapping based on a source Vec3 and a radius for radial mapping.

    Declaration
    public static Vector3 RadialMapping(Vector3 source, float radialRange, float radius, int row, int totalRows, int column, int totalColumns)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to cylinder

    Single radialRange

    The total range of the radial in degrees as a Single

    Single radius

    This is a Single for the radius of the radial

    Int32 row

    The current row as a Int32 for the radial calculation

    Int32 totalRows

    The total rows as a Int32 for the radial calculation

    Int32 column

    The current column as a Int32 for the radial calculation

    Int32 totalColumns

    The total columns as a Int32 for the radial calculation

    Returns
    Type Description
    Vector3

    RadialMapping(Vector3, Single, Single, Int32, Int32, Int32, Int32)

    Get the relative mapping based on a source Vec3 and a radius for radial mapping.

    Declaration
    public static Vector3 RadialMapping(Vector3 source, float radialRange, float radius, int row, int totalRows, int column, int totalColumns)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to cylinder

    Single radialRange

    The total range of the radial in degrees as a Single

    Single radius

    This is a Single for the radius of the radial

    Int32 row

    The current row as a Int32 for the radial calculation

    Int32 totalRows

    The total rows as a Int32 for the radial calculation

    Int32 column

    The current column as a Int32 for the radial calculation

    Int32 totalColumns

    The total columns as a Int32 for the radial calculation

    Returns
    Type Description
    Vector3

    RotateAround(Vector3, Vector3, Quaternion)

    Declaration
    public static Vector3 RotateAround(this Vector3 point, Vector3 pivot, Quaternion rotation)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 pivot
    Quaternion rotation
    Returns
    Type Description
    Vector3

    RotateAround(Vector3, Vector3, Quaternion)

    Declaration
    public static Vector3 RotateAround(this Vector3 point, Vector3 pivot, Quaternion rotation)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 pivot
    Quaternion rotation
    Returns
    Type Description
    Vector3

    RotateAround(Vector3, Vector3, Vector3)

    Declaration
    public static Vector3 RotateAround(this Vector3 point, Vector3 pivot, Vector3 eulerAngles)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 pivot
    Vector3 eulerAngles
    Returns
    Type Description
    Vector3

    RotateAround(Vector3, Vector3, Vector3)

    Declaration
    public static Vector3 RotateAround(this Vector3 point, Vector3 pivot, Vector3 eulerAngles)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 pivot
    Vector3 eulerAngles
    Returns
    Type Description
    Vector3

    ScatterMapping(Vector3, Single)

    Randomized mapping based on a source Vec3 and a radius for randomization distance.

    Declaration
    public static Vector3 ScatterMapping(Vector3 source, float radius)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to cylinder

    Single radius

    This is a Single for the radius of the cylinder

    Returns
    Type Description
    Vector3

    ScatterMapping(Vector3, Single)

    Randomized mapping based on a source Vec3 and a radius for randomization distance.

    Declaration
    public static Vector3 ScatterMapping(Vector3 source, float radius)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to cylinder

    Single radius

    This is a Single for the radius of the cylinder

    Returns
    Type Description
    Vector3

    SphericalMapping(Vector3, Single)

    Get the relative mapping based on a source Vec3 and a radius for spherical mapping.

    Declaration
    public static Vector3 SphericalMapping(Vector3 source, float radius)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to sphere

    Single radius

    This is a Single for the radius of the sphere

    Returns
    Type Description
    Vector3

    SphericalMapping(Vector3, Single)

    Get the relative mapping based on a source Vec3 and a radius for spherical mapping.

    Declaration
    public static Vector3 SphericalMapping(Vector3 source, float radius)
    Parameters
    Type Name Description
    Vector3 source

    The source Vector3 to be mapped to sphere

    Single radius

    This is a Single for the radius of the sphere

    Returns
    Type Description
    Vector3

    TransformPoint(Vector3, Vector3, Quaternion, Vector3)

    Declaration
    public static Vector3 TransformPoint(this Vector3 point, Vector3 translation, Quaternion rotation, Vector3 lossyScale)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 translation
    Quaternion rotation
    Vector3 lossyScale
    Returns
    Type Description
    Vector3

    TransformPoint(Vector3, Vector3, Quaternion, Vector3)

    Declaration
    public static Vector3 TransformPoint(this Vector3 point, Vector3 translation, Quaternion rotation, Vector3 lossyScale)
    Parameters
    Type Name Description
    Vector3 point
    Vector3 translation
    Quaternion rotation
    Vector3 lossyScale
    Returns
    Type Description
    Vector3
    In This Article
    • Methods
      • Average(ICollection<Vector2>)
      • Average(ICollection<Vector2>)
      • Average(ICollection<Vector3>)
      • Average(ICollection<Vector3>)
      • Average(IEnumerable<Vector2>)
      • Average(IEnumerable<Vector2>)
      • Average(IEnumerable<Vector3>)
      • Average(IEnumerable<Vector3>)
      • CloseEnough(Vector3, Vector3, Single)
      • CylindricalMapping(Vector3, Single)
      • CylindricalMapping(Vector3, Single)
      • Div(Vector2, Vector2)
      • Div(Vector2, Vector2)
      • Div(Vector3, Vector3)
      • Div(Vector3, Vector3)
      • InverseTransformPoint(Vector3, Vector3, Quaternion, Vector3)
      • InverseTransformPoint(Vector3, Vector3, Quaternion, Vector3)
      • IsValidVector(Vector3)
      • IsValidVector(Vector3)
      • Median(ICollection<Vector2>)
      • Median(ICollection<Vector2>)
      • Median(ICollection<Vector3>)
      • Median(ICollection<Vector3>)
      • Median(IEnumerable<Vector2>)
      • Median(IEnumerable<Vector2>)
      • Median(IEnumerable<Vector3>)
      • Median(IEnumerable<Vector3>)
      • Mul(Vector2, Vector2)
      • Mul(Vector2, Vector2)
      • Mul(Vector3, Vector3)
      • Mul(Vector3, Vector3)
      • RadialMapping(Vector3, Single, Single, Int32, Int32, Int32, Int32)
      • RadialMapping(Vector3, Single, Single, Int32, Int32, Int32, Int32)
      • RotateAround(Vector3, Vector3, Quaternion)
      • RotateAround(Vector3, Vector3, Quaternion)
      • RotateAround(Vector3, Vector3, Vector3)
      • RotateAround(Vector3, Vector3, Vector3)
      • ScatterMapping(Vector3, Single)
      • ScatterMapping(Vector3, Single)
      • SphericalMapping(Vector3, Single)
      • SphericalMapping(Vector3, Single)
      • TransformPoint(Vector3, Vector3, Quaternion, Vector3)
      • TransformPoint(Vector3, Vector3, Quaternion, Vector3)
    Back to top Generated by DocFX