Vector3D Structure

Vector3D Structure

Defines a 3-dimensional vector (double-precision).

Namespace: DigitalRune.Mathematics.Algebra
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(Vector3DConverter))]
[DataContractAttribute]
public struct Vector3D : IEquatable<Vector3D>

<SerializableAttribute>
<TypeConverterAttribute(GetType(Vector3DConverter))>
<DataContractAttribute>
Public Structure Vector3D
	Implements IEquatable(Of Vector3D)

[SerializableAttribute]
[TypeConverterAttribute(typeof(Vector3DConverter))]
[DataContractAttribute]
public value class Vector3D : IEquatable<Vector3D>

[<SealedAttribute>]
[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(Vector3DConverter))>]
[<DataContractAttribute>]
type Vector3D =  
    struct
        interface IEquatable<Vector3D>
    end

The Vector3D type exposes the following members.

Constructors

	Name	Description
	Vector3D(IListDouble)	Initializes a new instance of the Vector3D class.
	Vector3D(Double)	Initializes a new instance of Vector3D.
	Vector3D(Double)	Initializes a new instance of Vector3D.
	Vector3D(Double, Double, Double)	Initializes a new instance of Vector3D.

Top

Methods

	Name	Description
	Absolute	Sets each vector component to its absolute value.
	Absolute(Vector3D)	Returns a vector with the absolute values of the elements of the given vector.
	Add	Adds two vectors.
	AreNumericallyEqual(Vector3D, Vector3D)	Determines whether two vectors are equal (regarding the tolerance EpsilonD).
	AreNumericallyEqual(Vector3D, Vector3D, Double)	Determines whether two vectors are equal (regarding a specific tolerance).
	Clamp(Double, Double)	Clamps the vector components to the range [min, max].
	Clamp(Vector3D, Double, Double)	Returns a vector with the vector components clamped to the range [min, max].
	ClampToZero	Clamps near-zero vector components to zero.
	ClampToZero(Double)	Clamps near-zero vector components to zero.
	ClampToZero(Vector3D)	Returns a vector with near-zero vector components clamped to 0.
	ClampToZero(Vector3D, Double)	Returns a vector with near-zero vector components clamped to 0.
	Cross	Calculates the cross product of two vectors.
	Divide(Vector3D, Vector3D)	Divides the components of a vector by the components of another vector.
	Divide(Vector3D, Double)	Divides a vector by a scalar.
	Dot	Calculates the dot product of two vectors.
	Equals(Object)	Indicates whether this instance and a specified object are equal. (Overrides ValueTypeEquals(Object).)
	Equals(Vector3D)	Indicates whether the current object is equal to another object of the same type.
	FromXna	Converts this Vector3D (DigitalRune Mathematics) to Vector3 (XNA Framework).
	GetAngle	Calculates the angle between two vectors.
	GetHashCode	Returns the hash code for this instance. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Max	Returns a vector that contains the highest value from each matching pair of components.
	Min	Returns a vector that contains the lowest value from each matching pair of components.
	Multiply(Double, Vector3D)	Multiplies a vector by a scalar.
	Multiply(Vector3D, Vector3D)	Multiplies the components of two vectors by each other.
	Negate	Negates a vector.
	Normalize	Normalizes the vector.
	Parse(String)	Converts the string representation of a 3-dimensional vector to its Vector3D equivalent.
	Parse(String, IFormatProvider)	Converts the string representation of a 3-dimensional vector in a specified culture-specific format to its Vector3D equivalent.
	ProjectTo(Vector3D)	Sets this vector to its projection onto the axis given by the target vector.
	ProjectTo(Vector3D, Vector3D)	Projects a vector onto an axis given by the target vector.
	Subtract	Subtracts a vector from a vector.
	ToArray	Converts this vector to an array of 3 double values.
	ToCrossProductMatrix	Returns the cross product matrix (skew matrix) of this vector.
	ToList	Converts this vector to a list of 3 double values.
	ToString	Returns the string representation of this vector. (Overrides ValueTypeToString.)
	ToString(IFormatProvider)	Returns the string representation of this vector using the specified culture-specific format information.
	ToVector3F	Converts this Vector3D to Vector3F.
	ToVectorD	Converts this Vector3D to VectorD.
	ToXna	Converts this Vector3D (DigitalRune Mathematics) to Vector3 (XNA Framework).
	TryNormalize	Tries to normalize the vector.

Top

Operators

	Name	Description
	Addition	Adds two vectors.
	Division(Vector3D, Vector3D)	Divides the components of a vector by the components of another vector.
	Division(Vector3D, Double)	Divides a vector by a scalar.
	Equality	Tests if two vectors are equal.
	(Vector3 to Vector3D)	Performs an conversion from Vector3 (XNA Framework) to Vector3D (DigitalRune Mathematics).
	(Vector3D to Double)	Converts a vector to an array of 3 double values.
	(Vector3D to ListDouble)	Converts a vector to a list of 3 double values.
	(Vector3D to Vector3F)	Performs an explicit conversion from Vector3D to Vector3F.
	(Vector3D to Vector3)	Performs an conversion from Vector3D (DigitalRune Mathematics) to Vector3 (XNA Framework).
	GreaterThan	Tests if each component of a vector is greater than the corresponding component of another vector.
	GreaterThanOrEqual	Tests if each component of a vector is greater or equal than the corresponding component of another vector.
	(Vector3D to VectorD)	Performs an implicit conversion from Vector3D to VectorD.
	Inequality	Tests if two vectors are not equal.
	LessThan	Tests if each component of a vector is less than the corresponding component of another vector.
	LessThanOrEqual	Tests if each component of a vector is less or equal than the corresponding component of another vector.
	Multiply(Double, Vector3D)	Multiplies a vector by a scalar.
	Multiply(Vector3D, Vector3D)	Multiplies the components of two vectors by each other.
	Multiply(Vector3D, Double)	Multiplies a vector by a scalar.
	Subtraction	Subtracts a vector from a vector.
	UnaryNegation	Negates a vector.

Top

Fields

	Name	Description
	Backward	Returns a unit Vector3D pointing backward (0, 0, 1). (Only available in the XNA-compatible build.)
	Down	Returns a unit Vector3D pointing down (0, −1, 0). (Only available in the XNA-compatible build.)
	Forward	Returns a unit Vector3D pointing forward (0, 0, −1). (Only available in the XNA-compatible build.)
	Left	Returns a unit Vector3D pointing left (-1, 0, 0). (Only available in the XNA-compatible build.)
	One	Returns a Vector3D with all of its components set to one.
	Right	Returns a unit Vector3D pointing right (1, 0, 0). (Only available in the XNA-compatible build.)
	UnitX	Returns the x unit Vector3D (1, 0, 0).
	UnitY	Returns the value2 unit Vector3D (0, 1, 0).
	UnitZ	Returns the z unit Vector3D (0, 0, 1).
	Up	Returns a unit Vector3D pointing up (0, 1, 0). (Only available in the XNA-compatible build.)
	X	The x component.
	Y	The y component.
	Z	The z component.
	Zero	Returns a Vector3D with all of its components set to zero.

Top

Properties

	Name	Description
	IndexOfLargestComponent	Gets the index (zero-based) of the largest component.
	IndexOfSmallestComponent	Gets the index (zero-based) of the largest component.
	IsNaN	Gets a value indicating whether a component of the vector is NaN.
	IsNumericallyNormalized	Returns a value indicating whether this vector is normalized (the length is numerically equal to 1).
	IsNumericallyZero	Returns a value indicating whether this vector has zero size (the length is numerically equal to 0).
	Item	Gets or sets the component at the specified index.
	LargestComponent	Gets the value of the largest component.
	Length	Gets or sets the length of this vector.
	LengthSquared	Returns the squared length of this vector.
	Normalized	Returns the normalized vector.
	Orthonormal1	Returns an arbitrary normalized Vector3D that is orthogonal to this vector.
	Orthonormal2	Gets a normalized orthogonal Vector3D that is orthogonal to this Vector3D and to Orthonormal1.
	SmallestComponent	Gets the value of the smallest component.

Top

Remarks

The three components (x, y, z) are stored with double-precision.

Reference

DigitalRune.Mathematics.Algebra Namespace