Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    Double3 Struct

    Namespace: Stride.Core.Mathematics
    Assembly: Stride.Core.Mathematics.dll

    Represents a three dimensional mathematical vector with double-precision floats.

    [DataContract("double3")]
    [DataStyle(DataStyle.Compact)]
    public struct Double3 : IEquatable<Double3>, IFormattable
    Name Description
    Constructors
    Double3(Double2, Double)

    Initializes a new instance of the Double3 struct.

    Double3(Vector3)

    Initializes a new instance of the Double3 struct.

    Double3(Double)

    Initializes a new instance of the Double3 struct.

    Double3(Double, Double, Double)

    Initializes a new instance of the Double3 struct.

    Double3(Double[])

    Initializes a new instance of the Double3 struct.

    Fields
    One

    A Double3 with all of its components set to one.

    SizeInBytes

    The size of the Double3 type, in bytes.

    UnitX

    The X unit Double3 (1, 0, 0).

    UnitY

    The Y unit Double3 (0, 1, 0).

    UnitZ

    The Z unit Double3 (0, 0, 1).

    X

    The X component of the vector.

    Y

    The Y component of the vector.

    Z

    The Z component of the vector.

    Zero

    A Double3 with all of its components set to zero.

    Properties
    IsNormalized

    Gets a value indicting whether this instance is normalized.

    Item[Int32]

    Gets or sets the component at the specified index.

    Methods
    Add(Double3, Double3)

    Adds two vectors.

    Add(ref Double3, ref Double3, out Double3)

    Adds two vectors.

    Barycentric(Double3, Double3, Double3, Double, Double)

    Returns a Double3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.

    Barycentric(ref Double3, ref Double3, ref Double3, Double, Double, out Double3)

    Returns a Double3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.

    CatmullRom(Double3, Double3, Double3, Double3, Double)

    Performs a Catmull-Rom interpolation using the specified positions.

    CatmullRom(ref Double3, ref Double3, ref Double3, ref Double3, Double, out Double3)

    Performs a Catmull-Rom interpolation using the specified positions.

    Clamp(Double3, Double3, Double3)

    Restricts a value to be within a specified range.

    Clamp(ref Double3, ref Double3, ref Double3, out Double3)

    Restricts a value to be within a specified range.

    Cross(Double3, Double3)

    Calculates the cross product of two vectors.

    Cross(ref Double3, ref Double3, out Double3)

    Calculates the cross product of two vectors.

    Demodulate(Double3, Double3)

    Demodulates a vector with another by performing component-wise division.

    Demodulate(ref Double3, ref Double3, out Double3)

    Demodulates a vector with another by performing component-wise division.

    Distance(Double3, Double3)

    Calculates the distance between two vectors.

    Distance(ref Double3, ref Double3, out Double)

    Calculates the distance between two vectors.

    DistanceSquared(Double3, Double3)

    Calculates the squared distance between two vectors.

    DistanceSquared(ref Double3, ref Double3, out Double)

    Calculates the squared distance between two vectors.

    Divide(Double3, Double)

    Scales a vector by the given value.

    Divide(ref Double3, Double, out Double3)

    Scales a vector by the given value.

    Dot(Double3, Double3)

    Calculates the dot product of two vectors.

    Dot(ref Double3, ref Double3, out Double)

    Calculates the dot product of two vectors.

    Equals(Double3)

    Determines whether the specified Double3 is equal to this instance.

    Equals(Object)

    Determines whether the specified System.Object is equal to this instance.

    GetHashCode()

    Returns a hash code for this instance.

    Hermite(Double3, Double3, Double3, Double3, Double)

    Performs a Hermite spline interpolation.

    Hermite(ref Double3, ref Double3, ref Double3, ref Double3, Double, out Double3)

    Performs a Hermite spline interpolation.

    Length()

    Calculates the length of the vector.

    LengthSquared()

    Calculates the squared length of the vector.

    Lerp(Double3, Double3, Double)

    Performs a linear interpolation between two vectors.

    Lerp(ref Double3, ref Double3, Double, out Double3)

    Performs a linear interpolation between two vectors.

    Max(Double3, Double3)

    Returns a vector containing the largest components of the specified vectors.

    Max(ref Double3, ref Double3, out Double3)

    Returns a vector containing the smallest components of the specified vectors.

    Min(Double3, Double3)

    Returns a vector containing the smallest components of the specified vectors.

    Min(ref Double3, ref Double3, out Double3)

    Returns a vector containing the smallest components of the specified vectors.

    Modulate(Double3, Double3)

    Modulates a vector with another by performing component-wise multiplication.

    Modulate(ref Double3, ref Double3, out Double3)

    Modulates a vector with another by performing component-wise multiplication.

    Multiply(Double3, Double)

    Scales a vector by the given value.

    Multiply(ref Double3, Double, out Double3)

    Scales a vector by the given value.

    NearEqual(Double3, Double3, Double3)

    Tests whether one 3D vector is near another 3D vector.

    NearEqual(ref Double3, ref Double3, ref Double3)

    Tests whether one 3D vector is near another 3D vector.

    Negate(Double3)

    Reverses the direction of a given vector.

    Negate(ref Double3, out Double3)

    Reverses the direction of a given vector.

    Normalize()

    Converts the vector into a unit vector.

    Normalize(Double3)

    Converts the vector into a unit vector.

    Normalize(ref Double3, out Double3)

    Converts the vector into a unit vector.

    Orthogonalize(Double3[], Double3[])

    Orthogonalizes a list of vectors.

    Orthonormalize(Double3[], Double3[])

    Orthonormalizes a list of vectors.

    Pow(Double)

    Raises the exponent for each components.

    Project(Double3, Double, Double, Double, Double, Double, Double, Matrix)

    Projects a 3D vector from object space into screen space.

    Project(ref Double3, Double, Double, Double, Double, Double, Double, ref Matrix, out Double3)

    Projects a 3D vector from object space into screen space.

    Reflect(Double3, Double3)

    Returns the reflection of a vector off a surface that has the specified normal.

    Reflect(ref Double3, ref Double3, out Double3)

    Returns the reflection of a vector off a surface that has the specified normal.

    RotationYawPitchRoll(Quaternion)

    Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion.

    RotationYawPitchRoll(ref Quaternion, out Double3)

    Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion.

    SmoothStep(Double3, Double3, Double)

    Performs a cubic interpolation between two vectors.

    SmoothStep(ref Double3, ref Double3, Double, out Double3)

    Performs a cubic interpolation between two vectors.

    Subtract(Double3, Double3)

    Subtracts two vectors.

    Subtract(ref Double3, ref Double3, out Double3)

    Subtracts two vectors.

    ToArray()

    Creates an array containing the elements of the vector.

    ToString()

    Returns a System.String that represents this instance.

    ToString(IFormatProvider)

    Returns a System.String that represents this instance.

    ToString(String)

    Returns a System.String that represents this instance.

    ToString(String, IFormatProvider)

    Returns a System.String that represents this instance.

    Transform(Double3, Matrix)

    Transforms a 3D vector by the given Matrix.

    Transform(Double3, Quaternion)

    Transforms a 3D vector by the given Quaternion rotation.

    Transform(ref Double3, ref Matrix, out Double3)

    Transforms a 3D vector by the given Matrix.

    Transform(ref Double3, ref Matrix, out Double4)

    Transforms a 3D vector by the given Matrix.

    Transform(ref Double3, ref Quaternion, out Double3)

    Transforms a 3D vector by the given Quaternion rotation.

    Transform(Double3[], ref Matrix, Double4[])

    Transforms an array of 3D vectors by the given Matrix.

    Transform(Double3[], ref Quaternion, Double3[])

    Transforms an array of vectors by the given Quaternion rotation.

    TransformCoordinate(Double3, Matrix)

    Performs a coordinate transformation using the given Matrix.

    TransformCoordinate(ref Double3, ref Matrix, out Double3)

    Performs a coordinate transformation using the given Matrix.

    TransformCoordinate(Double3[], ref Matrix, Double3[])

    Performs a coordinate transformation on an array of vectors using the given Matrix.

    TransformNormal(Double3, Matrix)

    Performs a normal transformation using the given Matrix.

    TransformNormal(ref Double3, ref Matrix, out Double3)

    Performs a normal transformation using the given Matrix.

    TransformNormal(Double3[], ref Matrix, Double3[])

    Performs a normal transformation on an array of vectors using the given Matrix.

    Unproject(Double3, Double, Double, Double, Double, Double, Double, Matrix)

    Projects a 3D vector from screen space into object space.

    Unproject(ref Double3, Double, Double, Double, Double, Double, Double, ref Matrix, out Double3)

    Projects a 3D vector from screen space into object space.

    Operators
    Addition(Double3, Double3)

    Adds two vectors.

    Addition(Double3, Double)

    Adds a vector with the given value.

    Division(Double3, Double3)

    Divides a vector by the given vector, component-wise.

    Division(Double3, Double)

    Scales a vector by the given value.

    Division(Double, Double3)

    Divides a numerator by a vector.

    Equality(Double3, Double3)

    Tests for equality between two objects.

    Explicit(Double3 to Double2)

    Performs an explicit conversion from Double3 to Double2.

    Explicit(Double3 to Double4)

    Performs an explicit conversion from Double3 to Double4.

    Explicit(Double3 to Half3)

    Performs an explicit conversion from Double3 to Half3.

    Explicit(Double3 to Vector3)

    Performs an explicit conversion from Double3 to Vector3.

    Explicit(Half3 to Double3)

    Performs an explicit conversion from Half3 to Double3.

    Implicit(Vector3 to Double3)

    Performs an implicit conversion from Vector3 to Double3.

    Inequality(Double3, Double3)

    Tests for inequality between two objects.

    Multiply(Double3, Double3)

    Modulates a vector with another by performing component-wise multiplication.

    Multiply(Double3, Double)

    Scales a vector by the given value.

    Multiply(Double, Double3)

    Scales a vector by the given value.

    Subtraction(Double3, Double3)

    Subtracts two vectors.

    Subtraction(Double3, Double)

    Substracts a vector by the given value.

    UnaryNegation(Double3)

    Reverses the direction of a given vector.

    UnaryPlus(Double3)

    Assert a vector (return it unchanged).

    | Improve this Doc View Source

    Constructors


    Double3(Double2, Double)

    Initializes a new instance of the Double3 struct.

    public Double3(Double2 value, double z)
    Parameters
    Type Name Description
    Double2 value

    A vector containing the values with which to initialize the X and Y components.

    System.Double z

    Initial value for the Z component of the vector.


    Double3(Vector3)

    Initializes a new instance of the Double3 struct.

    public Double3(Vector3 v)
    Parameters
    Type Name Description
    Vector3 v

    The Vector3 to construct the Double3 from.


    Double3(Double)

    Initializes a new instance of the Double3 struct.

    public Double3(double value)
    Parameters
    Type Name Description
    System.Double value

    The value that will be assigned to all components.


    Double3(Double, Double, Double)

    Initializes a new instance of the Double3 struct.

    public Double3(double x, double y, double z)
    Parameters
    Type Name Description
    System.Double x

    Initial value for the X component of the vector.

    System.Double y

    Initial value for the Y component of the vector.

    System.Double z

    Initial value for the Z component of the vector.


    Double3(Double[])

    Initializes a new instance of the Double3 struct.

    public Double3(double[] values)
    Parameters
    Type Name Description
    System.Double[] values

    The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when values is null.

    System.ArgumentOutOfRangeException

    Thrown when values contains more or less than three elements.

    | Improve this Doc View Source

    Fields


    One

    A Double3 with all of its components set to one.

    public static readonly Double3 One
    Field Value
    Type Description
    Double3

    SizeInBytes

    The size of the Double3 type, in bytes.

    public static readonly int SizeInBytes
    Field Value
    Type Description
    System.Int32

    UnitX

    The X unit Double3 (1, 0, 0).

    public static readonly Double3 UnitX
    Field Value
    Type Description
    Double3

    UnitY

    The Y unit Double3 (0, 1, 0).

    public static readonly Double3 UnitY
    Field Value
    Type Description
    Double3

    UnitZ

    The Z unit Double3 (0, 0, 1).

    public static readonly Double3 UnitZ
    Field Value
    Type Description
    Double3

    X

    The X component of the vector.

    [DataMember(0)]
    public double X
    Field Value
    Type Description
    System.Double

    Y

    The Y component of the vector.

    [DataMember(1)]
    public double Y
    Field Value
    Type Description
    System.Double

    Z

    The Z component of the vector.

    [DataMember(2)]
    public double Z
    Field Value
    Type Description
    System.Double

    Zero

    A Double3 with all of its components set to zero.

    public static readonly Double3 Zero
    Field Value
    Type Description
    Double3
    | Improve this Doc View Source

    Properties


    IsNormalized

    Gets a value indicting whether this instance is normalized.

    public readonly bool IsNormalized { get; }
    Property Value
    Type Description
    System.Boolean

    Item[Int32]

    Gets or sets the component at the specified index.

    public double this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index

    The index of the component to access. Use 0 for the X component, 1 for the Y component, and 2 for the Z component.

    Property Value
    Type Description
    System.Double

    The value of the X, Y, or Z component, depending on the index.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    Thrown when the index is out of the range [0, 2].

    | Improve this Doc View Source

    Methods


    Add(Double3, Double3)

    Adds two vectors.

    public static Double3 Add(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first vector to add.

    Double3 right

    The second vector to add.

    Returns
    Type Description
    Double3

    The sum of the two vectors.


    Add(ref Double3, ref Double3, out Double3)

    Adds two vectors.

    public static void Add(ref Double3 left, ref Double3 right, out Double3 result)
    Parameters
    Type Name Description
    Double3 left

    The first vector to add.

    Double3 right

    The second vector to add.

    Double3 result

    When the method completes, contains the sum of the two vectors.


    Barycentric(Double3, Double3, Double3, Double, Double)

    Returns a Double3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.

    public static Double3 Barycentric(Double3 value1, Double3 value2, Double3 value3, double amount1, double amount2)
    Parameters
    Type Name Description
    Double3 value1

    A Double3 containing the 3D Cartesian coordinates of vertex 1 of the triangle.

    Double3 value2

    A Double3 containing the 3D Cartesian coordinates of vertex 2 of the triangle.

    Double3 value3

    A Double3 containing the 3D Cartesian coordinates of vertex 3 of the triangle.

    System.Double amount1

    Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2).

    System.Double amount2

    Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3).

    Returns
    Type Description
    Double3

    A new Double3 containing the 3D Cartesian coordinates of the specified point.


    Barycentric(ref Double3, ref Double3, ref Double3, Double, Double, out Double3)

    Returns a Double3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.

    public static void Barycentric(ref Double3 value1, ref Double3 value2, ref Double3 value3, double amount1, double amount2, out Double3 result)
    Parameters
    Type Name Description
    Double3 value1

    A Double3 containing the 3D Cartesian coordinates of vertex 1 of the triangle.

    Double3 value2

    A Double3 containing the 3D Cartesian coordinates of vertex 2 of the triangle.

    Double3 value3

    A Double3 containing the 3D Cartesian coordinates of vertex 3 of the triangle.

    System.Double amount1

    Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in value2).

    System.Double amount2

    Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in value3).

    Double3 result

    When the method completes, contains the 3D Cartesian coordinates of the specified point.


    CatmullRom(Double3, Double3, Double3, Double3, Double)

    Performs a Catmull-Rom interpolation using the specified positions.

    public static Double3 CatmullRom(Double3 value1, Double3 value2, Double3 value3, Double3 value4, double amount)
    Parameters
    Type Name Description
    Double3 value1

    The first position in the interpolation.

    Double3 value2

    The second position in the interpolation.

    Double3 value3

    The third position in the interpolation.

    Double3 value4

    The fourth position in the interpolation.

    System.Double amount

    Weighting factor.

    Returns
    Type Description
    Double3

    A vector that is the result of the Catmull-Rom interpolation.


    CatmullRom(ref Double3, ref Double3, ref Double3, ref Double3, Double, out Double3)

    Performs a Catmull-Rom interpolation using the specified positions.

    public static void CatmullRom(ref Double3 value1, ref Double3 value2, ref Double3 value3, ref Double3 value4, double amount, out Double3 result)
    Parameters
    Type Name Description
    Double3 value1

    The first position in the interpolation.

    Double3 value2

    The second position in the interpolation.

    Double3 value3

    The third position in the interpolation.

    Double3 value4

    The fourth position in the interpolation.

    System.Double amount

    Weighting factor.

    Double3 result

    When the method completes, contains the result of the Catmull-Rom interpolation.


    Clamp(Double3, Double3, Double3)

    Restricts a value to be within a specified range.

    public static Double3 Clamp(Double3 value, Double3 min, Double3 max)
    Parameters
    Type Name Description
    Double3 value

    The value to clamp.

    Double3 min

    The minimum value.

    Double3 max

    The maximum value.

    Returns
    Type Description
    Double3

    The clamped value.


    Clamp(ref Double3, ref Double3, ref Double3, out Double3)

    Restricts a value to be within a specified range.

    public static void Clamp(ref Double3 value, ref Double3 min, ref Double3 max, out Double3 result)
    Parameters
    Type Name Description
    Double3 value

    The value to clamp.

    Double3 min

    The minimum value.

    Double3 max

    The maximum value.

    Double3 result

    When the method completes, contains the clamped value.


    Cross(Double3, Double3)

    Calculates the cross product of two vectors.

    public static Double3 Cross(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    First source vector.

    Double3 right

    Second source vector.

    Returns
    Type Description
    Double3

    The cross product of the two vectors.


    Cross(ref Double3, ref Double3, out Double3)

    Calculates the cross product of two vectors.

    public static void Cross(ref Double3 left, ref Double3 right, out Double3 result)
    Parameters
    Type Name Description
    Double3 left

    First source vector.

    Double3 right

    Second source vector.

    Double3 result

    When the method completes, contains he cross product of the two vectors.


    Demodulate(Double3, Double3)

    Demodulates a vector with another by performing component-wise division.

    public static Double3 Demodulate(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first vector to demodulate.

    Double3 right

    The second vector to demodulate.

    Returns
    Type Description
    Double3

    The demodulated vector.


    Demodulate(ref Double3, ref Double3, out Double3)

    Demodulates a vector with another by performing component-wise division.

    public static void Demodulate(ref Double3 left, ref Double3 right, out Double3 result)
    Parameters
    Type Name Description
    Double3 left

    The first vector to demodulate.

    Double3 right

    The second vector to demodulate.

    Double3 result

    When the method completes, contains the demodulated vector.


    Distance(Double3, Double3)

    Calculates the distance between two vectors.

    public static double Distance(Double3 value1, Double3 value2)
    Parameters
    Type Name Description
    Double3 value1

    The first vector.

    Double3 value2

    The second vector.

    Returns
    Type Description
    System.Double

    The distance between the two vectors.

    Remarks

    DistanceSquared(Double3, Double3) may be preferred when only the relative distance is needed and speed is of the essence.


    Distance(ref Double3, ref Double3, out Double)

    Calculates the distance between two vectors.

    public static void Distance(ref Double3 value1, ref Double3 value2, out double result)
    Parameters
    Type Name Description
    Double3 value1

    The first vector.

    Double3 value2

    The second vector.

    System.Double result

    When the method completes, contains the distance between the two vectors.

    Remarks

    DistanceSquared(ref Double3, ref Double3, out Double) may be preferred when only the relative distance is needed and speed is of the essence.


    DistanceSquared(Double3, Double3)

    Calculates the squared distance between two vectors.

    public static double DistanceSquared(Double3 value1, Double3 value2)
    Parameters
    Type Name Description
    Double3 value1

    The first vector.

    Double3 value2

    The second vector.

    Returns
    Type Description
    System.Double

    The squared distance between the two vectors.

    Remarks

    Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots.


    DistanceSquared(ref Double3, ref Double3, out Double)

    Calculates the squared distance between two vectors.

    public static void DistanceSquared(ref Double3 value1, ref Double3 value2, out double result)
    Parameters
    Type Name Description
    Double3 value1

    The first vector.

    Double3 value2

    The second vector.

    System.Double result

    When the method completes, contains the squared distance between the two vectors.

    Remarks

    Distance squared is the value before taking the square root. Distance squared can often be used in place of distance if relative comparisons are being made. For example, consider three points A, B, and C. To determine whether B or C is further from A, compare the distance between A and B to the distance between A and C. Calculating the two distances involves two square roots, which are computationally expensive. However, using distance squared provides the same information and avoids calculating two square roots.


    Divide(Double3, Double)

    Scales a vector by the given value.

    public static Double3 Divide(Double3 value, double scale)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Returns
    Type Description
    Double3

    The scaled vector.


    Divide(ref Double3, Double, out Double3)

    Scales a vector by the given value.

    public static void Divide(ref Double3 value, double scale, out Double3 result)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Double3 result

    When the method completes, contains the scaled vector.


    Dot(Double3, Double3)

    Calculates the dot product of two vectors.

    public static double Dot(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    First source vector.

    Double3 right

    Second source vector.

    Returns
    Type Description
    System.Double

    The dot product of the two vectors.


    Dot(ref Double3, ref Double3, out Double)

    Calculates the dot product of two vectors.

    public static void Dot(ref Double3 left, ref Double3 right, out double result)
    Parameters
    Type Name Description
    Double3 left

    First source vector.

    Double3 right

    Second source vector.

    System.Double result

    When the method completes, contains the dot product of the two vectors.


    Equals(Double3)

    Determines whether the specified Double3 is equal to this instance.

    public bool Equals(Double3 other)
    Parameters
    Type Name Description
    Double3 other

    The Double3 to compare with this instance.

    Returns
    Type Description
    System.Boolean

    true if the specified Double3 is equal to this instance; otherwise, false.


    Equals(Object)

    Determines whether the specified System.Object is equal to this instance.

    public override bool Equals(object value)
    Parameters
    Type Name Description
    System.Object value

    The System.Object to compare with this instance.

    Returns
    Type Description
    System.Boolean

    true if the specified System.Object is equal to this instance; otherwise, false.

    Overrides
    System.ValueType.Equals(System.Object)

    GetHashCode()

    Returns a hash code for this instance.

    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

    A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

    Overrides
    System.ValueType.GetHashCode()

    Hermite(Double3, Double3, Double3, Double3, Double)

    Performs a Hermite spline interpolation.

    public static Double3 Hermite(Double3 value1, Double3 tangent1, Double3 value2, Double3 tangent2, double amount)
    Parameters
    Type Name Description
    Double3 value1

    First source position vector.

    Double3 tangent1

    First source tangent vector.

    Double3 value2

    Second source position vector.

    Double3 tangent2

    Second source tangent vector.

    System.Double amount

    Weighting factor.

    Returns
    Type Description
    Double3

    The result of the Hermite spline interpolation.


    Hermite(ref Double3, ref Double3, ref Double3, ref Double3, Double, out Double3)

    Performs a Hermite spline interpolation.

    public static void Hermite(ref Double3 value1, ref Double3 tangent1, ref Double3 value2, ref Double3 tangent2, double amount, out Double3 result)
    Parameters
    Type Name Description
    Double3 value1

    First source position vector.

    Double3 tangent1

    First source tangent vector.

    Double3 value2

    Second source position vector.

    Double3 tangent2

    Second source tangent vector.

    System.Double amount

    Weighting factor.

    Double3 result

    When the method completes, contains the result of the Hermite spline interpolation.


    Length()

    Calculates the length of the vector.

    public double Length()
    Returns
    Type Description
    System.Double

    The length of the vector.

    Remarks

    LengthSquared() may be preferred when only the relative length is needed and speed is of the essence.


    LengthSquared()

    Calculates the squared length of the vector.

    public double LengthSquared()
    Returns
    Type Description
    System.Double

    The squared length of the vector.

    Remarks

    This method may be preferred to Length() when only a relative length is needed and speed is of the essence.


    Lerp(Double3, Double3, Double)

    Performs a linear interpolation between two vectors.

    public static Double3 Lerp(Double3 start, Double3 end, double amount)
    Parameters
    Type Name Description
    Double3 start

    Start vector.

    Double3 end

    End vector.

    System.Double amount

    Value between 0 and 1 indicating the weight of end.

    Returns
    Type Description
    Double3

    The linear interpolation of the two vectors.

    Remarks

    This method performs the linear interpolation based on the following formula.

    start + (end - start) * amount

    Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned.


    Lerp(ref Double3, ref Double3, Double, out Double3)

    Performs a linear interpolation between two vectors.

    public static void Lerp(ref Double3 start, ref Double3 end, double amount, out Double3 result)
    Parameters
    Type Name Description
    Double3 start

    Start vector.

    Double3 end

    End vector.

    System.Double amount

    Value between 0 and 1 indicating the weight of end.

    Double3 result

    When the method completes, contains the linear interpolation of the two vectors.

    Remarks

    This method performs the linear interpolation based on the following formula.

    start + (end - start) * amount

    Passing amount a value of 0 will cause start to be returned; a value of 1 will cause end to be returned.


    Max(Double3, Double3)

    Returns a vector containing the largest components of the specified vectors.

    public static Double3 Max(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first source vector.

    Double3 right

    The second source vector.

    Returns
    Type Description
    Double3

    A vector containing the largest components of the source vectors.


    Max(ref Double3, ref Double3, out Double3)

    Returns a vector containing the smallest components of the specified vectors.

    public static void Max(ref Double3 left, ref Double3 right, out Double3 result)
    Parameters
    Type Name Description
    Double3 left

    The first source vector.

    Double3 right

    The second source vector.

    Double3 result

    When the method completes, contains an new vector composed of the largest components of the source vectors.


    Min(Double3, Double3)

    Returns a vector containing the smallest components of the specified vectors.

    public static Double3 Min(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first source vector.

    Double3 right

    The second source vector.

    Returns
    Type Description
    Double3

    A vector containing the smallest components of the source vectors.


    Min(ref Double3, ref Double3, out Double3)

    Returns a vector containing the smallest components of the specified vectors.

    public static void Min(ref Double3 left, ref Double3 right, out Double3 result)
    Parameters
    Type Name Description
    Double3 left

    The first source vector.

    Double3 right

    The second source vector.

    Double3 result

    When the method completes, contains an new vector composed of the smallest components of the source vectors.


    Modulate(Double3, Double3)

    Modulates a vector with another by performing component-wise multiplication.

    public static Double3 Modulate(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first vector to modulate.

    Double3 right

    The second vector to modulate.

    Returns
    Type Description
    Double3

    The modulated vector.


    Modulate(ref Double3, ref Double3, out Double3)

    Modulates a vector with another by performing component-wise multiplication.

    public static void Modulate(ref Double3 left, ref Double3 right, out Double3 result)
    Parameters
    Type Name Description
    Double3 left

    The first vector to modulate.

    Double3 right

    The second vector to modulate.

    Double3 result

    When the method completes, contains the modulated vector.


    Multiply(Double3, Double)

    Scales a vector by the given value.

    public static Double3 Multiply(Double3 value, double scale)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Returns
    Type Description
    Double3

    The scaled vector.


    Multiply(ref Double3, Double, out Double3)

    Scales a vector by the given value.

    public static void Multiply(ref Double3 value, double scale, out Double3 result)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Double3 result

    When the method completes, contains the scaled vector.


    NearEqual(Double3, Double3, Double3)

    Tests whether one 3D vector is near another 3D vector.

    public static bool NearEqual(Double3 left, Double3 right, Double3 epsilon)
    Parameters
    Type Name Description
    Double3 left

    The left vector.

    Double3 right

    The right vector.

    Double3 epsilon

    The epsilon.

    Returns
    Type Description
    System.Boolean

    true if left and right are near another 3D, false otherwise


    NearEqual(ref Double3, ref Double3, ref Double3)

    Tests whether one 3D vector is near another 3D vector.

    public static bool NearEqual(ref Double3 left, ref Double3 right, ref Double3 epsilon)
    Parameters
    Type Name Description
    Double3 left

    The left vector.

    Double3 right

    The right vector.

    Double3 epsilon

    The epsilon.

    Returns
    Type Description
    System.Boolean

    true if left and right are near another 3D, false otherwise


    Negate(Double3)

    Reverses the direction of a given vector.

    public static Double3 Negate(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The vector to negate.

    Returns
    Type Description
    Double3

    A vector facing in the opposite direction.


    Negate(ref Double3, out Double3)

    Reverses the direction of a given vector.

    public static void Negate(ref Double3 value, out Double3 result)
    Parameters
    Type Name Description
    Double3 value

    The vector to negate.

    Double3 result

    When the method completes, contains a vector facing in the opposite direction.


    Normalize()

    Converts the vector into a unit vector.

    public void Normalize()

    Normalize(Double3)

    Converts the vector into a unit vector.

    public static Double3 Normalize(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The vector to normalize.

    Returns
    Type Description
    Double3

    The normalized vector.


    Normalize(ref Double3, out Double3)

    Converts the vector into a unit vector.

    public static void Normalize(ref Double3 value, out Double3 result)
    Parameters
    Type Name Description
    Double3 value

    The vector to normalize.

    Double3 result

    When the method completes, contains the normalized vector.


    Orthogonalize(Double3[], Double3[])

    Orthogonalizes a list of vectors.

    public static void Orthogonalize(Double3[] destination, params Double3[] source)
    Parameters
    Type Name Description
    Double3[] destination

    The list of orthogonalized vectors.

    Double3[] source

    The list of vectors to orthogonalize.

    Remarks

    Orthogonalization is the process of making all vectors orthogonal to each other. This means that any given vector in the list will be orthogonal to any other given vector in the list.

    Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when source or destination is null.

    System.ArgumentOutOfRangeException

    Thrown when destination is shorter in length than source.


    Orthonormalize(Double3[], Double3[])

    Orthonormalizes a list of vectors.

    public static void Orthonormalize(Double3[] destination, params Double3[] source)
    Parameters
    Type Name Description
    Double3[] destination

    The list of orthonormalized vectors.

    Double3[] source

    The list of vectors to orthonormalize.

    Remarks

    Orthonormalization is the process of making all vectors orthogonal to each other and making all vectors of unit length. This means that any given vector will be orthogonal to any other given vector in the list.

    Because this method uses the modified Gram-Schmidt process, the resulting vectors tend to be numerically unstable. The numeric stability decreases according to the vectors position in the list so that the first vector is the most stable and the last vector is the least stable.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when source or destination is null.

    System.ArgumentOutOfRangeException

    Thrown when destination is shorter in length than source.


    Pow(Double)

    Raises the exponent for each components.

    public void Pow(double exponent)
    Parameters
    Type Name Description
    System.Double exponent

    The exponent.


    Project(Double3, Double, Double, Double, Double, Double, Double, Matrix)

    Projects a 3D vector from object space into screen space.

    public static Double3 Project(Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, Matrix worldViewProjection)
    Parameters
    Type Name Description
    Double3 vector

    The vector to project.

    System.Double x

    The X position of the viewport.

    System.Double y

    The Y position of the viewport.

    System.Double width

    The width of the viewport.

    System.Double height

    The height of the viewport.

    System.Double minZ

    The minimum depth of the viewport.

    System.Double maxZ

    The maximum depth of the viewport.

    Matrix worldViewProjection

    The combined world-view-projection matrix.

    Returns
    Type Description
    Double3

    The vector in screen space.


    Project(ref Double3, Double, Double, Double, Double, Double, Double, ref Matrix, out Double3)

    Projects a 3D vector from object space into screen space.

    public static void Project(ref Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, ref Matrix worldViewProjection, out Double3 result)
    Parameters
    Type Name Description
    Double3 vector

    The vector to project.

    System.Double x

    The X position of the viewport.

    System.Double y

    The Y position of the viewport.

    System.Double width

    The width of the viewport.

    System.Double height

    The height of the viewport.

    System.Double minZ

    The minimum depth of the viewport.

    System.Double maxZ

    The maximum depth of the viewport.

    Matrix worldViewProjection

    The combined world-view-projection matrix.

    Double3 result

    When the method completes, contains the vector in screen space.


    Reflect(Double3, Double3)

    Returns the reflection of a vector off a surface that has the specified normal.

    public static Double3 Reflect(Double3 vector, Double3 normal)
    Parameters
    Type Name Description
    Double3 vector

    The source vector.

    Double3 normal

    Normal of the surface.

    Returns
    Type Description
    Double3

    The reflected vector.

    Remarks

    Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it.


    Reflect(ref Double3, ref Double3, out Double3)

    Returns the reflection of a vector off a surface that has the specified normal.

    public static void Reflect(ref Double3 vector, ref Double3 normal, out Double3 result)
    Parameters
    Type Name Description
    Double3 vector

    The source vector.

    Double3 normal

    Normal of the surface.

    Double3 result

    When the method completes, contains the reflected vector.

    Remarks

    Reflect only gives the direction of a reflection off a surface, it does not determine whether the original vector was close enough to the surface to hit it.


    RotationYawPitchRoll(Quaternion)

    Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion.

    public static Double3 RotationYawPitchRoll(Quaternion quaternion)
    Parameters
    Type Name Description
    Quaternion quaternion

    The input rotation as quaternion

    Returns
    Type Description
    Double3

    The equivation yaw/pitch/roll rotation


    RotationYawPitchRoll(ref Quaternion, out Double3)

    Calculate the yaw/pitch/roll rotation equivalent to the provided quaterion.

    public static void RotationYawPitchRoll(ref Quaternion quaternion, out Double3 yawPitchRoll)
    Parameters
    Type Name Description
    Quaternion quaternion

    The input rotation as quaternion

    Double3 yawPitchRoll

    The equivation yaw/pitch/roll rotation


    SmoothStep(Double3, Double3, Double)

    Performs a cubic interpolation between two vectors.

    public static Double3 SmoothStep(Double3 start, Double3 end, double amount)
    Parameters
    Type Name Description
    Double3 start

    Start vector.

    Double3 end

    End vector.

    System.Double amount

    Value between 0 and 1 indicating the weight of end.

    Returns
    Type Description
    Double3

    The cubic interpolation of the two vectors.


    SmoothStep(ref Double3, ref Double3, Double, out Double3)

    Performs a cubic interpolation between two vectors.

    public static void SmoothStep(ref Double3 start, ref Double3 end, double amount, out Double3 result)
    Parameters
    Type Name Description
    Double3 start

    Start vector.

    Double3 end

    End vector.

    System.Double amount

    Value between 0 and 1 indicating the weight of end.

    Double3 result

    When the method completes, contains the cubic interpolation of the two vectors.


    Subtract(Double3, Double3)

    Subtracts two vectors.

    public static Double3 Subtract(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first vector to subtract.

    Double3 right

    The second vector to subtract.

    Returns
    Type Description
    Double3

    The difference of the two vectors.


    Subtract(ref Double3, ref Double3, out Double3)

    Subtracts two vectors.

    public static void Subtract(ref Double3 left, ref Double3 right, out Double3 result)
    Parameters
    Type Name Description
    Double3 left

    The first vector to subtract.

    Double3 right

    The second vector to subtract.

    Double3 result

    When the method completes, contains the difference of the two vectors.


    ToArray()

    Creates an array containing the elements of the vector.

    public double[] ToArray()
    Returns
    Type Description
    System.Double[]

    A three-element array containing the components of the vector.


    ToString()

    Returns a System.String that represents this instance.

    public override string ToString()
    Returns
    Type Description
    System.String

    A System.String that represents this instance.

    Overrides
    System.ValueType.ToString()

    ToString(IFormatProvider)

    Returns a System.String that represents this instance.

    public string ToString(IFormatProvider formatProvider)
    Parameters
    Type Name Description
    System.IFormatProvider formatProvider

    The format provider.

    Returns
    Type Description
    System.String

    A System.String that represents this instance.


    ToString(String)

    Returns a System.String that represents this instance.

    public string ToString(string format)
    Parameters
    Type Name Description
    System.String format

    The format.

    Returns
    Type Description
    System.String

    A System.String that represents this instance.


    ToString(String, IFormatProvider)

    Returns a System.String that represents this instance.

    public string ToString(string format, IFormatProvider formatProvider)
    Parameters
    Type Name Description
    System.String format

    The format.

    System.IFormatProvider formatProvider

    The format provider.

    Returns
    Type Description
    System.String

    A System.String that represents this instance.


    Transform(Double3, Matrix)

    Transforms a 3D vector by the given Matrix.

    public static Double4 Transform(Double3 vector, Matrix transform)
    Parameters
    Type Name Description
    Double3 vector

    The source vector.

    Matrix transform

    The transformation Matrix.

    Returns
    Type Description
    Double4

    The transformed Double4.


    Transform(Double3, Quaternion)

    Transforms a 3D vector by the given Quaternion rotation.

    public static Double3 Transform(Double3 vector, Quaternion rotation)
    Parameters
    Type Name Description
    Double3 vector

    The vector to rotate.

    Quaternion rotation

    The Quaternion rotation to apply.

    Returns
    Type Description
    Double3

    The transformed Double4.


    Transform(ref Double3, ref Matrix, out Double3)

    Transforms a 3D vector by the given Matrix.

    public static void Transform(ref Double3 vector, ref Matrix transform, out Double3 result)
    Parameters
    Type Name Description
    Double3 vector

    The source vector.

    Matrix transform

    The transformation Matrix.

    Double3 result

    When the method completes, contains the transformed Double3.


    Transform(ref Double3, ref Matrix, out Double4)

    Transforms a 3D vector by the given Matrix.

    public static void Transform(ref Double3 vector, ref Matrix transform, out Double4 result)
    Parameters
    Type Name Description
    Double3 vector

    The source vector.

    Matrix transform

    The transformation Matrix.

    Double4 result

    When the method completes, contains the transformed Double4.


    Transform(ref Double3, ref Quaternion, out Double3)

    Transforms a 3D vector by the given Quaternion rotation.

    public static void Transform(ref Double3 vector, ref Quaternion rotation, out Double3 result)
    Parameters
    Type Name Description
    Double3 vector

    The vector to rotate.

    Quaternion rotation

    The Quaternion rotation to apply.

    Double3 result

    When the method completes, contains the transformed Double4.


    Transform(Double3[], ref Matrix, Double4[])

    Transforms an array of 3D vectors by the given Matrix.

    public static void Transform(Double3[] source, ref Matrix transform, Double4[] destination)
    Parameters
    Type Name Description
    Double3[] source

    The array of vectors to transform.

    Matrix transform

    The transformation Matrix.

    Double4[] destination

    The array for which the transformed vectors are stored.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when source or destination is null.

    System.ArgumentOutOfRangeException

    Thrown when destination is shorter in length than source.


    Transform(Double3[], ref Quaternion, Double3[])

    Transforms an array of vectors by the given Quaternion rotation.

    public static void Transform(Double3[] source, ref Quaternion rotation, Double3[] destination)
    Parameters
    Type Name Description
    Double3[] source

    The array of vectors to transform.

    Quaternion rotation

    The Quaternion rotation to apply.

    Double3[] destination

    The array for which the transformed vectors are stored. This array may be the same array as source.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when source or destination is null.

    System.ArgumentOutOfRangeException

    Thrown when destination is shorter in length than source.


    TransformCoordinate(Double3, Matrix)

    Performs a coordinate transformation using the given Matrix.

    public static Double3 TransformCoordinate(Double3 coordinate, Matrix transform)
    Parameters
    Type Name Description
    Double3 coordinate

    The coordinate vector to transform.

    Matrix transform

    The transformation Matrix.

    Returns
    Type Description
    Double3

    The transformed coordinates.

    Remarks

    A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored.


    TransformCoordinate(ref Double3, ref Matrix, out Double3)

    Performs a coordinate transformation using the given Matrix.

    public static void TransformCoordinate(ref Double3 coordinate, ref Matrix transform, out Double3 result)
    Parameters
    Type Name Description
    Double3 coordinate

    The coordinate vector to transform.

    Matrix transform

    The transformation Matrix.

    Double3 result

    When the method completes, contains the transformed coordinates.

    Remarks

    A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored.


    TransformCoordinate(Double3[], ref Matrix, Double3[])

    Performs a coordinate transformation on an array of vectors using the given Matrix.

    public static void TransformCoordinate(Double3[] source, ref Matrix transform, Double3[] destination)
    Parameters
    Type Name Description
    Double3[] source

    The array of coordinate vectors to trasnform.

    Matrix transform

    The transformation Matrix.

    Double3[] destination

    The array for which the transformed vectors are stored. This array may be the same array as source.

    Remarks

    A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the wcomponent to be one and therefore makes the vector homogeneous. The homogeneous vector is often prefered when working with coordinates as the w component can safely be ignored.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when source or destination is null.

    System.ArgumentOutOfRangeException

    Thrown when destination is shorter in length than source.


    TransformNormal(Double3, Matrix)

    Performs a normal transformation using the given Matrix.

    public static Double3 TransformNormal(Double3 normal, Matrix transform)
    Parameters
    Type Name Description
    Double3 normal

    The normal vector to transform.

    Matrix transform

    The transformation Matrix.

    Returns
    Type Description
    Double3

    The transformed normal.

    Remarks

    A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.


    TransformNormal(ref Double3, ref Matrix, out Double3)

    Performs a normal transformation using the given Matrix.

    public static void TransformNormal(ref Double3 normal, ref Matrix transform, out Double3 result)
    Parameters
    Type Name Description
    Double3 normal

    The normal vector to transform.

    Matrix transform

    The transformation Matrix.

    Double3 result

    When the method completes, contains the transformed normal.

    Remarks

    A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.


    TransformNormal(Double3[], ref Matrix, Double3[])

    Performs a normal transformation on an array of vectors using the given Matrix.

    public static void TransformNormal(Double3[] source, ref Matrix transform, Double3[] destination)
    Parameters
    Type Name Description
    Double3[] source

    The array of normal vectors to transform.

    Matrix transform

    The transformation Matrix.

    Double3[] destination

    The array for which the transformed vectors are stored. This array may be the same array as source.

    Remarks

    A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth collumn of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often prefered for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.

    Exceptions
    Type Condition
    System.ArgumentNullException

    Thrown when source or destination is null.

    System.ArgumentOutOfRangeException

    Thrown when destination is shorter in length than source.


    Unproject(Double3, Double, Double, Double, Double, Double, Double, Matrix)

    Projects a 3D vector from screen space into object space.

    public static Double3 Unproject(Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, Matrix worldViewProjection)
    Parameters
    Type Name Description
    Double3 vector

    The vector to project.

    System.Double x

    The X position of the viewport.

    System.Double y

    The Y position of the viewport.

    System.Double width

    The width of the viewport.

    System.Double height

    The height of the viewport.

    System.Double minZ

    The minimum depth of the viewport.

    System.Double maxZ

    The maximum depth of the viewport.

    Matrix worldViewProjection

    The combined world-view-projection matrix.

    Returns
    Type Description
    Double3

    The vector in object space.


    Unproject(ref Double3, Double, Double, Double, Double, Double, Double, ref Matrix, out Double3)

    Projects a 3D vector from screen space into object space.

    public static void Unproject(ref Double3 vector, double x, double y, double width, double height, double minZ, double maxZ, ref Matrix worldViewProjection, out Double3 result)
    Parameters
    Type Name Description
    Double3 vector

    The vector to project.

    System.Double x

    The X position of the viewport.

    System.Double y

    The Y position of the viewport.

    System.Double width

    The width of the viewport.

    System.Double height

    The height of the viewport.

    System.Double minZ

    The minimum depth of the viewport.

    System.Double maxZ

    The maximum depth of the viewport.

    Matrix worldViewProjection

    The combined world-view-projection matrix.

    Double3 result

    When the method completes, contains the vector in object space.

    | Improve this Doc View Source

    Operators


    Addition(Double3, Double3)

    Adds two vectors.

    public static Double3 operator +(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first vector to add.

    Double3 right

    The second vector to add.

    Returns
    Type Description
    Double3

    The sum of the two vectors.


    Addition(Double3, Double)

    Adds a vector with the given value.

    public static Double3 operator +(Double3 value, double scale)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Returns
    Type Description
    Double3

    The vector offset.


    Division(Double3, Double3)

    Divides a vector by the given vector, component-wise.

    public static Double3 operator /(Double3 value, Double3 by)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    Double3 by

    The by.

    Returns
    Type Description
    Double3

    The scaled vector.


    Division(Double3, Double)

    Scales a vector by the given value.

    public static Double3 operator /(Double3 value, double scale)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Returns
    Type Description
    Double3

    The scaled vector.


    Division(Double, Double3)

    Divides a numerator by a vector.

    public static Double3 operator /(double numerator, Double3 value)
    Parameters
    Type Name Description
    System.Double numerator

    The numerator.

    Double3 value

    The value.

    Returns
    Type Description
    Double3

    The scaled vector.


    Equality(Double3, Double3)

    Tests for equality between two objects.

    public static bool operator ==(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first value to compare.

    Double3 right

    The second value to compare.

    Returns
    Type Description
    System.Boolean

    true if left has the same value as right; otherwise, false.


    Explicit(Double3 to Double2)

    Performs an explicit conversion from Double3 to Double2.

    public static explicit operator Double2(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The value.

    Returns
    Type Description
    Double2

    The result of the conversion.


    Explicit(Double3 to Double4)

    Performs an explicit conversion from Double3 to Double4.

    public static explicit operator Double4(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The value.

    Returns
    Type Description
    Double4

    The result of the conversion.


    Explicit(Double3 to Half3)

    Performs an explicit conversion from Double3 to Half3.

    public static explicit operator Half3(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The value.

    Returns
    Type Description
    Half3

    The result of the conversion.


    Explicit(Double3 to Vector3)

    Performs an explicit conversion from Double3 to Vector3.

    public static explicit operator Vector3(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The value.

    Returns
    Type Description
    Vector3

    The result of the conversion.


    Explicit(Half3 to Double3)

    Performs an explicit conversion from Half3 to Double3.

    public static explicit operator Double3(Half3 value)
    Parameters
    Type Name Description
    Half3 value

    The value.

    Returns
    Type Description
    Double3

    The result of the conversion.


    Implicit(Vector3 to Double3)

    Performs an implicit conversion from Vector3 to Double3.

    public static implicit operator Double3(Vector3 value)
    Parameters
    Type Name Description
    Vector3 value

    The value.

    Returns
    Type Description
    Double3

    The result of the conversion.


    Inequality(Double3, Double3)

    Tests for inequality between two objects.

    public static bool operator !=(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first value to compare.

    Double3 right

    The second value to compare.

    Returns
    Type Description
    System.Boolean

    true if left has a different value than right; otherwise, false.


    Multiply(Double3, Double3)

    Modulates a vector with another by performing component-wise multiplication.

    public static Double3 operator *(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first vector to multiply.

    Double3 right

    The second vector to multiply.

    Returns
    Type Description
    Double3

    The multiplication of the two vectors.


    Multiply(Double3, Double)

    Scales a vector by the given value.

    public static Double3 operator *(Double3 value, double scale)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Returns
    Type Description
    Double3

    The scaled vector.


    Multiply(Double, Double3)

    Scales a vector by the given value.

    public static Double3 operator *(double scale, Double3 value)
    Parameters
    Type Name Description
    System.Double scale

    The amount by which to scale the vector.

    Double3 value

    The vector to scale.

    Returns
    Type Description
    Double3

    The scaled vector.


    Subtraction(Double3, Double3)

    Subtracts two vectors.

    public static Double3 operator -(Double3 left, Double3 right)
    Parameters
    Type Name Description
    Double3 left

    The first vector to subtract.

    Double3 right

    The second vector to subtract.

    Returns
    Type Description
    Double3

    The difference of the two vectors.


    Subtraction(Double3, Double)

    Substracts a vector by the given value.

    public static Double3 operator -(Double3 value, double scale)
    Parameters
    Type Name Description
    Double3 value

    The vector to scale.

    System.Double scale

    The amount by which to scale the vector.

    Returns
    Type Description
    Double3

    The vector offset.


    UnaryNegation(Double3)

    Reverses the direction of a given vector.

    public static Double3 operator -(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The vector to negate.

    Returns
    Type Description
    Double3

    A vector facing in the opposite direction.


    UnaryPlus(Double3)

    Assert a vector (return it unchanged).

    public static Double3 operator +(Double3 value)
    Parameters
    Type Name Description
    Double3 value

    The vector to assert (unchange).

    Returns
    Type Description
    Double3

    The asserted (unchanged) vector.


    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation