Click or drag to resize
DigitalRuneVector3F Structure
Defines a 3-dimensional vector (single-precision).

Namespace: DigitalRune.Mathematics.Algebra
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)
Syntax
[SerializableAttribute]
[TypeConverterAttribute(typeof(Vector3FConverter))]
[DataContractAttribute]
public struct Vector3F : IEquatable<Vector3F>

The Vector3F type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAbsolute
Sets each vector component to its absolute value.
Public methodStatic memberAbsolute(Vector3F)
Returns a vector with the absolute values of the elements of the given vector.
Public methodStatic memberAdd
Adds two vectors.
Public methodStatic memberAreNumericallyEqual(Vector3F, Vector3F)
Determines whether two vectors are equal (regarding the tolerance EpsilonF).
Public methodStatic memberAreNumericallyEqual(Vector3F, Vector3F, Single)
Determines whether two vectors are equal (regarding a specific tolerance).
Public methodClamp(Single, Single)
Clamps the vector components to the range [min, max].
Public methodStatic memberClamp(Vector3F, Single, Single)
Returns a vector with the vector components clamped to the range [min, max].
Public methodClampToZero
Clamps near-zero vector components to zero.
Public methodClampToZero(Single)
Clamps near-zero vector components to zero.
Public methodStatic memberClampToZero(Vector3F)
Returns a vector with near-zero vector components clamped to 0.
Public methodStatic memberClampToZero(Vector3F, Single)
Returns a vector with near-zero vector components clamped to 0.
Public methodStatic memberCross
Calculates the cross product of two vectors.
Public methodStatic memberDivide(Vector3F, Vector3F)
Divides the components of a vector by the components of another vector.
Public methodStatic memberDivide(Vector3F, Single)
Divides a vector by a scalar.
Public methodStatic memberDot
Calculates the dot product of two vectors.
Public methodEquals(Object)
Indicates whether this instance and a specified object are equal.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(Vector3F)
Indicates whether the current object is equal to another object of the same type.
Public methodStatic memberFromXna
Converts this Vector3F (DigitalRune Mathematics) to Vector3 (XNA Framework).
Public methodStatic memberGetAngle
Calculates the angle between two vectors.
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberMax
Returns a vector that contains the highest value from each matching pair of components.
Public methodStatic memberMin
Returns a vector that contains the lowest value from each matching pair of components.
Public methodStatic memberMultiply(Single, Vector3F)
Multiplies a vector by a scalar.
Public methodStatic memberMultiply(Vector3F, Vector3F)
Multiplies the components of two vectors by each other.
Public methodStatic memberNegate
Negates a vector.
Public methodNormalize
Normalizes the vector.
Public methodStatic memberParse(String)
Converts the string representation of a 3-dimensional vector to its Vector3F equivalent.
Public methodStatic memberParse(String, IFormatProvider)
Converts the string representation of a 3-dimensional vector in a specified culture-specific format to its Vector3F equivalent.
Public methodProjectTo(Vector3F)
Sets this vector to its projection onto the axis given by the target vector.
Public methodStatic memberProjectTo(Vector3F, Vector3F)
Projects a vector onto an axis given by the target vector.
Public methodStatic memberSubtract
Subtracts a vector from a vector.
Public methodToArray
Converts this vector to an array of 3 float values.
Public methodToCrossProductMatrix
Returns the cross product matrix (skew matrix) of this vector.
Public methodToList
Converts this vector to a list of 3 float values.
Public methodToString
Returns the string representation of this vector.
(Overrides ValueTypeToString.)
Public methodToString(IFormatProvider)
Returns the string representation of this vector using the specified culture-specific format information.
Public methodToVector3D
Converts this Vector3F to Vector3D.
Public methodToVectorF
Converts this Vector3F to VectorF.
Public methodToXna
Converts this Vector3F (DigitalRune Mathematics) to Vector3 (XNA Framework).
Public methodTryNormalize
Tries to normalize the vector.
Top
Operators
  NameDescription
Public operatorStatic memberAddition
Adds two vectors.
Public operatorStatic memberDivision(Vector3F, Vector3F)
Divides the components of a vector by the components of another vector.
Public operatorStatic memberDivision(Vector3F, Single)
Divides a vector by a scalar.
Public operatorStatic memberEquality
Tests if two vectors are equal.
Public operatorStatic member(Vector3 to Vector3F)
Performs an conversion from Vector3 (XNA Framework) to Vector3F (DigitalRune Mathematics).
Public operatorStatic member(Vector3F to Single)
Converts a vector to an array of 3 float values.
Public operatorStatic member(Vector3F to ListSingle)
Converts a vector to a list of 3 float values.
Public operatorStatic member(Vector3F to Vector3)
Performs an conversion from Vector3F (DigitalRune Mathematics) to Vector3 (XNA Framework).
Public operatorStatic memberGreaterThan
Tests if each component of a vector is greater than the corresponding component of another vector.
Public operatorStatic memberGreaterThanOrEqual
Tests if each component of a vector is greater or equal than the corresponding component of another vector.
Public operatorStatic member(Vector3F to Vector3D)
Performs an implicit conversion from Vector3F to Vector3D.
Public operatorStatic member(Vector3F to VectorF)
Performs an implicit conversion from Vector3F to VectorF.
Public operatorStatic memberInequality
Tests if two vectors are not equal.
Public operatorStatic memberLessThan
Tests if each component of a vector is less than the corresponding component of another vector.
Public operatorStatic memberLessThanOrEqual
Tests if each component of a vector is less or equal than the corresponding component of another vector.
Public operatorStatic memberMultiply(Single, Vector3F)
Multiplies a vector by a scalar.
Public operatorStatic memberMultiply(Vector3F, Vector3F)
Multiplies the components of two vectors by each other.
Public operatorStatic memberMultiply(Vector3F, Single)
Multiplies a vector by a scalar.
Public operatorStatic memberSubtraction
Subtracts a vector from a vector.
Public operatorStatic memberUnaryNegation
Negates a vector.
Top
Fields
  NameDescription
Public fieldStatic memberBackward
Returns a unit Vector3F pointing backward (0, 0, 1). (Only available in the XNA-compatible build.)
Public fieldStatic memberDown
Returns a unit Vector3F pointing down (0, −1, 0). (Only available in the XNA-compatible build.)
Public fieldStatic memberForward
Returns a unit Vector3F pointing forward (0, 0, −1). (Only available in the XNA-compatible build.)
Public fieldStatic memberLeft
Returns a unit Vector3F pointing left (-1, 0, 0). (Only available in the XNA-compatible build.)
Public fieldStatic memberOne
Returns a Vector3F with all of its components set to one.
Public fieldStatic memberRight
Returns a unit Vector3F pointing right (1, 0, 0). (Only available in the XNA-compatible build.)
Public fieldStatic memberUnitX
Returns the x unit Vector3F (1, 0, 0).
Public fieldStatic memberUnitY
Returns the value2 unit Vector3F (0, 1, 0).
Public fieldStatic memberUnitZ
Returns the z unit Vector3F (0, 0, 1).
Public fieldStatic memberUp
Returns a unit Vector3F pointing up (0, 1, 0). (Only available in the XNA-compatible build.)
Public fieldX
The x component.
Public fieldY
The y component.
Public fieldZ
The z component.
Public fieldStatic memberZero
Returns a Vector3F with all of its components set to zero.
Top
Properties
  NameDescription
Public propertyIndexOfLargestComponent
Gets the index (zero-based) of the largest component.
Public propertyIndexOfSmallestComponent
Gets the index (zero-based) of the largest component.
Public propertyIsNaN
Gets a value indicating whether a component of the vector is NaN.
Public propertyIsNumericallyNormalized
Returns a value indicating whether this vector is normalized (the length is numerically equal to 1).
Public propertyIsNumericallyZero
Returns a value indicating whether this vector has zero size (the length is numerically equal to 0).
Public propertyItem
Gets or sets the component at the specified index.
Public propertyLargestComponent
Gets the value of the largest component.
Public propertyLength
Gets or sets the length of this vector.
Public propertyLengthSquared
Returns the squared length of this vector.
Public propertyNormalized
Returns the normalized vector.
Public propertyOrthonormal1
Returns an arbitrary normalized Vector3F that is orthogonal to this vector.
Public propertyOrthonormal2
Gets a normalized orthogonal Vector3F that is orthogonal to this Vector3F and to Orthonormal1.
Public propertySmallestComponent
Gets the value of the smallest component.
Top
Remarks
The three components (x, y, z) are stored with single-precision.
See Also