Struct Vector4

Namespace

Stride.Core.Mathematics

Assembly

Stride.Core.Mathematics.dll

Represents a four dimensional mathematical vector.

[DataContract("float4")]
[DataStyle(DataStyle.Compact)]
public struct Vector4 : IEquatable<Vector4>, ISpanFormattable, IFormattable

Implements

IEquatable<Vector4>

ISpanFormattable

IFormattable

Extension Methods

VectorExtensions.XY(Vector4)

VectorExtensions.XYZ(Vector4)

Constructors

Vector4(Vector2, float, float)

Initializes a new instance of the Vector4 struct.

public Vector4(Vector2 value, float z, float w)

Parameters

value Vector2

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

z float

Initial value for the Z component of the vector.

w float

Initial value for the W component of the vector.

Vector4(Vector3, float)

Initializes a new instance of the Vector4 struct.

public Vector4(Vector3 value, float w)

Parameters

value Vector3

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

w float

Initial value for the W component of the vector.

Vector4(float)

Initializes a new instance of the Vector4 struct.

public Vector4(float value)

Parameters

value float

The value that will be assigned to all components.

Vector4(float, float, float, float)

Initializes a new instance of the Vector4 struct.

public Vector4(float x, float y, float z, float w)

Parameters

x float

Initial value for the X component of the vector.

y float

Initial value for the Y component of the vector.

z float

Initial value for the Z component of the vector.

w float

Initial value for the W component of the vector.

Vector4(float[])

Initializes a new instance of the Vector4 struct.

public Vector4(float[] values)

Parameters

values float[]

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

Exceptions

ArgumentNullException

Thrown when values is null.

ArgumentOutOfRangeException

Thrown when values contains more or less than four elements.

Fields

One

A Vector4 with all of its components set to one.

public static readonly Vector4 One

Field Value

Vector4

SizeInBytes

The size of the Vector4 type, in bytes.

public static readonly int SizeInBytes

Field Value

int

UnitW

The W unit Vector4 (0, 0, 0, 1).

public static readonly Vector4 UnitW

Field Value

Vector4

UnitX

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

public static readonly Vector4 UnitX

Field Value

Vector4

UnitY

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

public static readonly Vector4 UnitY

Field Value

Vector4

UnitZ

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

public static readonly Vector4 UnitZ

Field Value

Vector4

W

The W component of the vector.

[DataMember(3)]
public float W

Field Value

float

X

The X component of the vector.

[DataMember(0)]
public float X

Field Value

float

Y

The Y component of the vector.

[DataMember(1)]
public float Y

Field Value

float

Z

The Z component of the vector.

[DataMember(2)]
public float Z

Field Value

float

Zero

A Vector4 with all of its components set to zero.

public static readonly Vector4 Zero

Field Value

Vector4

Properties

IsNormalized

Gets a value indicting whether this instance is normalized.

public readonly bool IsNormalized { get; }

Property Value

bool

this[int]

Gets or sets the component at the specified index.

public float this[int index] { readonly get; set; }

Parameters

index int

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

Property Value

float

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

Exceptions

ArgumentOutOfRangeException

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

Methods

Add(Vector4, Vector4)

Adds two vectors.

public static Vector4 Add(Vector4 left, Vector4 right)

Parameters

left Vector4

The first vector to add.

right Vector4

The second vector to add.

Returns

Vector4

The sum of the two vectors.

Add(ref readonly Vector4, ref readonly Vector4, out Vector4)

Adds two vectors.

public static void Add(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result)

Parameters

left Vector4

The first vector to add.

right Vector4

The second vector to add.

result Vector4

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

Barycentric(Vector4, Vector4, Vector4, float, float)

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

public static Vector4 Barycentric(Vector4 value1, Vector4 value2, Vector4 value3, float amount1, float amount2)

Parameters

value1 Vector4

A Vector4 containing the 4D Cartesian coordinates of vertex 1 of the triangle.

value2 Vector4

A Vector4 containing the 4D Cartesian coordinates of vertex 2 of the triangle.

value3 Vector4

A Vector4 containing the 4D Cartesian coordinates of vertex 3 of the triangle.

amount1 float

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

amount2 float

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

Returns

Vector4

A new Vector4 containing the 4D Cartesian coordinates of the specified point.

Barycentric(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, float, float, out Vector4)

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

public static void Barycentric(ref readonly Vector4 value1, ref readonly Vector4 value2, ref readonly Vector4 value3, float amount1, float amount2, out Vector4 result)

Parameters

value1 Vector4

A Vector4 containing the 4D Cartesian coordinates of vertex 1 of the triangle.

value2 Vector4

A Vector4 containing the 4D Cartesian coordinates of vertex 2 of the triangle.

value3 Vector4

A Vector4 containing the 4D Cartesian coordinates of vertex 3 of the triangle.

amount1 float

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

amount2 float

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

result Vector4

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

CatmullRom(Vector4, Vector4, Vector4, Vector4, float)

Performs a Catmull-Rom interpolation using the specified positions.

public static Vector4 CatmullRom(Vector4 value1, Vector4 value2, Vector4 value3, Vector4 value4, float amount)

Parameters

value1 Vector4

The first position in the interpolation.

value2 Vector4

The second position in the interpolation.

value3 Vector4

The third position in the interpolation.

value4 Vector4

The fourth position in the interpolation.

amount float

Weighting factor.

Returns

Vector4

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

CatmullRom(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, float, out Vector4)

Performs a Catmull-Rom interpolation using the specified positions.

public static void CatmullRom(ref readonly Vector4 value1, ref readonly Vector4 value2, ref readonly Vector4 value3, ref readonly Vector4 value4, float amount, out Vector4 result)

Parameters

value1 Vector4

The first position in the interpolation.

value2 Vector4

The second position in the interpolation.

value3 Vector4

The third position in the interpolation.

value4 Vector4

The fourth position in the interpolation.

amount float

Weighting factor.

result Vector4

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

Clamp(Vector4, Vector4, Vector4)

Restricts a value to be within a specified range.

public static Vector4 Clamp(Vector4 value, Vector4 min, Vector4 max)

Parameters

value Vector4

The value to clamp.

min Vector4

The minimum value.

max Vector4

The maximum value.

Returns

Vector4

The clamped value.

Clamp(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, out Vector4)

Restricts a value to be within a specified range.

public static void Clamp(ref readonly Vector4 value, ref readonly Vector4 min, ref readonly Vector4 max, out Vector4 result)

Parameters

value Vector4

The value to clamp.

min Vector4

The minimum value.

max Vector4

The maximum value.

result Vector4

When the method completes, contains the clamped value.

Deconstruct(out float, out float, out float, out float)

Deconstructs the vector's components into named variables.

public readonly void Deconstruct(out float x, out float y, out float z, out float w)

Parameters

x float

The X component

y float

The Y component

z float

The Z component

w float

The W component

Demodulate(Vector4, Vector4)

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

public static Vector4 Demodulate(Vector4 left, Vector4 right)

Parameters

left Vector4

The first vector to demodulate.

right Vector4

The second vector to demodulate.

Returns

Vector4

The demodulated vector.

Demodulate(ref readonly Vector4, ref readonly Vector4, out Vector4)

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

public static void Demodulate(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result)

Parameters

left Vector4

The first vector to demodulate.

right Vector4

The second vector to demodulate.

result Vector4

When the method completes, contains the demodulated vector.

Distance(Vector4, Vector4)

Calculates the distance between two vectors.

public static float Distance(Vector4 value1, Vector4 value2)

Parameters

value1 Vector4

The first vector.

value2 Vector4

The second vector.

Returns

float

The distance between the two vectors.

Remarks

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

Distance(ref readonly Vector4, ref readonly Vector4, out float)

Calculates the distance between two vectors.

public static void Distance(ref readonly Vector4 value1, ref readonly Vector4 value2, out float result)

Parameters

value1 Vector4

The first vector.

value2 Vector4

The second vector.

result float

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

Remarks

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

DistanceSquared(Vector4, Vector4)

Calculates the squared distance between two vectors.

public static float DistanceSquared(Vector4 value1, Vector4 value2)

Parameters

value1 Vector4

The first vector.

value2 Vector4

The second vector.

Returns

float

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 readonly Vector4, ref readonly Vector4, out float)

Calculates the squared distance between two vectors.

public static void DistanceSquared(ref readonly Vector4 value1, ref readonly Vector4 value2, out float result)

Parameters

value1 Vector4

The first vector.

value2 Vector4

The second vector.

result float

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(Vector4, float)

Scales a vector by the given value.

public static Vector4 Divide(Vector4 value, float scale)

Parameters

value Vector4

The vector to scale.

scale float

The amount by which to scale the vector.

Returns

Vector4

The scaled vector.

Divide(ref readonly Vector4, float, out Vector4)

Scales a vector by the given value.

public static void Divide(ref readonly Vector4 value, float scale, out Vector4 result)

Parameters

value Vector4

The vector to scale.

scale float

The amount by which to scale the vector.

result Vector4

When the method completes, contains the scaled vector.

Dot(Vector4, Vector4)

Calculates the dot product of two vectors.

public static float Dot(Vector4 left, Vector4 right)

Parameters

left Vector4

First source vector.

right Vector4

Second source vector.

Returns

float

The dot product of the two vectors.

Dot(ref readonly Vector4, ref readonly Vector4, out float)

Calculates the dot product of two vectors.

public static void Dot(ref readonly Vector4 left, ref readonly Vector4 right, out float result)

Parameters

left Vector4

First source vector

right Vector4

Second source vector.

result float

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

Equals(Vector4)

Determines whether the specified Vector4 is within ZeroTolerance for equality to this instance.

public readonly bool Equals(Vector4 other)

Parameters

other Vector4

The Vector4 to compare with this instance.

Returns

bool

true if the specified Vector4 is equal or almost equal to this instance; otherwise, false.

Equals(object?)

Determines whether the specified object is within ZeroTolerance for equality to this instance.

public override readonly bool Equals(object? value)

Parameters

value object

The object to compare with this instance.

Returns

bool

true if the specified object is equal or almost equal to this instance; otherwise, false.

EqualsStrict(Vector4)

Determines whether the specified Vector4 is exactly equal to this instance.

public readonly bool EqualsStrict(Vector4 other)

Parameters

other Vector4

The Vector4 to compare with this instance.

Returns

bool

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

GetHashCode()

Returns a hash code for this instance.

public override readonly int GetHashCode()

Returns

int

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

Hermite(Vector4, Vector4, Vector4, Vector4, float)

Performs a Hermite spline interpolation.

public static Vector4 Hermite(Vector4 value1, Vector4 tangent1, Vector4 value2, Vector4 tangent2, float amount)

Parameters

value1 Vector4

First source position vector.

tangent1 Vector4

First source tangent vector.

value2 Vector4

Second source position vector.

tangent2 Vector4

Second source tangent vector.

amount float

Weighting factor.

Returns

Vector4

The result of the Hermite spline interpolation.

Hermite(ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, ref readonly Vector4, float, out Vector4)

Performs a Hermite spline interpolation.

public static void Hermite(ref readonly Vector4 value1, ref readonly Vector4 tangent1, ref readonly Vector4 value2, ref readonly Vector4 tangent2, float amount, out Vector4 result)

Parameters

value1 Vector4

First source position vector.

tangent1 Vector4

First source tangent vector.

value2 Vector4

Second source position vector.

tangent2 Vector4

Second source tangent vector.

amount float

Weighting factor.

result Vector4

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

Length()

Calculates the length of the vector.

public readonly float Length()

Returns

float

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 readonly float LengthSquared()

Returns

float

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(Vector4, Vector4, float)

Performs a linear interpolation between two vectors.

public static Vector4 Lerp(Vector4 start, Vector4 end, float amount)

Parameters

start Vector4

Start vector.

end Vector4

End vector.

amount float

Value between 0 and 1 indicating the weight of end.

Returns

Vector4

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 readonly Vector4, ref readonly Vector4, float, out Vector4)

Performs a linear interpolation between two vectors.

public static void Lerp(ref readonly Vector4 start, ref readonly Vector4 end, float amount, out Vector4 result)

Parameters

start Vector4

Start vector.

end Vector4

End vector.

amount float

Value between 0 and 1 indicating the weight of end.

result Vector4

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(Vector4, Vector4)

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

public static Vector4 Max(Vector4 left, Vector4 right)

Parameters

left Vector4

The first source vector.

right Vector4

The second source vector.

Returns

Vector4

A vector containing the largest components of the source vectors.

Max(ref readonly Vector4, ref readonly Vector4, out Vector4)

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

public static void Max(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result)

Parameters

left Vector4

The first source vector.

right Vector4

The second source vector.

result Vector4

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

Min(Vector4, Vector4)

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

public static Vector4 Min(Vector4 left, Vector4 right)

Parameters

left Vector4

The first source vector.

right Vector4

The second source vector.

Returns

Vector4

A vector containing the smallest components of the source vectors.

Min(ref readonly Vector4, ref readonly Vector4, out Vector4)

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

public static void Min(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result)

Parameters

left Vector4

The first source vector.

right Vector4

The second source vector.

result Vector4

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

Modulate(Vector4, Vector4)

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

public static Vector4 Modulate(Vector4 left, Vector4 right)

Parameters

left Vector4

The first vector to modulate.

right Vector4

The second vector to modulate.

Returns

Vector4

The modulated vector.

Modulate(ref readonly Vector4, ref readonly Vector4, out Vector4)

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

public static void Modulate(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result)

Parameters

left Vector4

The first vector to modulate.

right Vector4

The second vector to modulate.

result Vector4

When the method completes, contains the modulated vector.

Moveto(in Vector4, in Vector4, float)

Moves the first vector4 to the second one in a straight line.

public static Vector4 Moveto(in Vector4 from, in Vector4 to, float maxTravelDistance)

Parameters

from Vector4

The first point.

to Vector4

The second point.

maxTravelDistance float

The rate at which the first point is going to move towards the second point.

Returns

Vector4

Multiply(Vector4, float)

Scales a vector by the given value.

public static Vector4 Multiply(Vector4 value, float scale)

Parameters

value Vector4

The vector to scale.

scale float

The amount by which to scale the vector.

Returns

Vector4

The scaled vector.

Multiply(ref readonly Vector4, float, out Vector4)

Scales a vector by the given value.

public static void Multiply(ref readonly Vector4 value, float scale, out Vector4 result)

Parameters

value Vector4

The vector to scale.

scale float

The amount by which to scale the vector.

result Vector4

When the method completes, contains the scaled vector.

Negate(Vector4)

Reverses the direction of a given vector.

public static Vector4 Negate(Vector4 value)

Parameters

value Vector4

The vector to negate.

Returns

Vector4

A vector facing in the opposite direction.

Negate(ref readonly Vector4, out Vector4)

Reverses the direction of a given vector.

public static void Negate(ref readonly Vector4 value, out Vector4 result)

Parameters

value Vector4

The vector to negate.

result Vector4

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

Normalize()

Converts the vector into a unit vector.

public void Normalize()

Normalize(Vector4)

Converts the vector into a unit vector.

public static Vector4 Normalize(Vector4 value)

Parameters

value Vector4

The vector to normalize.

Returns

Vector4

The normalized vector.

Normalize(ref readonly Vector4, out Vector4)

Converts the vector into a unit vector.

public static void Normalize(ref readonly Vector4 value, out Vector4 result)

Parameters

value Vector4

The vector to normalize.

result Vector4

When the method completes, contains the normalized vector.

Orthogonalize(Vector4[], params Vector4[])

Orthogonalizes a list of vectors.

public static void Orthogonalize(Vector4[] destination, params Vector4[] source)

Parameters

destination Vector4[]

The list of orthogonalized vectors.

source Vector4[]

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

ArgumentNullException

Thrown when source or destination is null.

ArgumentOutOfRangeException

Thrown when destination is shorter in length than source.

Orthonormalize(Vector4[], params Vector4[])

Orthonormalizes a list of vectors.

public static void Orthonormalize(Vector4[] destination, params Vector4[] source)

Parameters

destination Vector4[]

The list of orthonormalized vectors.

source Vector4[]

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

ArgumentNullException

Thrown when source or destination is null.

ArgumentOutOfRangeException

Thrown when destination is shorter in length than source.

Pow(float)

Raises the exponent for each components.

public void Pow(float exponent)

Parameters

exponent float

The exponent.

SmoothStep(Vector4, Vector4, float)

Performs a cubic interpolation between two vectors.

public static Vector4 SmoothStep(Vector4 start, Vector4 end, float amount)

Parameters

start Vector4

Start vector.

end Vector4

End vector.

amount float

Value between 0 and 1 indicating the weight of end.

Returns

Vector4

The cubic interpolation of the two vectors.

SmoothStep(ref readonly Vector4, ref readonly Vector4, float, out Vector4)

Performs a cubic interpolation between two vectors.

public static void SmoothStep(ref readonly Vector4 start, ref readonly Vector4 end, float amount, out Vector4 result)

Parameters

start Vector4

Start vector.

end Vector4

End vector.

amount float

Value between 0 and 1 indicating the weight of end.

result Vector4

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

Subtract(in Vector4, in Vector4)

Subtracts two vectors.

public static Vector4 Subtract(in Vector4 left, in Vector4 right)

Parameters

left Vector4

The first vector to subtract.

right Vector4

The second vector to subtract.

Returns

Vector4

The difference of the two vectors.

Subtract(ref readonly Vector4, ref readonly Vector4, out Vector4)

Subtracts two vectors.

public static void Subtract(ref readonly Vector4 left, ref readonly Vector4 right, out Vector4 result)

Parameters

left Vector4

The first vector to subtract.

right Vector4

The second vector to subtract.

result Vector4

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

ToArray()

Creates an array containing the elements of the vector.

public readonly float[] ToArray()

Returns

float[]

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

ToString()

Returns a string that represents this instance.

public override readonly string ToString()

Returns

string

A string that represents this instance.

ToString(string?, IFormatProvider?)

Returns a string that represents this instance.

public readonly string ToString(string? format, IFormatProvider? formatProvider)

Parameters

format string

The format.

formatProvider IFormatProvider

The format provider.

Returns

string

A string that represents this instance.

Transform(Vector4, Matrix)

Transforms a 4D vector by the given Matrix.

public static Vector4 Transform(Vector4 vector, Matrix transform)

Parameters

vector Vector4

The source vector.

transform Matrix

The transformation Matrix.

Returns

Vector4

The transformed Vector4.

Transform(Vector4, Quaternion)

Transforms a 4D vector by the given Quaternion rotation.

public static Vector4 Transform(Vector4 vector, Quaternion rotation)

Parameters

vector Vector4

The vector to rotate.

rotation Quaternion

The Quaternion rotation to apply.

Returns

Vector4

The transformed Vector4.

Transform(ref readonly Vector4, ref readonly Matrix, out Vector4)

Transforms a 4D vector by the given Matrix.

public static void Transform(ref readonly Vector4 vector, ref readonly Matrix transform, out Vector4 result)

Parameters

vector Vector4

The source vector.

transform Matrix

The transformation Matrix.

result Vector4

When the method completes, contains the transformed Vector4.

Transform(ref readonly Vector4, ref readonly Quaternion, out Vector4)

Transforms a 4D vector by the given Quaternion rotation.

public static void Transform(ref readonly Vector4 vector, ref readonly Quaternion rotation, out Vector4 result)

Parameters

vector Vector4

The vector to rotate.

rotation Quaternion

The Quaternion rotation to apply.

result Vector4

When the method completes, contains the transformed Vector4.

Transform(Vector4[], ref readonly Matrix, Vector4[])

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

public static void Transform(Vector4[] source, ref readonly Matrix transform, Vector4[] destination)

Parameters

source Vector4[]

The array of vectors to transform.

transform Matrix

The transformation Matrix.

destination Vector4[]

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

Exceptions

ArgumentNullException

Thrown when source or destination is null.

ArgumentOutOfRangeException

Thrown when destination is shorter in length than source.

Transform(Vector4[], ref readonly Quaternion, Vector4[])

Transforms an array of vectors by the given Quaternion rotation.

public static void Transform(Vector4[] source, ref readonly Quaternion rotation, Vector4[] destination)

Parameters

source Vector4[]

The array of vectors to transform.

rotation Quaternion

The Quaternion rotation to apply.

destination Vector4[]

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

Exceptions

ArgumentNullException

Thrown when source or destination is null.

ArgumentOutOfRangeException

Thrown when destination is shorter in length than source.

Operators

operator +(Vector4, Vector4)

Adds two vectors.

public static Vector4 operator +(Vector4 left, Vector4 right)

Parameters

left Vector4

The first vector to add.

right Vector4

The second vector to add.

Returns

Vector4

The sum of the two vectors.

operator /(Vector4, Vector4)

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

public static Vector4 operator /(Vector4 value, Vector4 by)

Parameters

value Vector4

The vector to scale.

by Vector4

The by.

Returns

Vector4

The scaled vector.

operator /(Vector4, float)

Scales a vector by the given value.

public static Vector4 operator /(Vector4 value, float scale)

Parameters

value Vector4

The vector to scale.

scale float

The amount by which to scale the vector.

Returns

Vector4

The scaled vector.

operator /(float, Vector4)

Divides a numerator by a vector.

public static Vector4 operator /(float numerator, Vector4 value)

Parameters

numerator float

The numerator.

value Vector4

The value.

Returns

Vector4

The scaled vector.

operator ==(Vector4, Vector4)

Tests for equality between two objects.

public static bool operator ==(Vector4 left, Vector4 right)

Parameters

left Vector4

The first value to compare.

right Vector4

The second value to compare.

Returns

bool

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

Remarks

Comparison is not strict, a difference of ZeroTolerance will return as equal.

explicit operator Vector2(Vector4)

Performs an explicit conversion from Vector4 to Vector2.

public static explicit operator Vector2(Vector4 value)

Parameters

value Vector4

The value.

Returns

Vector2

The result of the conversion.

explicit operator Vector3(Vector4)

Performs an explicit conversion from Vector4 to Vector3.

public static explicit operator Vector3(Vector4 value)

Parameters

value Vector4

The value.

Returns

Vector3

The result of the conversion.

implicit operator Vector4(Vector4)

Casts from Stride.Maths to System.Numerics vectors

public static implicit operator Vector4(Vector4 v)

Parameters

v Vector4

Value to cast

Returns

Vector4

implicit operator Vector4(Vector4)

Casts from System.Numerics to Stride.Maths vectors

public static implicit operator Vector4(Vector4 v)

Parameters

v Vector4

Value to cast

Returns

Vector4

operator !=(Vector4, Vector4)

Tests for inequality between two objects.

public static bool operator !=(Vector4 left, Vector4 right)

Parameters

left Vector4

The first value to compare.

right Vector4

The second value to compare.

Returns

bool

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

operator *(Vector4, Vector4)

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

public static Vector4 operator *(Vector4 left, Vector4 right)

Parameters

left Vector4

The first vector to multiply.

right Vector4

The second vector to multiply.

Returns

Vector4

The multiplication of the two vectors.

operator *(Vector4, float)

Scales a vector by the given value.

public static Vector4 operator *(Vector4 value, float scale)

Parameters

value Vector4

The vector to scale.

scale float

The amount by which to scale the vector.

Returns

Vector4

The scaled vector.

operator *(float, Vector4)

Scales a vector by the given value.

public static Vector4 operator *(float scale, Vector4 value)

Parameters

scale float

The amount by which to scale the vector.

value Vector4

The vector to scale.

Returns

Vector4

The scaled vector.

operator -(Vector4, Vector4)

Subtracts two vectors.

public static Vector4 operator -(Vector4 left, Vector4 right)

Parameters

left Vector4

The first vector to subtract.

right Vector4

The second vector to subtract.

Returns

Vector4

The difference of the two vectors.

operator -(Vector4)

Reverses the direction of a given vector.

public static Vector4 operator -(Vector4 value)

Parameters

value Vector4

The vector to negate.

Returns

Vector4

A vector facing in the opposite direction.

operator +(Vector4)

Assert a vector (return it unchanged).

public static Vector4 operator +(Vector4 value)

Parameters

value Vector4

The vector to assert (unchange).

Returns

Vector4

The asserted (unchanged) vector.