Vector3F Structure

Vector3F 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

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(Vector3FConverter))]
[DataContractAttribute]
public struct Vector3F : IEquatable<Vector3F>

<SerializableAttribute>
<TypeConverterAttribute(GetType(Vector3FConverter))>
<DataContractAttribute>
Public Structure Vector3F
	Implements IEquatable(Of Vector3F)

[SerializableAttribute]
[TypeConverterAttribute(typeof(Vector3FConverter))]
[DataContractAttribute]
public value class Vector3F : IEquatable<Vector3F>

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

The Vector3F type exposes the following members.

Constructors

	Name	Description
	Vector3F(IListSingle)	Initializes a new instance of the Vector3F class.
	Vector3F(Single)	Initializes a new instance of Vector3F.
	Vector3F(Single)	Initializes a new instance of Vector3F.
	Vector3F(Single, Single, Single)	Initializes a new instance of Vector3F.

Top

Methods

	Name	Description
	Absolute	Sets each vector component to its absolute value.
	Absolute(Vector3F)	Returns a vector with the absolute values of the elements of the given vector.
	Add	Adds two vectors.
	AreNumericallyEqual(Vector3F, Vector3F)	Determines whether two vectors are equal (regarding the tolerance EpsilonF).
	AreNumericallyEqual(Vector3F, Vector3F, Single)	Determines whether two vectors are equal (regarding a specific tolerance).
	Clamp(Single, Single)	Clamps the vector components to the range [min, max].
	Clamp(Vector3F, Single, Single)	Returns a vector with the vector components clamped to the range [min, max].
	ClampToZero	Clamps near-zero vector components to zero.
	ClampToZero(Single)	Clamps near-zero vector components to zero.
	ClampToZero(Vector3F)	Returns a vector with near-zero vector components clamped to 0.
	ClampToZero(Vector3F, Single)	Returns a vector with near-zero vector components clamped to 0.
	Cross	Calculates the cross product of two vectors.
	Divide(Vector3F, Vector3F)	Divides the components of a vector by the components of another vector.
	Divide(Vector3F, Single)	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(Vector3F)	Indicates whether the current object is equal to another object of the same type.
	FromXna	Converts this Vector3F (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(Single, Vector3F)	Multiplies a vector by a scalar.
	Multiply(Vector3F, Vector3F)	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 Vector3F equivalent.
	Parse(String, IFormatProvider)	Converts the string representation of a 3-dimensional vector in a specified culture-specific format to its Vector3F equivalent.
	ProjectTo(Vector3F)	Sets this vector to its projection onto the axis given by the target vector.
	ProjectTo(Vector3F, Vector3F)	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 float values.
	ToCrossProductMatrix	Returns the cross product matrix (skew matrix) of this vector.
	ToList	Converts this vector to a list of 3 float 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.
	ToVector3D	Converts this Vector3F to Vector3D.
	ToVectorF	Converts this Vector3F to VectorF.
	ToXna	Converts this Vector3F (DigitalRune Mathematics) to Vector3 (XNA Framework).
	TryNormalize	Tries to normalize the vector.

Top

Operators

	Name	Description
	Addition	Adds two vectors.
	Division(Vector3F, Vector3F)	Divides the components of a vector by the components of another vector.
	Division(Vector3F, Single)	Divides a vector by a scalar.
	Equality	Tests if two vectors are equal.
	(Vector3 to Vector3F)	Performs an conversion from Vector3 (XNA Framework) to Vector3F (DigitalRune Mathematics).
	(Vector3F to Single)	Converts a vector to an array of 3 float values.
	(Vector3F to ListSingle)	Converts a vector to a list of 3 float values.
	(Vector3F to Vector3)	Performs an conversion from Vector3F (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.
	(Vector3F to Vector3D)	Performs an implicit conversion from Vector3F to Vector3D.
	(Vector3F to VectorF)	Performs an implicit conversion from Vector3F to VectorF.
	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(Single, Vector3F)	Multiplies a vector by a scalar.
	Multiply(Vector3F, Vector3F)	Multiplies the components of two vectors by each other.
	Multiply(Vector3F, Single)	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 Vector3F pointing backward (0, 0, 1). (Only available in the XNA-compatible build.)
	Down	Returns a unit Vector3F pointing down (0, −1, 0). (Only available in the XNA-compatible build.)
	Forward	Returns a unit Vector3F pointing forward (0, 0, −1). (Only available in the XNA-compatible build.)
	Left	Returns a unit Vector3F pointing left (-1, 0, 0). (Only available in the XNA-compatible build.)
	One	Returns a Vector3F with all of its components set to one.
	Right	Returns a unit Vector3F pointing right (1, 0, 0). (Only available in the XNA-compatible build.)
	UnitX	Returns the x unit Vector3F (1, 0, 0).
	UnitY	Returns the value2 unit Vector3F (0, 1, 0).
	UnitZ	Returns the z unit Vector3F (0, 0, 1).
	Up	Returns a unit Vector3F 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 Vector3F 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 Vector3F that is orthogonal to this vector.
	Orthonormal2	Gets a normalized orthogonal Vector3F that is orthogonal to this Vector3F and to Orthonormal1.
	SmallestComponent	Gets the value of the smallest component.

Top

Remarks

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

Reference

DigitalRune.Mathematics.Algebra Namespace