﻿Vector3 Methods

# Vector3 Methods

RAGE Plugin Hook Documentation

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

The Vector3 type exposes the following members.

Methods

NameDescription
Around(Single)
Gets a position that's exactly the specified distance from this position.
Around(Single, Single)
Gets a position that's between the specified minimum and maximum distances from this position.
Around2D(Single)
Gets a position that's exactly the specified distance from this position, with the same value on the Z-axis as this position.
Around2D(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.
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 coordinates relative to a 3D triangle.
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.
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.
Cross(Vector3, Vector3)
Calculates the cross product of two vectors.
Cross(Vector3, Vector3, Vector3)
Calculates the cross product of two vectors.
Distance(Vector3, ISpatial)
Calculates the distance between a vector and a ISpatial
Distance(Vector3, Vector3)
Calculates the distance between two vectors.
Distance2D(Vector3, ISpatial)
Calculates the distance between a vector and a ISpatial, ignoring the Z-component.
Distance2D(Vector3, Vector3)
Calculates the distance between two vectors, ignoring the Z-component.
DistanceSquared(Vector3, ISpatial)
Calculates the distance between a vector and a ISpatial, ignoring the Z-component.
DistanceSquared(Vector3, Vector3)
Calculates the squared distance between two vectors.
DistanceTo(ISpatial)
DistanceTo(Vector3)
DistanceTo2D(ISpatial)
DistanceTo2D(Vector3)
Divide(Vector3, Single)
Scales a vector by the given value.
Divide(Vector3, Single, Vector3)
Scales a vector by the given value.
Dot
Calculates the dot product of two vectors.
Equals(Object)
Returns a value that indicates whether the current instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).)
Equals(Vector3)
Returns a value that indicates whether the current instance is equal to the specified object.
Equals(Vector3, Vector3)
Determines whether the specified object instances are considered equal.
GetHashCode
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Hermite(Vector3, Vector3, Vector3, Vector3, Single)
Performs a Hermite spline interpolation.
Hermite(Vector3, Vector3, Vector3, Vector3, Single, Vector3)
Performs a Hermite spline interpolation.
Length
Calculates the length of the vector.
LengthSquared
Calculates the squared length of the vector.
Lerp(Vector3, Vector3, Single)
Performs a linear interpolation between two vectors.
Lerp(Vector3, Vector3, Single, Vector3)
Performs a linear interpolation between two vectors.
Maximize(Vector3, Vector3)
Returns a vector containing the largest components of the specified vectors.
Maximize(Vector3, Vector3, Vector3)
Returns a vector containing the smallest components of the specified vectors.
Minimize(Vector3, Vector3)
Returns a vector containing the smallest components of the specified vectors.
Minimize(Vector3, Vector3, Vector3)
Returns a vector containing the smallest components of the specified vectors.
Modulate(Vector3, Vector3)
Modulates a vector by another.
Modulate(Vector3, Vector3, Vector3)
Modulates a vector by another.
Multiply(Vector3, Single)
Scales a vector by the given value.
Multiply(Vector3, Single, Vector3)
Scales a vector by the given value.
Negate(Vector3)
Reverses the direction of a given vector.
Negate(Vector3, Vector3)
Reverses the direction of a given vector.
Normalize
Converts the vector into a unit vector.
Normalize(Vector3)
Converts the vector into a unit vector.
Normalize(Vector3, Vector3)
Converts the vector into a unit vector.
Project(Vector3, Single, Single, Single, Single, Single, Single, Matrix)
Projects a 3D vector from object space into screen space.
Project(Vector3, Single, Single, Single, Single, Single, Single, Matrix, Vector3)
Projects a 3D vector from object space into screen space.
ProjectOnTo
Gets a new vector representing this vector projected onto the target vector.
Reflect(Vector3, Vector3)
Returns the reflection of a vector off a surface that has the specified normal.
Reflect(Vector3, Vector3, Vector3)
Returns the reflection of a vector off a surface that has the specified normal.
SmoothStep(Vector3, Vector3, Single)
Performs a cubic interpolation between two vectors.
SmoothStep(Vector3, Vector3, Single, Vector3)
Performs a cubic interpolation between two vectors.
Subtract(Vector3, Vector3)
Subtracts two vectors.
Subtract(Vector3, Vector3, Vector3)
Subtracts two vectors.
ToNormalized
ToQuaternion
ToRotator
ToString
Converts the value of the object to its equivalent string representation.
(Overrides ValueTypeToString.)
Transform(Vector3, Matrix)
Transforms a 3D vector by the given Matrix.
Transform(Vector3, Quaternion)
Transforms a 3D vector by the given Quaternion rotation.
Transform(Vector3, Matrix)
Transforms an array of 3D vectors by the given Matrix.
Transform(Vector3, Quaternion)
Transforms an array of 3D vectors by the given Quaternion rotation.
Transform(Vector3, Matrix, Vector4)
Transforms a 3D vector by the given Matrix.
Transform(Vector3, Quaternion, Vector4)
Transforms a 3D vector by the given Quaternion rotation.
Transform(Vector3, Matrix, Vector4)
Transforms an array of 3D vectors by the given Matrix.
Transform(Vector3*, Matrix*, Vector4*, Int32)
Transforms an array of 3D vectors by the given Matrix.
Transform(Vector3, Matrix, Vector4, Int32, Int32)
Transforms an array of 3D vectors by the given Matrix.
Transform(Vector3*, Int32, Matrix*, Vector4*, Int32, Int32)
Transforms an array of 3D vectors by the given Matrix.
TransformCoordinate(Vector3, Matrix)
Performs a coordinate transformation using the given Matrix.
TransformCoordinate(Vector3, Matrix)
Performs a coordinate transformation using the given Matrix.
TransformCoordinate(Vector3, Matrix, Vector3)
Performs a coordinate transformation using the given Matrix.
TransformCoordinate(Vector3, Matrix, Vector3)
Performs a coordinate transformation using the given Matrix.
TransformCoordinate(Vector3*, Matrix*, Vector3*, Int32)
Performs a coordinate transformation using the given Matrix.
TransformCoordinate(Vector3, Matrix, Vector3, Int32, Int32)
Performs a coordinate transformation using the given Matrix.
TransformCoordinate(Vector3*, Int32, Matrix*, Vector3*, Int32, Int32)
Performs a coordinate transformation using the given Matrix.
TransformNormal(Vector3, Matrix)
Performs a normal transformation using the given Matrix.
TransformNormal(Vector3, Matrix)
Performs a normal transformation using the given Matrix.
TransformNormal(Vector3, Matrix, Vector3)
Performs a normal transformation using the given Matrix.
TransformNormal(Vector3, Matrix, Vector3)
Performs a normal transformation using the given Matrix.
TransformNormal(Vector3*, Matrix*, Vector3*, Int32)
Performs a normal transformation using the given Matrix.
TransformNormal(Vector3, Matrix, Vector3, Int32, Int32)
Performs a normal transformation using the given Matrix.
TransformNormal(Vector3*, Int32, Matrix*, Vector3*, Int32, Int32)
Performs a normal transformation using the given Matrix.
TravelDistance(Vector3, ISpatial)
TravelDistance(Vector3, Vector3)
TravelDistanceTo(ISpatial)
TravelDistanceTo(Vector3)
Unproject(Vector3, Single, Single, Single, Single, Single, Single, Matrix)
Projects a 3D vector from screen space into object space.
Unproject(Vector3, Single, Single, Single, Single, Single, Single, Matrix, Vector3)
Projects a 3D vector from screen space into object space.
Top