Struct TemperatureGradientVector3

Namespace

Thunder.UnitsNET.Vectors

Assembly

Thunder.UnitsNET.Vectors.dll

A 3D vector whose components represent temperaturegradient, each expressed as a UnitsNet.TemperatureGradient.

public readonly record struct TemperatureGradientVector3 : IEquatable<TemperatureGradientVector3>

Implements

IEquatable<TemperatureGradientVector3>

Inherited Members

ValueType.Equals(object)

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

XnaVector3Extensions.ToXnaVector3(TemperatureGradientVector3)

XnaVector3Extensions.ToXnaVector3(TemperatureGradientVector3, TemperatureGradientUnit)

Constructors

TemperatureGradientVector3(TemperatureGradient, TemperatureGradient, TemperatureGradient)

Constructs a TemperatureGradientVector3 from three UnitsNet.TemperatureGradient components.

public TemperatureGradientVector3(TemperatureGradient x, TemperatureGradient y, TemperatureGradient z)

Parameters

x TemperatureGradient

The X component.

y TemperatureGradient

The Y component.

z TemperatureGradient

The Z component.

Properties

Magnitude

Returns the Euclidean magnitude of this vector as a UnitsNet.TemperatureGradient. The result is expressed in the same unit as the X component.

public TemperatureGradient Magnitude { get; }

Property Value

TemperatureGradient

X

The X component.

public TemperatureGradient X { get; }

Property Value

TemperatureGradient

Y

The Y component.

public TemperatureGradient Y { get; }

Property Value

TemperatureGradient

Z

The Z component.

public TemperatureGradient Z { get; }

Property Value

TemperatureGradient

Zero

A TemperatureGradientVector3 with all components set to zero.

public static TemperatureGradientVector3 Zero { get; }

Property Value

TemperatureGradientVector3

Methods

Abs()

Returns a vector with each component replaced by its absolute value.

public TemperatureGradientVector3 Abs()

Returns

TemperatureGradientVector3

A TemperatureGradientVector3 with non-negative components.

Add(TemperatureGradientVector3)

Adds two vectors component-wise.

public TemperatureGradientVector3 Add(TemperatureGradientVector3 other)

Parameters

other TemperatureGradientVector3

The vector to add.

Returns

TemperatureGradientVector3

The component-wise sum.

ApproximatelyEquals(TemperatureGradientVector3, TemperatureGradient)

Returns true if each component of this vector is within tolerance of the corresponding component of other.

public bool ApproximatelyEquals(TemperatureGradientVector3 other, TemperatureGradient tolerance)

Parameters

other TemperatureGradientVector3

The vector to compare against.

tolerance TemperatureGradient

The maximum allowed difference per component (inclusive).

Returns

bool

true when |X - other.X| <= tolerance, |Y - other.Y| <= tolerance, and |Z - other.Z| <= tolerance.

As(TemperatureGradientUnit)

Projects all three components into the requested unit, returning a unit-less DoubleVector3.

public DoubleVector3 As(TemperatureGradientUnit unit)

Parameters

unit TemperatureGradientUnit

The target unit for each component.

Returns

DoubleVector3

A DoubleVector3 with components expressed in unit.

AsDefault()

Returns all three components expressed in the SI base unit as a DoubleVector3.

public DoubleVector3 AsDefault()

Returns

DoubleVector3

A DoubleVector3 with components in the default SI unit.

Clamp(TemperatureGradientVector3, TemperatureGradientVector3)

Returns a vector with each component clamped to the range [min, max].

public TemperatureGradientVector3 Clamp(TemperatureGradientVector3 min, TemperatureGradientVector3 max)

Parameters

min TemperatureGradientVector3

The lower bound vector (inclusive, per component).

max TemperatureGradientVector3

The upper bound vector (inclusive, per component).

Returns

TemperatureGradientVector3

A TemperatureGradientVector3 with each component in [min, max].

Divide(double)

Divides the vector by a scalar divisor.

public TemperatureGradientVector3 Divide(double scalar)

Parameters

scalar double

The scalar divisor.

Returns

TemperatureGradientVector3

The divided vector.

Equals(TemperatureGradientVector3)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(TemperatureGradientVector3 other)

Parameters

other TemperatureGradientVector3

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

FromDegreesCelciusPerKilometer(double, double, double)

Creates a TemperatureGradientVector3 with all components created via UnitsNet.TemperatureGradient.FromDegreesCelciusPerKilometer(UnitsNet.QuantityValue).

public static TemperatureGradientVector3 FromDegreesCelciusPerKilometer(double x, double y, double z)

Parameters

x double

The X component value.

y double

The Y component value.

z double

The Z component value.

Returns

TemperatureGradientVector3

A TemperatureGradientVector3 with all components in the corresponding unit.

FromDegreesCelciusPerMeter(double, double, double)

Creates a TemperatureGradientVector3 with all components created via UnitsNet.TemperatureGradient.FromDegreesCelciusPerMeter(UnitsNet.QuantityValue).

public static TemperatureGradientVector3 FromDegreesCelciusPerMeter(double x, double y, double z)

Parameters

x double

The X component value.

y double

The Y component value.

z double

The Z component value.

Returns

TemperatureGradientVector3

A TemperatureGradientVector3 with all components in the corresponding unit.

FromDegreesFahrenheitPerFoot(double, double, double)

Creates a TemperatureGradientVector3 with all components created via UnitsNet.TemperatureGradient.FromDegreesFahrenheitPerFoot(UnitsNet.QuantityValue).

public static TemperatureGradientVector3 FromDegreesFahrenheitPerFoot(double x, double y, double z)

Parameters

x double

The X component value.

y double

The Y component value.

z double

The Z component value.

Returns

TemperatureGradientVector3

A TemperatureGradientVector3 with all components in the corresponding unit.

FromKelvinsPerMeter(double, double, double)

Creates a TemperatureGradientVector3 with all components created via UnitsNet.TemperatureGradient.FromKelvinsPerMeter(UnitsNet.QuantityValue).

public static TemperatureGradientVector3 FromKelvinsPerMeter(double x, double y, double z)

Parameters

x double

The X component value.

y double

The Y component value.

z double

The Z component value.

Returns

TemperatureGradientVector3

A TemperatureGradientVector3 with all components in the corresponding unit.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Lerp(TemperatureGradientVector3, TemperatureGradientVector3, double)

Linearly interpolates between two vectors.

The result at t = 0 is a; at t = 1 it is b. Values of t outside [0, 1] extrapolate beyond the endpoints — use LerpClamped(TemperatureGradientVector3, TemperatureGradientVector3, double) if you need the result bounded to the segment between a and b.

public static TemperatureGradientVector3 Lerp(TemperatureGradientVector3 a, TemperatureGradientVector3 b, double t)

Parameters

a TemperatureGradientVector3

The start vector (t = 0).

b TemperatureGradientVector3

The end vector (t = 1).

t double

The interpolation parameter. Values outside [0, 1] extrapolate.

Returns

TemperatureGradientVector3

The interpolated TemperatureGradientVector3.

LerpClamped(TemperatureGradientVector3, TemperatureGradientVector3, double)

Linearly interpolates between two vectors, with t clamped to [0, 1].

public static TemperatureGradientVector3 LerpClamped(TemperatureGradientVector3 a, TemperatureGradientVector3 b, double t)

Parameters

a TemperatureGradientVector3

The start vector (t = 0).

b TemperatureGradientVector3

The end vector (t = 1).

t double

The interpolation parameter, clamped to [0, 1].

Returns

TemperatureGradientVector3

The interpolated TemperatureGradientVector3, always between a and b.

Multiply(double)

Scales the vector by a scalar factor.

public TemperatureGradientVector3 Multiply(double scalar)

Parameters

scalar double

The scalar factor.

Returns

TemperatureGradientVector3

The scaled vector.

Negate()

Negates all components.

public TemperatureGradientVector3 Negate()

Returns

TemperatureGradientVector3

A vector with all components negated.

Normalize()

Returns a dimensionless unit vector pointing in the same direction. For a zero vector, Zero is returned.

public DoubleVector3 Normalize()

Returns

DoubleVector3

A unit-length DoubleVector3 in the same direction.

Subtract(TemperatureGradientVector3)

Subtracts two vectors component-wise.

public TemperatureGradientVector3 Subtract(TemperatureGradientVector3 other)

Parameters

other TemperatureGradientVector3

The vector to subtract.

Returns

TemperatureGradientVector3

The component-wise difference.

Operators

operator +(TemperatureGradientVector3, TemperatureGradientVector3)

Adds two vectors component-wise.

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

Parameters

left TemperatureGradientVector3

The left operand.

right TemperatureGradientVector3

The right operand.

Returns

TemperatureGradientVector3

The component-wise sum.

operator /(TemperatureGradientVector3, double)

Divides the vector by a scalar divisor.

public static TemperatureGradientVector3 operator /(TemperatureGradientVector3 left, double scalar)

Parameters

left TemperatureGradientVector3

The vector to divide.

scalar double

The scalar divisor.

Returns

TemperatureGradientVector3

The divided vector.

operator *(double, TemperatureGradientVector3)

Scales the vector by a scalar factor. Operands may be supplied in either order.

public static TemperatureGradientVector3 operator *(double scalar, TemperatureGradientVector3 right)

Parameters

scalar double

The scalar factor.

right TemperatureGradientVector3

The vector to scale.

Returns

TemperatureGradientVector3

The scaled vector.

operator *(TemperatureGradientVector3, double)

Scales the vector by a scalar factor.

public static TemperatureGradientVector3 operator *(TemperatureGradientVector3 left, double scalar)

Parameters

left TemperatureGradientVector3

The vector to scale.

scalar double

The scalar factor.

Returns

TemperatureGradientVector3

The scaled vector.

operator -(TemperatureGradientVector3, TemperatureGradientVector3)

Subtracts two vectors component-wise.

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

Parameters

left TemperatureGradientVector3

The left operand.

right TemperatureGradientVector3

The right operand.

Returns

TemperatureGradientVector3

The component-wise difference.

operator -(TemperatureGradientVector3)

Negates all components.

public static TemperatureGradientVector3 operator -(TemperatureGradientVector3 value)

Parameters

value TemperatureGradientVector3

The vector to negate.

Returns

TemperatureGradientVector3

A vector with all components negated.