Struct ElectricFieldVector3

Namespace

Thunder.UnitsNET.Vectors

Assembly

Thunder.UnitsNET.Vectors.dll

A 3D vector whose components represent electricfield, each expressed as a UnitsNet.ElectricField.

public readonly record struct ElectricFieldVector3 : IEquatable<ElectricFieldVector3>

Implements

IEquatable<ElectricFieldVector3>

Inherited Members

ValueType.Equals(object)

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

XnaVector3Extensions.ToXnaVector3(ElectricFieldVector3)

XnaVector3Extensions.ToXnaVector3(ElectricFieldVector3, ElectricFieldUnit)

Constructors

ElectricFieldVector3(ElectricField, ElectricField, ElectricField)

Constructs a ElectricFieldVector3 from three UnitsNet.ElectricField components.

public ElectricFieldVector3(ElectricField x, ElectricField y, ElectricField z)

Parameters

x ElectricField

The X component.

y ElectricField

The Y component.

z ElectricField

The Z component.

Properties

Magnitude

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

public ElectricField Magnitude { get; }

Property Value

ElectricField

X

The X component.

public ElectricField X { get; }

Property Value

ElectricField

Y

The Y component.

public ElectricField Y { get; }

Property Value

ElectricField

Z

The Z component.

public ElectricField Z { get; }

Property Value

ElectricField

Zero

A ElectricFieldVector3 with all components set to zero.

public static ElectricFieldVector3 Zero { get; }

Property Value

ElectricFieldVector3

Methods

Abs()

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

public ElectricFieldVector3 Abs()

Returns

ElectricFieldVector3

A ElectricFieldVector3 with non-negative components.

Add(ElectricFieldVector3)

Adds two vectors component-wise.

public ElectricFieldVector3 Add(ElectricFieldVector3 other)

Parameters

other ElectricFieldVector3

The vector to add.

Returns

ElectricFieldVector3

The component-wise sum.

ApproximatelyEquals(ElectricFieldVector3, ElectricField)

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

public bool ApproximatelyEquals(ElectricFieldVector3 other, ElectricField tolerance)

Parameters

other ElectricFieldVector3

The vector to compare against.

tolerance ElectricField

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(ElectricFieldUnit)

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

public DoubleVector3 As(ElectricFieldUnit unit)

Parameters

unit ElectricFieldUnit

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

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

public ElectricFieldVector3 Clamp(ElectricFieldVector3 min, ElectricFieldVector3 max)

Parameters

min ElectricFieldVector3

The lower bound vector (inclusive, per component).

max ElectricFieldVector3

The upper bound vector (inclusive, per component).

Returns

ElectricFieldVector3

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

Divide(double)

Divides the vector by a scalar divisor.

public ElectricFieldVector3 Divide(double scalar)

Parameters

scalar double

The scalar divisor.

Returns

ElectricFieldVector3

The divided vector.

Equals(ElectricFieldVector3)

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

public bool Equals(ElectricFieldVector3 other)

Parameters

other ElectricFieldVector3

An object to compare with this object.

Returns

bool

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

FromVoltsPerMeter(double, double, double)

Creates a ElectricFieldVector3 with all components created via UnitsNet.ElectricField.FromVoltsPerMeter(UnitsNet.QuantityValue).

public static ElectricFieldVector3 FromVoltsPerMeter(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

ElectricFieldVector3

A ElectricFieldVector3 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(ElectricFieldVector3, ElectricFieldVector3, 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(ElectricFieldVector3, ElectricFieldVector3, double) if you need the result bounded to the segment between a and b.

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

Parameters

a ElectricFieldVector3

The start vector (t = 0).

b ElectricFieldVector3

The end vector (t = 1).

t double

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

Returns

ElectricFieldVector3

The interpolated ElectricFieldVector3.

LerpClamped(ElectricFieldVector3, ElectricFieldVector3, double)

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

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

Parameters

a ElectricFieldVector3

The start vector (t = 0).

b ElectricFieldVector3

The end vector (t = 1).

t double

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

Returns

ElectricFieldVector3

The interpolated ElectricFieldVector3, always between a and b.

Multiply(double)

Scales the vector by a scalar factor.

public ElectricFieldVector3 Multiply(double scalar)

Parameters

scalar double

The scalar factor.

Returns

ElectricFieldVector3

The scaled vector.

Negate()

Negates all components.

public ElectricFieldVector3 Negate()

Returns

ElectricFieldVector3

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(ElectricFieldVector3)

Subtracts two vectors component-wise.

public ElectricFieldVector3 Subtract(ElectricFieldVector3 other)

Parameters

other ElectricFieldVector3

The vector to subtract.

Returns

ElectricFieldVector3

The component-wise difference.

Operators

operator +(ElectricFieldVector3, ElectricFieldVector3)

Adds two vectors component-wise.

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

Parameters

left ElectricFieldVector3

The left operand.

right ElectricFieldVector3

The right operand.

Returns

ElectricFieldVector3

The component-wise sum.

operator /(ElectricFieldVector3, double)

Divides the vector by a scalar divisor.

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

Parameters

left ElectricFieldVector3

The vector to divide.

scalar double

The scalar divisor.

Returns

ElectricFieldVector3

The divided vector.

operator *(double, ElectricFieldVector3)

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

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

Parameters

scalar double

The scalar factor.

right ElectricFieldVector3

The vector to scale.

Returns

ElectricFieldVector3

The scaled vector.

operator *(ElectricFieldVector3, double)

Scales the vector by a scalar factor.

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

Parameters

left ElectricFieldVector3

The vector to scale.

scalar double

The scalar factor.

Returns

ElectricFieldVector3

The scaled vector.

operator -(ElectricFieldVector3, ElectricFieldVector3)

Subtracts two vectors component-wise.

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

Parameters

left ElectricFieldVector3

The left operand.

right ElectricFieldVector3

The right operand.

Returns

ElectricFieldVector3

The component-wise difference.

operator -(ElectricFieldVector3)

Negates all components.

public static ElectricFieldVector3 operator -(ElectricFieldVector3 value)

Parameters

value ElectricFieldVector3

The vector to negate.

Returns

ElectricFieldVector3

A vector with all components negated.