Click or drag to resize

Vector3 Structure

Describes a 3D-vector.
Inheritance Hierarchy
SystemObject
  SystemValueType
    CFX.Structures.GeometryVector3

Namespace: CFX.Structures.Geometry
Assembly: CFX (in CFX.dll) Version: 1.7.3
Syntax
[SerializableAttribute]
public struct Vector3 : IEquatable<Vector3>

The Vector3 type exposes the following members.

Constructors
 NameDescription
Public methodVector3(Double) Constructs a 3d vector with X, Y and Z set to the same value.
Public methodVector3(Vector2, Double) Constructs a 3d vector with X, Y from Vector2 and Z from a scalar.
Public methodVector3(Double, Double, Double) Constructs a 3d vector with X, Y and Z from three values.
Top
Properties
 NameDescription
Public propertyStatic memberBackward Returns a Vector3 with components 0, 0, 1.
Public propertyStatic memberDown Returns a Vector3 with components 0, -1, 0.
Public propertyStatic memberForward Returns a Vector3 with components 0, 0, -1.
Public propertyStatic memberLeft Returns a Vector3 with components -1, 0, 0.
Public propertyStatic memberOne Returns a Vector3 with components 1, 1, 1.
Public propertyStatic memberRight Returns a Vector3 with components 1, 0, 0.
Public propertyStatic memberUnitX Returns a Vector3 with components 1, 0, 0.
Public propertyStatic memberUnitY Returns a Vector3 with components 0, 1, 0.
Public propertyStatic memberUnitZ Returns a Vector3 with components 0, 0, 1.
Public propertyStatic memberUp Returns a Vector3 with components 0, 1, 0.
Public propertyStatic memberZero Returns a Vector3 with components 0, 0, 0.
Top
Methods
 NameDescription
Public methodStatic memberAdd(Vector3, Vector3) Performs vector addition on value1 and value2.
Public methodStatic memberAdd(Vector3, Vector3, Vector3) Performs vector addition on value1 and value2, storing the result of the addition in result.
Public methodStatic memberBarycentric(Vector3, Vector3, Vector3, Double, Double) Creates a new Vector3 that contains the cartesian coordinates of a vector specified in barycentric coordinates and relative to 3d-triangle.
Public methodStatic memberBarycentric(Vector3, Vector3, Vector3, Double, Double, Vector3) Creates a new Vector3 that contains the cartesian coordinates of a vector specified in barycentric coordinates and relative to 3d-triangle.
Public methodStatic memberCatmullRom(Vector3, Vector3, Vector3, Vector3, Double) Creates a new Vector3 that contains CatmullRom interpolation of the specified vectors.
Public methodStatic memberCatmullRom(Vector3, Vector3, Vector3, Vector3, Double, Vector3) Creates a new Vector3 that contains CatmullRom interpolation of the specified vectors.
Public methodStatic memberClamp(Vector3, Vector3, Vector3) Clamps the specified value within a range.
Public methodStatic memberClamp(Vector3, Vector3, Vector3, Vector3) Clamps the specified value within a range.
Public methodStatic memberCross(Vector3, Vector3) Computes the cross product of two vectors.
Public methodStatic memberCross(Vector3, Vector3, Vector3) Computes the cross product of two vectors.
Public methodStatic memberDistance(Vector3, Vector3) Returns the distance between two vectors.
Public methodStatic memberDistance(Vector3, Vector3, Double) Returns the distance between two vectors.
Public methodStatic memberDistanceSquared(Vector3, Vector3) Returns the squared distance between two vectors.
Public methodStatic memberDistanceSquared(Vector3, Vector3, Double) Returns the squared distance between two vectors.
Public methodStatic memberDivide(Vector3, Vector3) Divides the components of a Vector3 by the components of another Vector3.
Public methodStatic memberDivide(Vector3, Double) Divides the components of a Vector3 by a scalar.
Public methodStatic memberDivide(Vector3, Vector3, Vector3) Divides the components of a Vector3 by the components of another Vector3.
Public methodStatic memberDivide(Vector3, Double, Vector3) Divides the components of a Vector3 by a scalar.
Public methodStatic memberDot(Vector3, Vector3) Returns a dot product of two vectors.
Public methodStatic memberDot(Vector3, Vector3, Double) Returns a dot product of two vectors.
Public methodEquals(Object) Compares whether current instance is equal to specified Object.
(Overrides ValueTypeEquals(Object))
Public methodEquals(Vector3) Compares whether current instance is equal to specified Vector3.
Public methodGetHashCode Gets the hash code of this Vector3.
(Overrides ValueTypeGetHashCode)
Public methodStatic memberHermite(Vector3, Vector3, Vector3, Vector3, Double) Creates a new Vector3 that contains hermite spline interpolation.
Public methodStatic memberHermite(Vector3, Vector3, Vector3, Vector3, Double, Vector3) Creates a new Vector3 that contains hermite spline interpolation.
Public methodLength Returns the length of this Vector3.
Public methodLengthSquared Returns the squared length of this Vector3.
Public methodStatic memberLerp(Vector3, Vector3, Double) Creates a new Vector3 that contains linear interpolation of the specified vectors.
Public methodStatic memberLerp(Vector3, Vector3, Double, Vector3) Creates a new Vector3 that contains linear interpolation of the specified vectors.
Public methodStatic memberMax(Vector3, Vector3) Creates a new Vector3 that contains a maximal values from the two vectors.
Public methodStatic memberMax(Vector3, Vector3, Vector3) Creates a new Vector3 that contains a maximal values from the two vectors.
Public methodStatic memberMin(Vector3, Vector3) Creates a new Vector3 that contains a minimal values from the two vectors.
Public methodStatic memberMin(Vector3, Vector3, Vector3) Creates a new Vector3 that contains a minimal values from the two vectors.
Public methodStatic memberMultiply(Vector3, Vector3) Creates a new Vector3 that contains a multiplication of two vectors.
Public methodStatic memberMultiply(Vector3, Double) Creates a new Vector3 that contains a multiplication of Vector3 and a scalar.
Public methodStatic memberMultiply(Vector3, Vector3, Vector3) Creates a new Vector3 that contains a multiplication of two vectors.
Public methodStatic memberMultiply(Vector3, Double, Vector3) Creates a new Vector3 that contains a multiplication of Vector3 and a scalar.
Public methodStatic memberNegate(Vector3) Creates a new Vector3 that contains the specified vector inversion.
Public methodStatic memberNegate(Vector3, Vector3) Creates a new Vector3 that contains the specified vector inversion.
Public methodNormalize Turns this Vector3 to a unit vector with the same direction.
Public methodStatic memberNormalize(Vector3) Creates a new Vector3 that contains a normalized values from another vector.
Public methodStatic memberNormalize(Vector3, Vector3) Creates a new Vector3 that contains a normalized values from another vector.
Public methodStatic memberReflect(Vector3, Vector3) Creates a new Vector3 that contains reflect vector of the given vector and normal.
Public methodStatic memberReflect(Vector3, Vector3, Vector3) Creates a new Vector3 that contains reflect vector of the given vector and normal.
Public methodStatic memberSmoothStep(Vector3, Vector3, Double) Creates a new Vector3 that contains cubic interpolation of the specified vectors.
Public methodStatic memberSmoothStep(Vector3, Vector3, Double, Vector3) Creates a new Vector3 that contains cubic interpolation of the specified vectors.
Public methodStatic memberSubtract(Vector3, Vector3) Creates a new Vector3 that contains subtraction of on Vector3 from a another.
Public methodStatic memberSubtract(Vector3, Vector3, Vector3) Creates a new Vector3 that contains subtraction of on Vector3 from a another.
Public methodToString Returns a String representation of this Vector3 in the format: {X:[X] Y:[Y] Z:[Z]}
(Overrides ValueTypeToString)
Public methodStatic memberTransform(Vector3, Matrix44) Creates a new Vector3 that contains a transformation of 3d-vector by the specified Matrix44.
Public methodStatic memberTransform(Vector3, Quaternion) Creates a new Vector3 that contains a transformation of 3d-vector by the specified Quaternion, representing the rotation.
Public methodStatic memberTransform(Vector3, Matrix44, Vector3) Creates a new Vector3 that contains a transformation of 3d-vector by the specified Matrix44.
Public methodStatic memberTransform(Vector3, Quaternion, Vector3) Creates a new Vector3 that contains a transformation of 3d-vector by the specified Quaternion, representing the rotation.
Public methodStatic memberTransform(Vector3, Matrix44, Vector3) Apply transformation on all vectors within array of Vector3 by the specified Matrix44 and places the results in an another array.
Public methodStatic memberTransform(Vector3, Quaternion, Vector3) Apply transformation on all vectors within array of Vector3 by the specified Quaternion and places the results in an another array.
Public methodStatic memberTransform(Vector3, Int32, Matrix44, Vector3, Int32, Int32) Apply transformation on vectors within array of Vector3 by the specified Matrix44 and places the results in an another array.
Public methodStatic memberTransform(Vector3, Int32, Quaternion, Vector3, Int32, Int32) Apply transformation on vectors within array of Vector3 by the specified Quaternion and places the results in an another array. Source array.The starting index of transformation in the source array.The Quaternion which contains rotation transformation.Destination array.The starting index in the destination array, where the first Vector3 should be written.The number of vectors to be transformed.
Public methodStatic memberTransformNormal(Vector3, Matrix44) Creates a new Vector3 that contains a transformation of the specified normal by the specified Matrix44.
Public methodStatic memberTransformNormal(Vector3, Matrix44, Vector3) Creates a new Vector3 that contains a transformation of the specified normal by the specified Matrix44.
Public methodStatic memberTransformNormal(Vector3, Matrix44, Vector3) Apply transformation on all normals within array of Vector3 by the specified Matrix44 and places the results in an another array.
Public methodStatic memberTransformNormal(Vector3, Int32, Matrix44, Vector3, Int32, Int32) Apply transformation on normals within array of Vector3 by the specified Matrix44 and places the results in an another array.
Top
Operators
 NameDescription
Public operatorStatic memberAddition(Vector3, Vector3) Adds two vectors.
Public operatorStatic memberDivision(Vector3, Vector3) Divides the components of a Vector3 by the components of another Vector3.
Public operatorStatic memberDivision(Vector3, Double) Divides the components of a Vector3 by a scalar.
Public operatorStatic memberEquality(Vector3, Vector3) Compares whether two Vector3 instances are equal.
Public operatorStatic memberInequality(Vector3, Vector3) Compares whether two Vector3 instances are not equal.
Public operatorStatic memberModulus(Vector3, Vector3) The modulo operator, element by element (componentwise), of two vectors.
Public operatorStatic memberModulus(Vector3, Double) The modulo operator, element by element (componentwise) of the vector x_a on the left, but always with the number x_b on the right.
Public operatorStatic memberMultiply(Double, Vector3) Multiplies the components of vector by a scalar.
Public operatorStatic memberMultiply(Vector3, Vector3) Multiplies the components of two vectors by each other.
Public operatorStatic memberMultiply(Vector3, Double) Multiplies the components of vector by a scalar.
Public operatorStatic memberSubtraction(Vector3, Vector3) Subtracts a Vector3 from a Vector3.
Public operatorStatic memberUnaryNegation(Vector3) Inverts values in the specified Vector3.
Top
Fields
 NameDescription
Public fieldX The x coordinate of this Vector3.
Public fieldY The y coordinate of this Vector3.
Public fieldZ The z coordinate of this Vector3.
Top
See Also