Click or drag to resize
Vector3 Methods

[This is preliminary documentation and is subject to change.]

The Vector3 type exposes the following members.

Methods
  NameDescription
Public methodStatic memberAbs
Public methodAbsMax
Returns the component of the vector, whose absolute value is largest of all the three components.
Public methodAbsMin
Returns the component of the vector, whose absolute value is smallest of all the three components.
Public methodStatic memberAdd(Vector3, Vector3)
Adds two vectors.
Public methodStatic memberAdd(Vector3, Vector3, Vector3)
Adds two vectors.
Public methodStatic memberArePerpendicular
Public methodAssertIsValid
Public methodStatic memberBarycentric(Vector3, Vector3, Vector3, Single, Single)
Returns a Vector3 containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.
Public methodStatic memberBarycentric(Vector3, Vector3, Vector3, Single, Single, Vector3)
Returns a Vector3 containing the 3D Cartesian coordinates of a point specified in barycentric (areal) coordinates relative to a 3D triangle.
Public methodStatic memberCalculatePerpendicularVector(Vector3)
Public methodCalculatePerpendicularVector(Vector3)
Public methodStatic memberCatmullRom(Vector3, Vector3, Vector3, Vector3, Single)
Performs a Catmull-Rom interpolation using the specified positions.
Public methodStatic memberCatmullRom(Vector3, Vector3, Vector3, Vector3, Single, Vector3)
Performs a Catmull-Rom interpolation using the specified positions.
Public methodStatic memberCeiling
Public methodStatic memberClamp(Vector3, Vector3, Vector3)
Restricts a value to be within a specified range.
Public methodStatic memberClamp(Vector3, Vector3, Vector3, Vector3)
Restricts a value to be within a specified range.
Public methodStatic memberClampToSphere(Vector3, Single)
Public methodStatic memberClampToSphere(Vector3, Single)
Public methodStatic memberCreateFromAzimuthAndElevation
Public methodCross(Vector3)
Public methodStatic memberCross(Vector3, Vector3)
Calculates the cross product of two vectors.
Public methodStatic memberCross(Vector3, Vector3, Vector3)
Calculates the cross product of two vectors.
Public methodStatic memberDistance(Vector3, Vector3)
Calculates the distance between two vectors.
Public methodStatic memberDistance(Vector3, Vector3, Single)
Calculates the distance between two vectors.
Public methodStatic memberDistanceSquared(Vector3, Vector3)
Calculates the distance between two vectors squared.
Public methodStatic memberDistanceSquared(Vector3, Vector3, Single)
Calculates the distance between two vectors squared.
Public methodStatic memberDivide(Vector3, Single)
Divides a vector by a scalar value.
Public methodStatic memberDivide(Vector3, Vector3)
Divides the components of a vector by the components of another vector.
Public methodStatic memberDivide(Vector3, Single, Vector3)
Divides a vector by a scalar value.
Public methodStatic memberDivide(Vector3, Vector3, Vector3)
Divides the components of a vector by the components of another vector.
Public methodStatic memberDominantAxisProjection(Vector3)
Returns a vector that is equal to the projection of the input vector to the coordinate axis that corresponds to the original vector's largest value.
Public methodStatic memberDominantAxisProjection(Vector3, Vector3)
Calculates a vector that is equal to the projection of the input vector to the coordinate axis that corresponds to the original vector's largest value. The result is saved into a user-specified variable.
Public methodDot(Vector3)
Public methodDot(Vector3)
Public methodStatic memberDot(Vector3, Vector3)
Calculates the dot product of two vectors. If the two vectors are unit vectors, the dot product returns a floating point value between -1 and 1 that can be used to determine some properties of the angle between two vectors. For example, it can show whether the vectors are orthogonal, parallel, or have an acute or obtuse angle between them.
Public methodStatic memberDot(Vector3, Vector3, Single)
Calculates the dot product of two vectors and writes the result to a user-specified variable. If the two vectors are unit vectors, the dot product returns a floating point value between -1 and 1 that can be used to determine some properties of the angle between two vectors. For example, it can show whether the vectors are orthogonal, parallel, or have an acute or obtuse angle between them.
Public methodEquals(Object)
Returns a value that indicates whether the current instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(Vector3)
Determines whether the specified Object is equal to the Vector3.
Public methodStatic memberFloor
Public methodStatic memberGetAzimuthAndElevation
Public methodGetDim
Public methodGetHash
Gets the hash code of the vector object.
Public methodGetHashCode (Overrides ValueTypeGetHashCode.)
Public methodStatic memberGetNormalized
Public methodStatic memberHermite(Vector3, Vector3, Vector3, Vector3, Single)
Performs a Hermite spline interpolation.
Public methodStatic memberHermite(Vector3, Vector3, Vector3, Vector3, Single, Vector3)
Performs a Hermite spline interpolation.
Public methodInterpolate3
Public methodIsInsideInclusive
Public methodStatic memberIsUnit
Public methodIsValid
Public methodStatic memberIsZero(Vector3)
Public methodStatic memberIsZero(Vector3, Single)
Public methodStatic memberIsZeroVector(Vector3)
Public methodStatic memberIsZeroVector(Vector3, Single)
Public methodLength
Calculates the length of the vector.
Public methodLengthSquared
Calculates the length of the vector squared.
Public methodStatic memberLerp(Vector3, Vector3, Single)
Performs a linear interpolation between two vectors.
Public methodStatic memberLerp(Vector3, Vector3, Single, Vector3)
Performs a linear interpolation between two vectors.
Public methodMax
Returns the component of the vector that is largest of all the three components.
Public methodStatic memberMax(Vector3, Vector3)
Returns a vector that contains the highest value from each matching pair of components.
Public methodStatic memberMax(Vector3, Vector3, Vector3)
Returns a vector that contains the highest value from each matching pair of components.
Public methodMaxAbsComponent
Keeps only component with maximal absolute, others are set to zero.
Public methodMin
Returns the component of the vector that is smallest of all the three components.
Public methodStatic memberMin(Vector3, Vector3)
Returns a vector that contains the lowest value from each matching pair of components.
Public methodStatic memberMin(Vector3, Vector3, Vector3)
Returns a vector that contains the lowest value from each matching pair of components.
Public methodStatic memberMultiply(Vector3, Single)
Multiplies a vector by a scalar value.
Public methodStatic memberMultiply(Vector3, Vector3)
Multiplies the components of two vectors by each other.
Public methodStatic memberMultiply(Vector3, Single, Vector3)
Multiplies a vector by a scalar value.
Public methodStatic memberMultiply(Vector3, Vector3, Vector3)
Multiplies the components of two vectors by each other.
Public methodStatic memberNegate(Vector3)
Returns a vector pointing in the opposite direction.
Public methodStatic memberNegate(Vector3, Vector3)
Returns a vector pointing in the opposite direction.
Public methodNormalize
Turns the current vector into a unit vector. The result is a vector one unit in length pointing in the same direction as the original vector.
Public methodStatic memberNormalize(Vector3D)
Public methodStatic memberNormalize(Vector3)
Creates a unit vector from the specified vector. The result is a vector one unit in length pointing in the same direction as the original vector.
Public methodStatic memberNormalize(Vector3, Vector3)
Creates a unit vector from the specified vector, writing the result to a user-specified variable. The result is a vector one unit in length pointing in the same direction as the original vector.
Public methodStatic memberRectangularDistance(Vector3, Vector3)
Calculates rectangular distance (a.k.a. Manhattan distance or Chessboard distace) between two vectors.
Public methodStatic memberRectangularDistance(Vector3, Vector3)
Calculates rectangular distance (a.k.a. Manhattan distance or Chessboard distace) between two vectors.
Public methodStatic memberReflect(Vector3, Vector3)
Returns the reflection of a vector off a surface that has the specified normal. Reference page contains code sample.
Public methodStatic memberReflect(Vector3, Vector3, Vector3)
Returns the reflection of a vector off a surface that has the specified normal. Reference page contains code sample.
Public methodStatic memberReject(Vector3, Vector3)
Returns the rejection of vector from direction, i.e. projection of vector onto the plane defined by origin and direction
Public methodStatic memberReject(Vector3, Vector3, Vector3)
Returns the rejection of vector from direction, i.e. projection of vector onto the plane defined by origin and direction
Public methodStatic memberRound(Vector3)
Public methodStatic memberRound(Vector3, Int32)
Public methodSetDim
Public methodStatic memberSign
Public methodStatic memberSignNonZero
Returns per component sign, never returns zero. For zero component returns sign 1. Faster than Sign.
Public methodStatic memberSmoothStep(Vector3, Vector3, Single)
Interpolates between two values using a cubic equation.
Public methodStatic memberSmoothStep(Vector3, Vector3, Single, Vector3)
Interpolates between two values using a cubic equation.
Public methodStatic memberStep
Public methodStatic memberSubtract(Vector3, Vector3)
Subtracts a vector from a vector.
Public methodStatic memberSubtract(Vector3, Vector3, Vector3)
Subtracts a vector from a vector.
Public methodStatic memberSwapYZCoordinates
Public methodToString
Retrieves a string representation of the current object.
(Overrides ValueTypeToString.)
Public methodToString(String)
Public methodStatic memberTransform(Vector3, Matrix)
Transforms a 3D vector by the given matrix.
Public methodStatic memberTransform(Vector3, Matrix)
Public methodStatic memberTransform(Vector3, MatrixD)
Transforms a 3D vector by the given matrix.
Public methodStatic memberTransform(Vector3, Quaternion)
Transforms a Vector3 by a specified Quaternion rotation.
Public methodStatic memberTransform(Vector3, Matrix, Vector3)
Transforms a Vector3 by the given Matrix.
Public methodStatic memberTransform(Vector3, MatrixI, Vector3)
Public methodStatic memberTransform(Vector3, Quaternion, Vector3)
Transforms a Vector3 by a specified Quaternion rotation.
Public methodStatic memberTransform(Vector3, Matrix, Vector3)
Transforms a source array of Vector3s by a specified Matrix and writes the results to an existing destination array.
Public methodStatic memberTransform(Vector3, Quaternion, Vector3)
Transforms a source array of Vector3s by a specified Quaternion rotation and writes the results to an existing destination array.
Public methodStatic memberTransform(Vector3, Int32, Matrix, Vector3, Int32, Int32)
Applies a specified transform Matrix to a specified range of an array of Vector3s and writes the results into a specified range of a destination array.
Public methodStatic memberTransform(Vector3, Int32, Quaternion, Vector3, Int32, Int32)
Applies a specified Quaternion rotation to a specified range of an array of Vector3s and writes the results into a specified range of a destination array.
Public methodStatic memberTransformNormal(Vector3D, Matrix)
Transforms a 3D vector normal by a matrix.
Public methodStatic memberTransformNormal(Vector3, Matrix)
Transforms a 3D vector normal by a matrix.
Public methodStatic memberTransformNormal(Vector3, MatrixD)
Transforms a 3D vector normal by a matrix.
Public methodStatic memberTransformNormal(Vector3, MyBlockOrientation)
Public methodStatic memberTransformNormal(Vector3, Matrix, Vector3)
Transforms a vector normal by a matrix.
Public methodStatic memberTransformNormal(Vector3, MatrixD, Vector3)
Public methodStatic memberTransformNormal(Vector3, MatrixI, Vector3)
Public methodStatic memberTransformNormal(Vector3, MyBlockOrientation, Vector3)
Public methodStatic memberTransformNormal(Vector3, Matrix, Vector3)
Transforms an array of 3D vector normals by a specified Matrix.
Public methodStatic memberTransformNormal(Vector3, Int32, Matrix, Vector3, Int32, Int32)
Transforms a specified range in an array of 3D vector normals by a specified Matrix and writes the results to a specified range in a destination array.
Public methodVolumeInt
Top
See Also