GrapeCity.Documents.DX.Vector3

Struct Vector3

Namespace

GrapeCity.Documents.DX

Assembly

GcDocs.DX.Windows.dll

Represents a three dimensional mathematical vector.

public struct Vector3 : IEquatable<Vector3>, IFormattable

Implements

System.IEquatable<T><Vector3>

System.IFormattable

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Constructors

Vector3(Vector2, float)

Initializes a new instance of the Vector3 struct.

public Vector3(Vector2 value, float z)

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.

Vector3(float, float, float)

Initializes a new instance of the Vector3 struct.

public Vector3(float x, float y, float z)

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.

Vector3(float)

Initializes a new instance of the Vector3 struct.

public Vector3(float value)

Parameters

value float

The value that will be assigned to all components.

Vector3(float[])

Initializes a new instance of the Vector3 struct.

public Vector3(float[] values)

Parameters

values float[]

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

Exceptions

System.ArgumentNullException

Thrown when values is null.

System.ArgumentOutOfRangeException

Thrown when values contains more or less than three elements.

Fields

One

A Vector3 with all of its components set to one.

public static readonly Vector3 One

Field Value

Vector3

SizeInBytes

The size of the Vector3 type, in bytes.

public const int SizeInBytes = 12

Field Value

int

UnitX

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

public static readonly Vector3 UnitX

Field Value

Vector3

UnitY

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

public static readonly Vector3 UnitY

Field Value

Vector3

UnitZ

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

public static readonly Vector3 UnitZ

Field Value

Vector3

X

The X component of the vector.

public float X

Field Value

float

Y

The Y component of the vector.

public float Y

Field Value

float

Z

The Z component of the vector.

public float Z

Field Value

float

Zero

A Vector3 with all of its components set to zero.

public static readonly Vector3 Zero

Field Value

Vector3

Properties

IsNormalized

Gets a value indicting whether this instance is normalized.

public bool IsNormalized { get; }

Property Value

bool

this[int]

Gets or sets the component at the specified index.

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

Parameters

index int

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

Property Value

float

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

Exceptions

System.ArgumentOutOfRangeException

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

Length

Gets the length of the vector.

public float Length { get; }

Property Value

float

LengthSquared

Gets the squared length of the vector.

public float LengthSquared { get; }

Property Value

float

Methods

Abs(Vector3)

Returns a vector whose elements are the absolute values of each of the specified vector's elements.

public static Vector3 Abs(Vector3 value)

Parameters

value Vector3

A vector.

Returns

Vector3

The absolute value vector.

AbsRef(ref Vector3)

Calculates the absolute value vector.

public static void AbsRef(ref Vector3 value)

Parameters

value Vector3

A vector.

Add(Vector3, Vector3)

Adds two vectors.

public static Vector3 Add(Vector3 left, Vector3 right)

Parameters

left Vector3

The first vector to add.

right Vector3

The second vector to add.

Returns

Vector3

The sum of the two vectors.

Clamp(Vector3, Vector3, Vector3)

Restricts a vector between a minimum and a maximum value.

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

Parameters

value Vector3

The vector to restrict.

min Vector3

The minimum value.

max Vector3

The maximum value.

Returns

Vector3

The restricted vector.

Cross(Vector3, Vector3)

Computes the cross product of two vectors.

public static Vector3 Cross(Vector3 vector1, Vector3 vector2)

Parameters

vector1 Vector3

The first vector.

vector2 Vector3

The second vector.

Returns

Vector3

The cross product.

Divide(Vector3, Vector3)

Divides the first vector by the second.

public static Vector3 Divide(Vector3 left, Vector3 right)

Parameters

left Vector3

The first vector.

right Vector3

The second vector.

Returns

Vector3

The vector resulting from the division.

Divide(Vector3, float)

Divides the specified vector by a specified scalar value.

public static Vector3 Divide(Vector3 left, float divisor)

Parameters

left Vector3

The vector.

divisor float

The scalar value.

Returns

Vector3

The vector that results from the division.

Dot(Vector3, Vector3)

Calculates the dot product of two vectors.

public static float Dot(Vector3 left, Vector3 right)

Parameters

left Vector3

First source vector.

right Vector3

Second source vector.

Returns

float

The dot product of the two vectors.

Equals(Vector3)

Determines whether the specified Vector3 is equal to this instance.

public bool Equals(Vector3 other)

Parameters

other Vector3

Returns

bool

Equals(object)

Determines whether the specified object is equal to this instance.

public override bool Equals(object value)

Parameters

value object

Returns

bool

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

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

Lerp(Vector3, Vector3, float)

Performs a linear interpolation between two vectors based on the given weighting.

public static Vector3 Lerp(Vector3 value1, Vector3 value2, float amount)

Parameters

value1 Vector3

The first vector.

value2 Vector3

The second vector.

amount float

A value between 0 and 1 that indicates the weight of value2.

Returns

Vector3

The interpolated vector.

Max(Vector3, Vector3)

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

public static Vector3 Max(Vector3 left, Vector3 right)

Parameters

left Vector3

The first source vector.

right Vector3

The second source vector.

Returns

Vector3

A vector containing the largest components of the source vectors.

Min(Vector3, Vector3)

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

public static Vector3 Min(Vector3 left, Vector3 right)

Parameters

left Vector3

The first source vector.

right Vector3

The second source vector.

Returns

Vector3

A vector containing the smallest components of the source vectors.

Multiply(Vector3, Vector3)

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

public static Vector3 Multiply(Vector3 left, Vector3 right)

Parameters

left Vector3

The first vector to modulate.

right Vector3

The second vector to modulate.

Returns

Vector3

The modulated vector.

Multiply(Vector3, float)

Scales a vector by the given value.

public static Vector3 Multiply(Vector3 value, float scale)

Parameters

value Vector3

The vector to scale.

scale float

The amount by which to scale the vector.

Returns

Vector3

The scaled vector.

Negate(Vector3)

Reverses the direction of a given vector.

public static Vector3 Negate(Vector3 value)

Parameters

value Vector3

The vector to negate.

Returns

Vector3

A vector facing in the opposite direction.

NegateRef(ref Vector3)

Reverses the direction of the vector.

public static void NegateRef(ref Vector3 value)

Parameters

value Vector3

The vector to negate.

Normalize(Vector3)

Converts the vector into a unit vector.

public static Vector3 Normalize(Vector3 value)

Parameters

value Vector3

The vector to normalize.

Returns

Vector3

The normalized vector.

NormalizeRef(ref Vector3)

Converts the vector into a unit vector.

public static void NormalizeRef(ref Vector3 value)

Parameters

value Vector3

The vector to normalize.

Subtract(Vector3, Vector3)

Subtracts two vectors.

public static Vector3 Subtract(Vector3 left, Vector3 right)

Parameters

left Vector3

The first vector to subtract.

right Vector3

The second vector to subtract.

Returns

Vector3

The difference of the two vectors.

ToArray()

Creates an array containing the elements of the vector.

public float[] ToArray()

Returns

float[]

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

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.

ToString(IFormatProvider)

Returns a string that represents this instance.

public string ToString(IFormatProvider formatProvider)

Parameters

formatProvider System.IFormatProvider

The format provider.

Returns

string

A string that represents this instance.

ToString(string, IFormatProvider)

Returns a string that represents this instance.

public string ToString(string format, IFormatProvider formatProvider)

Parameters

format string

The format.

formatProvider System.IFormatProvider

The format provider.

Returns

string

A string that represents this instance.

ToString(string)

Returns a string that represents this instance.

public string ToString(string format)

Parameters

format string

The format.

Returns

string

A string that represents this instance.

Operators

operator +(Vector3, Vector3)

Adds two vectors.

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

Parameters

left Vector3

The first vector to add.

right Vector3

The second vector to add.

Returns

Vector3

The sum of the two vectors.

operator /(Vector3, Vector3)

Divides the first vector by the second.

public static Vector3 operator /(Vector3 left, Vector3 right)

Parameters

left Vector3

The first vector.

right Vector3

The second vector.

Returns

Vector3

The vector resulting from the division.

operator /(Vector3, float)

Divides the specified vector by a specified scalar value.

public static Vector3 operator /(Vector3 value, float divisor)

Parameters

value Vector3

The vector.

divisor float

The scalar value.

Returns

Vector3

The vector that results from the division.

operator ==(Vector3, Vector3)

Tests for equality between two objects.

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

Parameters

left Vector3

The first value to compare.

right Vector3

The second value to compare.

Returns

bool

explicit operator Vector2(Vector3)

Performs an explicit conversion from Vector3 to Vector2.

public static explicit operator Vector2(Vector3 value)

Parameters

value Vector3

The value.

Returns

Vector2

The result of the conversion.

explicit operator Vector4(Vector3)

Performs an explicit conversion from Vector3 to Vector4.

public static explicit operator Vector4(Vector3 value)

Parameters

value Vector3

The value.

Returns

Vector4

The result of the conversion.

operator !=(Vector3, Vector3)

Tests for inequality between two objects.

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

Parameters

left Vector3

The first value to compare.

right Vector3

The second value to compare.

Returns

bool

operator *(Vector3, Vector3)

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

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

Parameters

left Vector3

The first vector to multiply.

right Vector3

The second vector to multiply.

Returns

Vector3

The multiplication of the two vectors.

operator *(Vector3, float)

Scales a vector by the given value.

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

Parameters

value Vector3

The vector to scale.

scale float

The amount by which to scale the vector.

Returns

Vector3

The scaled vector.

operator *(float, Vector3)

Scales a vector by the given value.

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

Parameters

scale float

The amount by which to scale the vector.

value Vector3

The vector to scale.

Returns

Vector3

The scaled vector.

operator -(Vector3, Vector3)

Subtracts two vectors.

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

Parameters

left Vector3

The first vector to subtract.

right Vector3

The second vector to subtract.

Returns

Vector3

The difference of the two vectors.

operator -(Vector3)

Reverses the direction of a given vector.

public static Vector3 operator -(Vector3 value)

Parameters

value Vector3

The vector to negate.

Returns

Vector3

A vector facing in the opposite direction.