Struct Vector3F

An immutable single-precision 3-D vector used for positions and link lengths in body-segment kinematics.

Implements
Namespace: MOSAIC.Components.BodyRig
Assembly: MOSAIC.dll
Syntax
public readonly struct Vector3F : IEquatable<Vector3F>
Remarks

Consider replacing with Vector3 if you do not need the immutable semantics or custom formatting defined here.

Constructors

Vector3F(float, float, float)

Initialises a new 3-D vector with the specified components.

Declaration
public Vector3F(float x, float y, float z)
Parameters
Type Name Description
float x
float y
float z

Fields

Zero

The zero vector (0, 0, 0).

Declaration
public static readonly Vector3F Zero
Field Value
Type Description
Vector3F

Properties

this[int]

Indexer: 0 → X, 1 → Y, 2 → Z.

Declaration
public float this[int index] { get; }
Parameters
Type Name Description
int index
Property Value
Type Description
float
Exceptions
Type Condition
IndexOutOfRangeException

Thrown if index is not 0, 1, or 2.

X

X component.

Declaration
public float X { get; }
Property Value
Type Description
float

Y

Y component.

Declaration
public float Y { get; }
Property Value
Type Description
float

Z

Z component.

Declaration
public float Z { get; }
Property Value
Type Description
float

Methods

Cross(Vector3F, Vector3F)

Cross product of two vectors.

Declaration
public static Vector3F Cross(Vector3F a, Vector3F b)
Parameters
Type Name Description
Vector3F a
Vector3F b
Returns
Type Description
Vector3F

Dot(Vector3F, Vector3F)

Dot product of two vectors.

Declaration
public static float Dot(Vector3F a, Vector3F b)
Parameters
Type Name Description
Vector3F a
Vector3F b
Returns
Type Description
float

Equals(Vector3F)

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

Declaration
public bool Equals(Vector3F other)
Parameters
Type Name Description
Vector3F other

An object to compare with this object.

Returns
Type Description
bool

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

Equals(object?)

Indicates whether this instance and a specified object are equal.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj

The object to compare with the current instance.

Returns
Type Description
bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides
ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
int

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

Overrides
ValueType.GetHashCode()

Magnitude()

Returns the Euclidean length (L2 norm).

Declaration
public float Magnitude()
Returns
Type Description
float

Normalized()

Returns a unit-length vector in the same direction.

Declaration
public Vector3F Normalized()
Returns
Type Description
Vector3F

ToString()

Returns the fully qualified type name of this instance.

Declaration
public override string ToString()
Returns
Type Description
string

The fully qualified type name.

Overrides
ValueType.ToString()

Operators

operator +(Vector3F, Vector3F)

Component-wise addition.

Declaration
public static Vector3F operator +(Vector3F a, Vector3F b)
Parameters
Type Name Description
Vector3F a
Vector3F b
Returns
Type Description
Vector3F

operator /(Vector3F, float)

Scalar division.

Declaration
public static Vector3F operator /(Vector3F v, float s)
Parameters
Type Name Description
Vector3F v
float s
Returns
Type Description
Vector3F

operator ==(Vector3F, Vector3F)

Equality operator.

Declaration
public static bool operator ==(Vector3F a, Vector3F b)
Parameters
Type Name Description
Vector3F a
Vector3F b
Returns
Type Description
bool

operator !=(Vector3F, Vector3F)

Inequality operator.

Declaration
public static bool operator !=(Vector3F a, Vector3F b)
Parameters
Type Name Description
Vector3F a
Vector3F b
Returns
Type Description
bool

operator *(Vector3F, float)

Scalar multiplication.

Declaration
public static Vector3F operator *(Vector3F v, float s)
Parameters
Type Name Description
Vector3F v
float s
Returns
Type Description
Vector3F

operator *(float, Vector3F)

Scalar multiplication (scalar on the left).

Declaration
public static Vector3F operator *(float s, Vector3F v)
Parameters
Type Name Description
float s
Vector3F v
Returns
Type Description
Vector3F

operator -(Vector3F, Vector3F)

Component-wise subtraction.

Declaration
public static Vector3F operator -(Vector3F a, Vector3F b)
Parameters
Type Name Description
Vector3F a
Vector3F b
Returns
Type Description
Vector3F

operator -(Vector3F)

Negates all components.

Declaration
public static Vector3F operator -(Vector3F v)
Parameters
Type Name Description
Vector3F v
Returns
Type Description
Vector3F

Implements

IEquatable<T>

Search documentation

Start typing to search the documentation.