Skip to content

FVector3

Description

Representation of 3D vectors and points.

Static Properties Description Vector3 FVector3
back Shorthand for writing Vector3(0, 0, -1).
down Shorthand for writing Vector3(0, -1, 0).
forward Shorthand for writing Vector3(0, 0, 1).
left Shorthand for writing Vector3(-1, 0, 0).
negativeInfinity Shorthand for writing Vector3(float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity).
one Shorthand for writing Vector3(1, 1, 1).
positiveInfinity Shorthand for writing Vector3(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity).
right Shorthand for writing Vector3(1, 0, 0).
up Shorthand for writing Vector3(0, 1, 0).
zero Shorthand for writing Vector3(0, 0, 0).
Properties Description Vector3 FVector3
magnitude Returns the length of this vector (Read Only).
normalized Returns this vector with a magnitude of 1 (Read Only).
sqrMagnitude Returns the squared length of this vector (Read Only).
this[int] Access the x, y, z component using [0], [1], [2] respectively.
x X component of the vector.
y Y component of the vector.
z Z component of the vector.
Constructors Description Vector3 FVector3
Vector3 Constructs a new vector with given x, y, z components.
FVector3 Constructs a new vector with given x, y, z components.
Public Methods Description Vector3 FVector3
Equals Returns true if the given vector is exactly equal to this vector.
Normalize Makes this vector have a magnitude of 1.
Set Set x, y, z components of an existing Vector3.
ToString Returns a formatted string for this vector.
Static Methods Description Vector3 FVector3
Angle Returns the unsigned angle in degrees between from and to.
ClampMagnitude Returns a copy of vector with its magnitude clamped to maxLength.
Cross Cross Product of two vectors.
Distance Returns the distance between a and b.
Dot Dot Product of two vectors.
Lerp Linearly interpolates between vectors a and b by t.
LerpUnclamped Linearly interpolates between vectors a and b by t.
Max Returns a vector that is made from the largest components of two vectors.
Min Returns a vector that is made from the smallest components of two vectors.
MoveTowards Moves a point current towards target.
Normalize Makes this vector have a magnitude of 1.
OrthoNormalize Makes vectors normalized and orthogonal to each other.
Project Projects a vector onto another vector.
ProjectOnPlane Projects a vector onto a plane defined by a normal orthogonal to the plane.
Reflect Reflects a vector off the vector defined by a normal.
RotateTowards Rotates a vector current towards target.
Scale Multiplies two vectors component-wise.
SignedAngle Returns the signed angle in degrees between from and to.
Slerp Spherically interpolates between two vectors.
SlerpUnclamped Spherically interpolates between two vectors.
SmoothDamp Gradually changes a vector towards a desired goal over time.
Operators Description Vector3 FVector3
operator - Subtracts one vector from another.
operator * Multiplies a vector by a number.
operator / Divides a vector by a number.
operator + Adds two vectors.
operator == Returns true if two vectors are approximately equal.
Vector3 Converts(explicit) a FVector3 to a Vector3.
FVector3 Converts(explicit) a Vector3 to a FVector3.
FVector3 Converts(explicit) a FVector2 to a FVector3.