Vector3 Structure

RAGE Plugin Hook Documentation

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

Defines a three component vector.

Namespace:  Rage
Assembly:  RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax

[SerializableAttribute]
public struct Vector3 : IEquatable<Vector3>

The Vector3 type exposes the following members.

Constructors

  NameDescription
Public methodVector3(Single)
Initializes a new instance of the Vector3 class.
Public methodVector3(Vector2, Single)
Initializes a new instance of the Vector3 class.
Public methodVector3(Single, Single, Single)
Initializes a new instance of the Vector3 class.
Top
Properties

  NameDescription
Public propertyItem
Public propertyStatic memberRandomUnit
Returns a unit vector pointing in a random direction on the X and Y axes.
Public propertyStatic memberRandomUnit2D
Returns a unit vector pointing in a random direction on the X and Y axes.
Public propertyStatic memberRelativeBack
Returns the relative Back vector. (0,-1,0)
Public propertyStatic memberRelativeBottom
Returns the relative Bottom vector. (0,0,-1)
Public propertyStatic memberRelativeFront
Returns the relative Front vector. (0,1,0)
Public propertyStatic memberRelativeLeft
Returns the relative Left vector. (-1,0,0)
Public propertyStatic memberRelativeRight
Returns the relative Right vector. (1,0,0)
Public propertyStatic memberRelativeTop
Returns the relative Top vector. (0,0,1)
Public propertyStatic memberSizeInBytes
Gets the size of the Vector3 type, in bytes.
Public propertyStatic memberUnitX
Gets the X unit Vector3 (1, 0, 0).
Public propertyStatic memberUnitY
Gets the Y unit Vector3 (0, 1, 0).
Public propertyStatic memberUnitZ
Gets the Z unit Vector3 (0, 0, 1).
Public propertyStatic memberWorldDown
Returns the world Down vector. (0,0,-1)
Public propertyStatic memberWorldEast
Returns the world East vector. (1,0,0)
Public propertyStatic memberWorldNorth
Returns the world North vector. (0,1,0)
Public propertyStatic memberWorldSouth
Returns the world South vector. (0,-1,0)
Public propertyStatic memberWorldUp
Returns the world Up vector. (0,0,1)
Public propertyStatic memberWorldWest
Returns the world West vector. (-1,0,0)
Public propertyStatic memberZero
Gets a Vector3 with all of its components set to zero.
Top
Methods

  NameDescription
Public methodStatic memberAdd(Vector3, Vector3)
Adds two vectors.
Public methodStatic memberAdd(Vector3, Vector3, Vector3)
Adds two vectors.
Public methodAround(Single)
Gets a position that's exactly the specified distance from this position.
Public methodAround(Single, Single)
Gets a position that's between the specified minimum and maximum distances from this position.
Public methodAround2D(Single)
Gets a position that's exactly the specified distance from this position, with the same value on the Z-axis as this position.
Public methodAround2D(Single, Single)
Gets a position that's between the specified minimum and maximum distances from this position, with the same value on the Z-axis as this position.
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 coordinates relative to a 3D triangle.
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 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 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, ISpatial)
Calculates the distance between a vector and a ISpatial
Public methodStatic memberDistance(Vector3, Vector3)
Calculates the distance between two vectors.
Public methodStatic memberDistance2D(Vector3, ISpatial)
Calculates the distance between a vector and a ISpatial, ignoring the Z-component.
Public methodStatic memberDistance2D(Vector3, Vector3)
Calculates the distance between two vectors, ignoring the Z-component.
Public methodStatic memberDistanceSquared(Vector3, ISpatial)
Calculates the distance between a vector and a ISpatial, ignoring the Z-component.
Public methodStatic memberDistanceSquared(Vector3, Vector3)
Calculates the squared distance between two vectors.
Public methodDistanceTo(ISpatial)
Public methodDistanceTo(Vector3)
Public methodDistanceTo2D(ISpatial)
Public methodDistanceTo2D(Vector3)
Public methodStatic memberDivide(Vector3, Single)
Scales a vector by the given value.
Public methodStatic memberDivide(Vector3, Single, Vector3)
Scales a vector by the given value.
Public methodStatic memberDot
Calculates the dot product of two vectors.
Public methodEquals(Object)
Returns a value that indicates whether the current instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(Vector3)
Returns a value that indicates whether the current instance is equal to the specified object.
Public methodStatic memberEquals(Vector3, Vector3)
Determines whether the specified object instances are considered equal.
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.)
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 methodLength
Calculates the length of the vector.
Public methodLengthSquared
Calculates the squared length of the vector.
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 methodStatic memberMaximize(Vector3, Vector3)
Returns a vector containing the largest components of the specified vectors.
Public methodStatic memberMaximize(Vector3, Vector3, Vector3)
Returns a vector containing the smallest components of the specified vectors.
Public methodStatic memberMinimize(Vector3, Vector3)
Returns a vector containing the smallest components of the specified vectors.
Public methodStatic memberMinimize(Vector3, Vector3, Vector3)
Returns a vector containing the smallest components of the specified vectors.
Public methodStatic memberModulate(Vector3, Vector3)
Modulates a vector by another.
Public methodStatic memberModulate(Vector3, Vector3, Vector3)
Modulates a vector by another.
Public methodStatic memberMultiply(Vector3, Single)
Scales a vector by the given value.
Public methodStatic memberMultiply(Vector3, Single, Vector3)
Scales a vector by the given value.
Public methodStatic memberNegate(Vector3)
Reverses the direction of a given vector.
Public methodStatic memberNegate(Vector3, Vector3)
Reverses the direction of a given vector.
Public methodNormalize
Converts the vector into a unit vector.
Public methodStatic memberNormalize(Vector3)
Converts the vector into a unit vector.
Public methodStatic memberNormalize(Vector3, Vector3)
Converts the vector into a unit vector.
Public methodStatic memberProject(Vector3, Single, Single, Single, Single, Single, Single, Matrix)
Projects a 3D vector from object space into screen space.
Public methodStatic memberProject(Vector3, Single, Single, Single, Single, Single, Single, Matrix, Vector3)
Projects a 3D vector from object space into screen space.
Public methodProjectOnTo
Gets a new vector representing this vector projected onto the target vector.
Public methodStatic memberReflect(Vector3, Vector3)
Returns the reflection of a vector off a surface that has the specified normal.
Public methodStatic memberReflect(Vector3, Vector3, Vector3)
Returns the reflection of a vector off a surface that has the specified normal.
Public methodStatic memberSmoothStep(Vector3, Vector3, Single)
Performs a cubic interpolation between two vectors.
Public methodStatic memberSmoothStep(Vector3, Vector3, Single, Vector3)
Performs a cubic interpolation between two vectors.
Public methodStatic memberSubtract(Vector3, Vector3)
Subtracts two vectors.
Public methodStatic memberSubtract(Vector3, Vector3, Vector3)
Subtracts two vectors.
Public methodToNormalized
Public methodToQuaternion
Public methodToRotator
Public methodToString
Converts the value of the object to its equivalent string representation.
(Overrides ValueTypeToString.)
Public methodStatic memberTransform(Vector3, Matrix)
Transforms a 3D vector by the given Matrix.
Public methodStatic memberTransform(Vector3, Quaternion)
Transforms a 3D vector by the given Quaternion rotation.
Public methodStatic memberTransform(Vector3, Matrix)
Transforms an array of 3D vectors by the given Matrix.
Public methodStatic memberTransform(Vector3, Quaternion)
Transforms an array of 3D vectors by the given Quaternion rotation.
Public methodStatic memberTransform(Vector3, Matrix, Vector4)
Transforms a 3D vector by the given Matrix.
Public methodStatic memberTransform(Vector3, Quaternion, Vector4)
Transforms a 3D vector by the given Quaternion rotation.
Public methodStatic memberTransform(Vector3, Matrix, Vector4)
Transforms an array of 3D vectors by the given Matrix.
Public methodStatic memberTransform(Vector3*, Matrix*, Vector4*, Int32)
Transforms an array of 3D vectors by the given Matrix.
Public methodStatic memberTransform(Vector3, Matrix, Vector4, Int32, Int32)
Transforms an array of 3D vectors by the given Matrix.
Public methodStatic memberTransform(Vector3*, Int32, Matrix*, Vector4*, Int32, Int32)
Transforms an array of 3D vectors by the given Matrix.
Public methodStatic memberTransformCoordinate(Vector3, Matrix)
Performs a coordinate transformation using the given Matrix.
Public methodStatic memberTransformCoordinate(Vector3, Matrix)
Performs a coordinate transformation using the given Matrix.
Public methodStatic memberTransformCoordinate(Vector3, Matrix, Vector3)
Performs a coordinate transformation using the given Matrix.
Public methodStatic memberTransformCoordinate(Vector3, Matrix, Vector3)
Performs a coordinate transformation using the given Matrix.
Public methodStatic memberTransformCoordinate(Vector3*, Matrix*, Vector3*, Int32)
Performs a coordinate transformation using the given Matrix.
Public methodStatic memberTransformCoordinate(Vector3, Matrix, Vector3, Int32, Int32)
Performs a coordinate transformation using the given Matrix.
Public methodStatic memberTransformCoordinate(Vector3*, Int32, Matrix*, Vector3*, Int32, Int32)
Performs a coordinate transformation using the given Matrix.
Public methodStatic memberTransformNormal(Vector3, Matrix)
Performs a normal transformation using the given Matrix.
Public methodStatic memberTransformNormal(Vector3, Matrix)
Performs a normal transformation using the given Matrix.
Public methodStatic memberTransformNormal(Vector3, Matrix, Vector3)
Performs a normal transformation using the given Matrix.
Public methodStatic memberTransformNormal(Vector3, Matrix, Vector3)
Performs a normal transformation using the given Matrix.
Public methodStatic memberTransformNormal(Vector3*, Matrix*, Vector3*, Int32)
Performs a normal transformation using the given Matrix.
Public methodStatic memberTransformNormal(Vector3, Matrix, Vector3, Int32, Int32)
Performs a normal transformation using the given Matrix.
Public methodStatic memberTransformNormal(Vector3*, Int32, Matrix*, Vector3*, Int32, Int32)
Performs a normal transformation using the given Matrix.
Public methodStatic memberTravelDistance(Vector3, ISpatial)
Public methodStatic memberTravelDistance(Vector3, Vector3)
Public methodTravelDistanceTo(ISpatial)
Public methodTravelDistanceTo(Vector3)
Public methodStatic memberUnproject(Vector3, Single, Single, Single, Single, Single, Single, Matrix)
Projects a 3D vector from screen space into object space.
Public methodStatic memberUnproject(Vector3, Single, Single, Single, Single, Single, Single, Matrix, Vector3)
Projects a 3D vector from screen space into object space.
Top
Operators

  NameDescription
Public operatorStatic memberAddition
Adds two vectors.
Public operatorStatic memberDivision
Scales a vector by the given value.
Public operatorStatic memberEquality
Tests for equality between two objects.
Public operatorStatic memberInequality
Tests for inequality between two objects.
Public operatorStatic memberMultiply(Single, Vector3)
Scales a vector by the given value.
Public operatorStatic memberMultiply(Vector3, Single)
Scales a vector by the given value.
Public operatorStatic memberSubtraction
Subtracts two vectors.
Public operatorStatic memberUnaryNegation
Reverses the direction of a given vector.
Top
Fields

  NameDescription
Public fieldX
Gets or sets the X component of the vector.
Public fieldY
Gets or sets the Y component of the vector.
Public fieldZ
Gets or sets the Z component of the vector.
Top
See Also

Reference