struct ThreeDViewer.Mathematics.Vector4¶

Overview¶

Represents a 3D position vector with homogeneous coordinates. More…

struct Vector4: IEquatable< Vector4 >
{
    // fields

    static readonly int SizeInBytes = Unsafe.SizeOf<Vector4>();
    static readonly Vector4 Origin = new(0, 0, 0, 0);
    static readonly Vector4 XAxis = new(1, 0, 0, 0);
    static readonly Vector4 YAxis = new(0, 1, 0, 0);
    static readonly Vector4 ZAxis = new(0, 0, 1, 0);
    static readonly Vector4 WAxis = new(0, 0, 0, 1);
    static readonly Vector4 MinValue = new(double.MinValue, double.MinValue, double.MinValue, double.MinValue);
    static readonly Vector4 MaxValue = new(double.MaxValue, double.MaxValue, double.MaxValue, double.MaxValue);
    static readonly Vector4 Epsilon = new(double.Epsilon, double.Epsilon, double.Epsilon, double.Epsilon);
    static readonly Vector4 One = new(1, 1, 1, 1);
    static readonly Vector4 Zero = Origin;
    static readonly Vector4 NaN = new(double.NaN, double.NaN, double.NaN, double.NaN);

    // properties

    double X;
    double Y;
    double Z;
    double W;
    double[] Array;
    double Magnitude;
    double MagnitudeSquared;
    Vector4 Normalized;
    double this[int index];

    // methods

    Vector4(double x, double y, double z, double w);
    Vector4(double[] xyzw);
    Vector4(Vector4 v1);
    Vector4(Vector3 v1);
    Vector4(Vector3 v1, double w);
    double Dot(Vector4 other);
    Vector4 SquareComponents();
    double SumComponents();
    Vector4 Normalize();
    Vector3 ToPhysicalCoords();
    PointF ToPointF();
    bool Equals(Vector4 other);
    override bool Equals(object obj);
    override int GetHashCode();
    static Vector4 operator + (Vector4 v1, Vector4 v2);
    static Vector4 operator - (Vector4 v1, Vector4 v2);
    static Vector4 operator - (Vector4 v1);
    static Vector4 operator + (Vector4 v1);
    static bool operator < (Vector4 v1, Vector4 v2);
    static bool operator <= (Vector4 v1, Vector4 v2);
    static bool operator > (Vector4 v1, Vector4 v2);
    static bool operator >= (Vector4 v1, Vector4 v2);
    static bool operator == (Vector4 v1, Vector4 v2);
    static bool operator != (Vector4 v1, Vector4 v2);
    static Vector4 operator * (Vector4 v1, double s2);
    static Vector4 operator * (double s1, Vector4 v2);
    static Vector4 operator/ (Vector4 v1, double s2);
    static Vector4 operator * (Vector4 v1, Matrix4 m2);
};

Detailed Documentation¶

Represents a 3D position vector with homogeneous coordinates.

Based on this tutorial : https://www.codeproject.com/articles/17425/a-vector-type-for-c.

Fields¶

static readonly int SizeInBytes = Unsafe.SizeOf<Vector4>()

Size of the Vector4 struct in bytes.

static readonly Vector4 Origin = new(0, 0, 0, 0)

An origin vector. Is equal to Vector(0, 0, 0, 0). Same as Zero.

static readonly Vector4 XAxis = new(1, 0, 0, 0)

Represents the X axis. Is equal to Vector(1, 0, 0, 0).

static readonly Vector4 YAxis = new(0, 1, 0, 0)

Represents the Y axis. Is equal to Vector(0, 1, 0, 0).

static readonly Vector4 ZAxis = new(0, 0, 1, 0)

Represents the Z axis. Is equal to Vector(0, 0, 1, 0).

static readonly Vector4 WAxis = new(0, 0, 0, 1)

Represents the W axis. Is equal to Vector(0, 0, 0, 1).

static readonly Vector4 MinValue = new(double.MinValue, double.MinValue, double.MinValue, double.MinValue)

A vector with every components equal to double.MinValue.

static readonly Vector4 MaxValue = new(double.MaxValue, double.MaxValue, double.MaxValue, double.MaxValue)

A vector with every components equal to double.MaxValue.

static readonly Vector4 Epsilon = new(double.Epsilon, double.Epsilon, double.Epsilon, double.Epsilon)

A vector with every components equal to double.Epsilon.

static readonly Vector4 One = new(1, 1, 1, 1)

An instance with all components set to 1.

static readonly Vector4 Zero = Origin

A zero vector. Is equal to Vector(0, 0, 0, 0). Same as Origin.

static readonly Vector4 NaN = new(double.NaN, double.NaN, double.NaN, double.NaN)

A vector with every components equal to double.NaN.

Properties¶

double X

Gets the X component of the vector.

double Y

Gets the Y component of the vector.

double Z

Gets the Z component of the vector.

double W

Gets the W component of the vector.

double[] Array

Gets the vector as an array.

double Magnitude

Gets the magnitude (aka. length or absolute value) of the vector.

double MagnitudeSquared

Gets the squared magnitude of this vector, can be used for better performance than Magnitude.

Vector4 Normalized

Gets this vector but normalized.

double this[int index]

An index accessor for a vector, mapping index [0] -> X, [1] -> Y, [2] -> Z and [3] -> W.

Parameters:

index

The array index referring to a component within the vector (i.e. x, y, z, w).

Returns:

Returns X if 0, Y if 1, Z if 2 and W if 3.