| Vector3 Structure |
[This is preliminary documentation and is subject to change.]
Defines a vector with three components.
Namespace: VRageMath
Assembly: VRage.Math (in VRage.Math.dll) Version: 1.0.0.0
SyntaxC#
[SerializableAttribute] public struct Vector3
The Vector3 type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Vector3(Single) |
Creates a new instance of Vector3.
|
| Vector3(Vector3I) | Initializes a new instance of the Vector3 class |
| Vector3(Vector3I) | Initializes a new instance of the Vector3 class |
| Vector3(Vector4) | Initializes a new instance of the Vector3 class |
| Vector3(Vector2, Single) |
Initializes a new instance of Vector3.
|
| Vector3(Double, Double, Double) | Initializes a new instance of the Vector3 class |
| Vector3(Single, Single, Single) |
Initializes a new instance of Vector3.
|
Properties
Methods| Name | Description | |
|---|---|---|
 | Abs | |
| AbsMax |
Returns the component of the vector, whose absolute value is largest of all the three components.
|
| AbsMin |
Returns the component of the vector, whose absolute value is smallest of all the three components.
|
| Add(Vector3, Vector3) |
Adds two vectors.
|
| Add(Vector3, Vector3, Vector3) |
Adds two vectors.
|
| ArePerpendicular | |
| AssertIsValid | |
| Barycentric(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.
|
| Barycentric(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.
|
| CalculatePerpendicularVector(Vector3) | |
| CalculatePerpendicularVector(Vector3) | |
| CatmullRom(Vector3, Vector3, Vector3, Vector3, Single) |
Performs a Catmull-Rom interpolation using the specified positions.
|
| CatmullRom(Vector3, Vector3, Vector3, Vector3, Single, Vector3) |
Performs a Catmull-Rom interpolation using the specified positions.
|
| Ceiling | |
| Clamp(Vector3, Vector3, Vector3) |
Restricts a value to be within a specified range.
|
| Clamp(Vector3, Vector3, Vector3, Vector3) |
Restricts a value to be within a specified range.
|
| ClampToSphere(Vector3, Single) | |
| ClampToSphere(Vector3, Single) | |
| CreateFromAzimuthAndElevation | |
| Cross(Vector3) | |
| Cross(Vector3, Vector3) |
Calculates the cross product of two vectors.
|
| Cross(Vector3, Vector3, Vector3) |
Calculates the cross product of two vectors.
|
| Distance(Vector3, Vector3) |
Calculates the distance between two vectors.
|
| Distance(Vector3, Vector3, Single) |
Calculates the distance between two vectors.
|
| DistanceSquared(Vector3, Vector3) |
Calculates the distance between two vectors squared.
|
| DistanceSquared(Vector3, Vector3, Single) |
Calculates the distance between two vectors squared.
|
| Divide(Vector3, Single) |
Divides a vector by a scalar value.
|
| Divide(Vector3, Vector3) |
Divides the components of a vector by the components of another vector.
|
| Divide(Vector3, Single, Vector3) |
Divides a vector by a scalar value.
|
| Divide(Vector3, Vector3, Vector3) |
Divides the components of a vector by the components of another vector.
|
| DominantAxisProjection(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.
|
| DominantAxisProjection(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.
|
| Dot(Vector3) | |
| Dot(Vector3) | |
| Dot(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.
|
| Dot(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.
|
| Equals(Object) |
Returns a value that indicates whether the current instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).) |
| Equals(Vector3) |
Determines whether the specified Object is equal to the Vector3.
|
| Floor | |
| GetAzimuthAndElevation | |
| GetDim | |
| GetHash |
Gets the hash code of the vector object.
|
| GetHashCode | (Overrides ValueTypeGetHashCode.) |
| GetNormalized | |
| Hermite(Vector3, Vector3, Vector3, Vector3, Single) |
Performs a Hermite spline interpolation.
|
| Hermite(Vector3, Vector3, Vector3, Vector3, Single, Vector3) |
Performs a Hermite spline interpolation.
|
| Interpolate3 | |
| IsInsideInclusive | |
| IsUnit | |
| IsValid | |
| IsZero(Vector3) | |
| IsZero(Vector3, Single) | |
| IsZeroVector(Vector3) | |
| IsZeroVector(Vector3, Single) | |
| Length |
Calculates the length of the vector.
|
| LengthSquared |
Calculates the length of the vector squared.
|
| Lerp(Vector3, Vector3, Single) |
Performs a linear interpolation between two vectors.
|
| Lerp(Vector3, Vector3, Single, Vector3) |
Performs a linear interpolation between two vectors.
|
| Max |
Returns the component of the vector that is largest of all the three components.
|
| Max(Vector3, Vector3) |
Returns a vector that contains the highest value from each matching pair of components.
|
| Max(Vector3, Vector3, Vector3) |
Returns a vector that contains the highest value from each matching pair of components.
|
| MaxAbsComponent |
Keeps only component with maximal absolute, others are set to zero.
|
| Min |
Returns the component of the vector that is smallest of all the three components.
|
| Min(Vector3, Vector3) |
Returns a vector that contains the lowest value from each matching pair of components.
|
| Min(Vector3, Vector3, Vector3) |
Returns a vector that contains the lowest value from each matching pair of components.
|
| Multiply(Vector3, Single) |
Multiplies a vector by a scalar value.
|
| Multiply(Vector3, Vector3) |
Multiplies the components of two vectors by each other.
|
| Multiply(Vector3, Single, Vector3) |
Multiplies a vector by a scalar value.
|
| Multiply(Vector3, Vector3, Vector3) |
Multiplies the components of two vectors by each other.
|
| Negate(Vector3) |
Returns a vector pointing in the opposite direction.
|
| Negate(Vector3, Vector3) |
Returns a vector pointing in the opposite direction.
|
| Normalize |
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.
|
| Normalize(Vector3D) | |
| Normalize(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.
|
| Normalize(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.
|
| RectangularDistance(Vector3, Vector3) |
Calculates rectangular distance (a.k.a. Manhattan distance or Chessboard distace) between two vectors.
|
| RectangularDistance(Vector3, Vector3) |
Calculates rectangular distance (a.k.a. Manhattan distance or Chessboard distace) between two vectors.
|
| Reflect(Vector3, Vector3) |
Returns the reflection of a vector off a surface that has the specified normal. Reference page contains code sample.
|
| Reflect(Vector3, Vector3, Vector3) |
Returns the reflection of a vector off a surface that has the specified normal. Reference page contains code sample.
|
| Reject(Vector3, Vector3) |
Returns the rejection of vector from direction, i.e. projection of vector onto the plane defined by origin and direction
|
| Reject(Vector3, Vector3, Vector3) |
Returns the rejection of vector from direction, i.e. projection of vector onto the plane defined by origin and direction
|
| Round(Vector3) | |
| Round(Vector3, Int32) | |
| SetDim | |
| Sign | |
| SignNonZero |
Returns per component sign, never returns zero.
For zero component returns sign 1.
Faster than Sign.
|
| SmoothStep(Vector3, Vector3, Single) |
Interpolates between two values using a cubic equation.
|
| SmoothStep(Vector3, Vector3, Single, Vector3) |
Interpolates between two values using a cubic equation.
|
| Step | |
| Subtract(Vector3, Vector3) |
Subtracts a vector from a vector.
|
| Subtract(Vector3, Vector3, Vector3) |
Subtracts a vector from a vector.
|
| SwapYZCoordinates | |
| ToString |
Retrieves a string representation of the current object.
(Overrides ValueTypeToString.) |
| ToString(String) | |
| Transform(Vector3, Matrix) |
Transforms a 3D vector by the given matrix.
|
| Transform(Vector3, Matrix) | |
| Transform(Vector3, MatrixD) |
Transforms a 3D vector by the given matrix.
|
| Transform(Vector3, Quaternion) |
Transforms a Vector3 by a specified Quaternion rotation.
|
| Transform(Vector3, Matrix, Vector3) |
Transforms a Vector3 by the given Matrix.
|
| Transform(Vector3, MatrixI, Vector3) | |
| Transform(Vector3, Quaternion, Vector3) |
Transforms a Vector3 by a specified Quaternion rotation.
|
| Transform(Vector3, Matrix, Vector3) |
Transforms a source array of Vector3s by a specified Matrix and writes the results to an existing destination array.
|
| Transform(Vector3, Quaternion, Vector3) |
Transforms a source array of Vector3s by a specified Quaternion rotation and writes the results to an existing destination array.
|
| Transform(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.
|
| Transform(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.
|
| TransformNormal(Vector3D, Matrix) |
Transforms a 3D vector normal by a matrix.
|
| TransformNormal(Vector3, Matrix) |
Transforms a 3D vector normal by a matrix.
|
| TransformNormal(Vector3, MatrixD) |
Transforms a 3D vector normal by a matrix.
|
| TransformNormal(Vector3, MyBlockOrientation) | |
| TransformNormal(Vector3, Matrix, Vector3) |
Transforms a vector normal by a matrix.
|
| TransformNormal(Vector3, MatrixD, Vector3) | |
| TransformNormal(Vector3, MatrixI, Vector3) | |
| TransformNormal(Vector3, MyBlockOrientation, Vector3) | |
| TransformNormal(Vector3, Matrix, Vector3) |
Transforms an array of 3D vector normals by a specified Matrix.
|
| TransformNormal(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.
|
| VolumeInt |
Operators| Name | Description | |
|---|---|---|
 | Addition(Vector3, Single) | |
| Addition(Vector3, Vector3) |
Adds two vectors.
|
| Division(Single, Vector3) | |
| Division(Vector3, Single) |
Divides a vector by a scalar value.
|
| Division(Vector3, Vector3) |
Divides the components of a vector by the components of another vector.
|
| Equality |
Tests vectors for equality.
|
| Inequality |
Tests vectors for inequality.
|
| Multiply(Single, Vector3) |
Multiplies a vector by a scalar value.
|
| Multiply(Vector3, Single) |
Multiplies a vector by a scalar value.
|
| Multiply(Vector3, Vector3) |
Multiplies the components of two vectors by each other.
|
| Subtraction(Vector3, Single) | |
| Subtraction(Vector3, Vector3) |
Subtracts a vector from a vector.
|
| UnaryNegation |
Returns a vector pointing in the opposite direction.
|
Fields| Name | Description | |
|---|---|---|
 | Backward | |
| Down | |
| Forward | |
| Half | |
| Invalid | |
| Left | |
| MaxValue | |
| MinusOne | |
| MinValue | |
| NegativeInfinity | |
| One | |
| PositiveInfinity | |
| Right | |
| UnitX | |
| UnitY | |
| UnitZ | |
| Up | |
| X |
Gets or sets the x-component of the vector.
|
| Y |
Gets or sets the y-component of the vector.
|
| Z |
Gets or sets the z-component of the vector.
|
| Zero |
See Also