1. Epic GamesDeveloper
  3. TVector

TVector

Forward declaration of templates.

API > API/Runtime > API/Runtime/Core

A vector in 3-D space composed of components (X, Y, Z) with floating point precision.

   
Name TVector
Type struct
Header File /Engine/Source/Runtime/Core/Public/Math/MathFwd.h
Include Path #include "Math/MathFwd.h"
Source /Engine/Source/Runtime/Core/Public/Math/Vector.h

Syntax

template<typename T>  
struct TVector

Derived Classes

TVector derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

TVector ( const FLinearColor& InColor
)

 Constructs a vector from an FLinearColor. Math/Vector.h  

TVector ( TIntVector3< IntType > InVector
)

 Constructs a vector from an FIntVector. Math/Vector.h  

TVector ( TIntPoint< IntType > A
)

 Constructs a vector from an FIntPoint. Math/Vector.h  
Constructor which initializes all components to zero. Math/Vector.h  

TVector ( const UE::Math::TVector4< T >& V
)

 Constructor using the XYZ components from a 4D vector.FVector inline functions Math/Vector.h  

TVector ( const TVector< FArg >& From
)

 Conversion from other type. Math/Vector.h  

constexpr TVector ( T InF,
TVectorConstInit
)

   Math/Vector.h  

TVector ( T InF
)

 Constructor initializing all components to a single T value. Math/Vector.h  

TVector ( T InX,
T InY,
T InZ
)

 Constructor using initial values for each component. Math/Vector.h  

TVector ( const TVector2< T > V,
T InZ
)

 Constructs a vector from an TVector2 and Z value.FVector inline functions Math/Vector.h  

TVector ()

 Default constructor (no initialization). Math/Vector.h  

Class Specializations

Name Remarks
TVector< FReal, 4 >  
TVector< FRealDouble, 2 >  
TVector< FRealDouble, 3 >  
TVector< FRealSingle, 2 >  
TVector< FRealSingle, 3 >  
TVector< int32, 2 >  
TVector< T, 3 >  

Typedefs

Name Type Remarks Include Path
FReal T   Math/Vector.h

Constants

Name Type Remarks Include Path
BackwardVector const TVector< T > Unreal backward vector (-1,0,0) Math/Vector.h
DownVector const TVector< T > Unreal down vector (0,0,-1) Math/Vector.h
ForwardVector const TVector< T > Unreal forward vector (1,0,0) Math/Vector.h
LeftVector const TVector< T > Unreal left vector (0,-1,0) Math/Vector.h
NumComponents int32 The number of components this vector type has. Math/Vector.h
OneVector const TVector< T > One vector (1,1,1) Math/Vector.h
RightVector const TVector< T > Unreal right vector (0,1,0) Math/Vector.h
UpVector const TVector< T > Unreal up vector (0,0,1) Math/Vector.h
XAxisVector const TVector< T > Unit X axis vector (1,0,0) Math/Vector.h
YAxisVector const TVector< T > Unit Y axis vector (0,1,0) Math/Vector.h
ZAxisVector const TVector< T > Unit Z axis vector (0,0,1) Math/Vector.h
ZeroVector const TVector< T > A zero vector (0,0,0) Math/Vector.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TVector union UE::Math::TVector   Math/Vector.h  
X T Vector's X component. Math/Vector.h  
XYZ T   Math/Vector.h  
Y T Vector's Y component. Math/Vector.h  
Z T Vector's Z component. Math/Vector.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBounded ( const TVector< T >& V,
T Radius
)

 Add a vector to this and clamp the result in a cube. Math/Vector.h  

bool AllComponentsEqual ( T Tolerance
) const

 Checks whether all components of this vector are the same, within a tolerance. Math/Vector.h  

TVector< T > BoundToBox ( const TVector< T >& Min,
const TVector< T >& Max
) const

 Get a copy of this vector, clamped inside of a cube. Math/Vector.h  

TVector< T > BoundToCube ( T Radius
) const

 Get a copy of this vector, clamped inside of a cube. Math/Vector.h  

T Component ( int32 Index
) const

 Gets a specific component of the vector. Math/Vector.h  

T & Component ( int32 Index
)

 Gets a specific component of the vector. Math/Vector.h  

TVector< T > ComponentMax ( const TVector< T >& Other
) const

 Gets the component-wise max of two vectors. Math/Vector.h  

TVector< T > ComponentMin ( const TVector< T >& Other
) const

 Gets the component-wise min of two vectors. Math/Vector.h  

bool ContainsNaN()

 Utility to check if there are any non-finite values (NaN or Inf) in this vector. Math/Vector.h  

T CosineAngle2D ( TVector< T > B
) const

 Returns the cosine of the angle between this vector and another projected onto the XY plane (no Z). Math/Vector.h  

TVector< T > Cross ( const TVector< T >& V2
) const

 Calculate cross product between this and another vector. Math/Vector.h  
  Math/Vector.h  

void DiagnosticCheckNaN ( const TCHAR* Message
) const

   Math/Vector.h  

T Dot ( const TVector< T >& V
) const

 Calculate the dot product between this and another vector. Math/Vector.h  

bool Equals ( const TVector< T >& V,
T Tolerance
) const

 Check against another vector for equality, within specified error limits. Math/Vector.h  

void FindBestAxisVectors ( TVector< T >& Axis1,
TVector< T >& Axis2
) const

 Find good arbitrary axis vectors to represent U and V axes of a plane, using this vector as the normal of the plane. Math/Vector.h  

TVector< T > GetAbs()

 Get a copy of this vector with absolute value of each component. Math/Vector.h  

T GetAbsMax()

 Get the maximum absolute value of the vector's components. Math/Vector.h  

T GetAbsMin()

 Get the minimum absolute value of the vector's components. Math/Vector.h  

TVector< T > GetClampedToMaxSize ( T MaxSize
) const

 Create a copy of this vector, with its maximum magnitude clamped to MaxSize. Math/Vector.h  

TVector< T > GetClampedToMaxSize2D ( T MaxSize
) const

 Create a copy of this vector, with the maximum 2D magnitude clamped to MaxSize. Z is unchanged. Math/Vector.h  

TVector< T > GetClampedToSize ( T Min,
T Max
) const

 Create a copy of this vector, with its magnitude clamped between Min and Max. Math/Vector.h  

TVector< T > GetClampedToSize2D ( T Min,
T Max
) const

 Create a copy of this vector, with the 2D magnitude clamped between Min and Max. Z is unchanged. Math/Vector.h  

T GetComponentForAxis ( EAxis::Type Axis
) const

 Get a specific component of the vector, given a specific axis by enum Math/Vector.h  

T GetMax()

 Get the maximum value of the vector's components. Math/Vector.h  

T GetMin()

 Get the minimum value of the vector's components. Math/Vector.h  

TVector< T > GetSafeNormal ( T Tolerance,
const TVector< T >& ResultIfZero
) const

 Gets a normalized copy of the vector, checking it is safe to do so based on the length. Math/Vector.h  

TVector< T > GetSafeNormal2D ( T Tolerance,
const TVector< T >& ResultIfZero
) const

 Gets a normalized copy of the 2D components of the vector, checking it is safe to do so. Math/Vector.h  
Get a copy of the vector as sign only. Math/Vector.h  
Calculates normalized version of vector without checking for zero length. Math/Vector.h  
Calculates normalized 2D version of vector without checking for zero length. Math/Vector.h  

TVector< T > GridSnap ( const T& GridSz
) const

 Gets a copy of this vector snapped to a grid. Math/Vector.h  

T HeadingAngle()

 Convert a direction vector into a 'heading' angle. Math/Vector.h  

bool InitFromCompactString ( const FString& InSourceString
)

 Initialize this Vector based on an FString. Math/Vector.h  

bool InitFromString ( const FString& InSourceString
)

 Initialize this Vector based on an FString. Math/Vector.h  

bool IsNearlyZero ( T Tolerance
) const

 Checks whether vector is near to zero within a specified tolerance. Math/Vector.h  

bool IsNormalized()

 Checks whether vector is normalized. Math/Vector.h  

bool IsUniform ( T Tolerance
) const

 Check whether X, Y and Z are nearly equal. Math/Vector.h  

bool IsUnit ( T LengthSquaredTolerance
) const

 Check if the vector is of unit length, with specified tolerance. Math/Vector.h  

bool IsValidIndex ( int32 Index
) const

 Tests if index is valid, i.e. greater than or equal to zero, and less than the number of components in the vector. Math/Vector.h  

bool IsZero()

 Checks whether all components of the vector are exactly zero. Math/Vector.h  

T Length()

 Get the length (magnitude) of this vector. Math/Vector.h  

TVector< T > MirrorByPlane ( const TPlane< T >& Plane
) const

 Mirrors a vector about a plane.TVector inline functions Math/Vector.h  

TVector< T > MirrorByVector ( const TVector< T >& MirrorNormal
) const

 Mirror a vector about a normal vector. Math/Vector.h  

bool NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess
)

 Network serialization function. Math/Vector.h  

bool Normalize ( T Tolerance
)

 Normalize this vector in-place if it is larger than a given tolerance. Leaves it unchanged if not. Math/Vector.h  

TVector< T > Projection()

 Projects 2D components of vector based on Z. Math/Vector.h  

TVector< T > ProjectOnTo ( const TVector< T >& A
) const

 Gets a copy of this vector projected onto the input vector. Math/Vector.h  

TVector< T > ProjectOnToNormal ( const TVector< T >& Normal
) const

 Gets a copy of this vector projected onto the input vector, which is assumed to be unit length. Math/Vector.h  
Gets the reciprocal of this vector, avoiding division by zero. Math/Vector.h  

TVector< T > RotateAngleAxis ( const T AngleDeg,
const TVector< T >& Axis
) const

 Rotates around Axis (assumes Axis.Size() == 1). Math/Vector.h  

TVector< T > RotateAngleAxisRad ( const T AngleRad,
const TVector< T >& Axis
) const

 Rotates around Axis (assumes Axis.Size() == 1). Math/Vector.h  
Return the UE::Math::TRotator orientation corresponding to the direction in which the vector points. Math/Vector.h  

bool Serialize ( FStructuredArchive::FSlot Slot
)

   Math/Vector.h  

bool Serialize ( FArchive& Ar
)

   Math/Vector.h  

bool SerializeFromMismatchedTag ( FName StructTag,
FStructuredArchive::FSlot Slot
)

   Math/Vector.h  

void Set ( T InX,
T InY,
T InZ
)

 Set the values of the vector directly. Math/Vector.h  

void SetComponentForAxis ( EAxis::Type Axis,
T Component
)

 Set a specified componet of the vector, given a specific axis by enum Math/Vector.h  

T Size()

 Get the length (magnitude) of this vector. Math/Vector.h  

T Size2D()

 Get the length of the 2D components of this vector. Math/Vector.h  

T SizeSquared()

 Get the squared length of this vector. Math/Vector.h  

T SizeSquared2D()

 Get the squared length of the 2D components of this vector. Math/Vector.h  

T SquaredLength()

 Get the squared length of this vector. Math/Vector.h  

FString ToCompactString()

 Get a short textural representation of this vector, for compact readable logging. Math/Vector.h  

FText ToCompactText()

 Get a short locale aware textural representation of this vector, for compact readable logging. Math/Vector.h  

void ToDirectionAndLength ( TVector< T >& OutDir,
double& OutLength
) const

 Util to convert this vector into a unit direction vector and its original length. Math/Vector.h  

void ToDirectionAndLength ( TVector< T >& OutDir,
float& OutLength
) const

   Math/Vector.h  
Return the Quaternion orientation corresponding to the direction in which the vector points. Math/Vector.h  
Return the TRotator orientation corresponding to the direction in which the vector points. Math/Vector.h  

FString ToString()

 Get a textual representation of this vector. Math/Vector.h  

FText ToText()

 Get a locale aware textual representation of this vector. Math/Vector.h  

TVector2< T > UnitCartesianToSpherical()

 Converts a Cartesian unit vector into spherical coordinates on the unit sphere. Math/Vector.h  

void UnwindEuler()

 When this vector contains Euler angles (degrees), ensure that angles are between +/-180 Math/Vector.h  

Static

Name Remarks Include Path Unreal Specifiers

static T BoxPushOut ( const TVector< T >& Normal,
const TVector< T >& Size
)

 Compute pushout of a box from a plane. Math/Vector.h  

static bool Coincident ( const TVector< T >& Normal1,
const TVector< T >& Normal2,
T ParallelCosineThreshold
)

 See if two normal vectors are coincident (nearly parallel and point in the same direction). Math/Vector.h  

static bool Coplanar ( const TVector< T >& Base1,
const TVector< T >& Normal1,
const TVector< T >& Base2,
const TVector< T >& Normal2,
T ParallelCosineThreshold
)

 See if two planes are coplanar. Math/Vector.h  

static void CreateOrthonormalBasis ( TVector< T >& XAxis,
TVector< T >& YAxis,
TVector< T >& ZAxis
)

 Create an orthonormal basis from a basis with at least two orthogonal vectors. Math/Vector.h  

static TVector< T > CrossProduct ( const TVector< T >& A,
const TVector< T >& B
)

 Calculate the cross product of two vectors. Math/Vector.h  

static TVector< T > DegreesToRadians ( const TVector< T >& DegVector
)

 Converts a vector containing degree values to a vector containing radian values. Math/Vector.h  

static T Dist ( const TVector< T >& V1,
const TVector< T >& V2
)

 Euclidean distance between two points. Math/Vector.h  

static T Dist2D ( const TVector< T >& V1,
const TVector< T >& V2
)

   Math/Vector.h  

static T Distance ( const TVector< T >& V1,
const TVector< T >& V2
)

   Math/Vector.h  

static T DistSquared ( const TVector< T >& V1,
const TVector< T >& V2
)

 Squared distance between two points. Math/Vector.h  

static T DistSquared2D ( const TVector< T >& V1,
const TVector< T >& V2
)

   Math/Vector.h  

static T DistSquaredXY ( const TVector< T >& V1,
const TVector< T >& V2
)

 Squared distance between two points in the XY plane only. Math/Vector.h  

static T DistXY ( const TVector< T >& V1,
const TVector< T >& V2
)

 Euclidean distance between two points in the XY plane (ignoring Z). Math/Vector.h  

static T DotProduct ( const TVector< T >& A,
const TVector< T >& B
)

 Calculate the dot product of two vectors. Math/Vector.h  

static T EvaluateBezier ( const TVector< T >* ControlPoints,
int32 NumPoints,
TArray< TVector< T > >& OutPoints
)

 Generates a list of sample points on a Bezier curve defined by 2 points. Math/Vector.h  

static void GenerateClusterCenters ( TArray< TVector< T > >& Clusters,
const TArray< TVector< T > >& Points,
int32 NumIterations,
int32 NumConnectionsToBeValid
)

 Given a current set of cluster centers, a set of points, iterate N times to move clusters to be central. Math/Vector.h  

static TVector< T > Max ( const TVector< T >& A,
const TVector< T >& B
)

   Math/Vector.h  

static TVector< T > Max3 ( const TVector< T >& A,
const TVector< T >& B,
const TVector< T >& C
)

   Math/Vector.h  

static TVector< T > Min ( const TVector< T >& A,
const TVector< T >& B
)

 Min, Max, Min3, Max3 like FMath Math/Vector.h  

static TVector< T > Min3 ( const TVector< T >& A,
const TVector< T >& B,
const TVector< T >& C
)

   Math/Vector.h  

static TVector< T > One()

   Math/Vector.h  

static bool Orthogonal ( const TVector< T >& Normal1,
const TVector< T >& Normal2,
T OrthogonalCosineThreshold
)

 See if two normal vectors are nearly orthogonal (perpendicular), meaning the angle between them is close to 90 degrees. Math/Vector.h  

static bool Parallel ( const TVector< T >& Normal1,
const TVector< T >& Normal2,
T ParallelCosineThreshold
)

 See if two normal vectors are nearly parallel, meaning the angle between them is close to 0 degrees. Math/Vector.h  

static T PointPlaneDist ( const TVector< T >& Point,
const TVector< T >& PlaneBase,
const TVector< T >& PlaneNormal
)

 Calculate the signed distance (in the direction of the normal) between a point and a plane. Math/Vector.h  

static TVector< T > PointPlaneProject ( const TVector< T >& Point,
const TVector< T >& A,
const TVector< T >& B,
const TVector< T >& C
)

 Calculate the projection of a point on the plane defined by counter-clockwise (CCW) points A,B,C. Math/Vector.h  

static TVector< T > PointPlaneProject ( const TVector< T >& Point,
const TVector< T >& PlaneBase,
const TVector< T >& PlaneNormal
)

 Calculate the projection of a point on the plane defined by PlaneBase and PlaneNormal. Math/Vector.h  

static TVector< T > PointPlaneProject ( const TVector< T >& Point,
const TPlane< T >& Plane
)

 Calculate the projection of a point on the given plane. Math/Vector.h  

static bool PointsAreNear ( const TVector< T >& Point1,
const TVector< T >& Point2,
T Dist
)

 Compare two points and see if they're within specified distance. Math/Vector.h  

static bool PointsAreSame ( const TVector< T >& P,
const TVector< T >& Q
)

 Compare two points and see if they're the same, using a threshold. Math/Vector.h  

static TVector< T > RadiansToDegrees ( const TVector< T >& RadVector
)

 Converts a vector containing radian values to a vector containing degree values. Math/Vector.h  

static TVector< T > SlerpNormals ( const TVector< T >& NormalA,
const TVector< T >& NormalB,
T Alpha
)

 Interpolate from normalized vector A to normalized vector B along a spherical path. Math/Vector.h  

static TVector< T > SlerpVectorToDirection ( const TVector< T >& V,
const TVector< T >& Direction,
T Alpha
)

 Interpolate from a vector to the direction of another vector along a spherical path. Math/Vector.h  

static T Triple ( const TVector< T >& X,
const TVector< T >& Y,
const TVector< T >& Z
)

 Triple product of three vectors: X dot (Y cross Z). Math/Vector.h  

static TVector< T > UnitX()

   Math/Vector.h  

static TVector< T > UnitY()

   Math/Vector.h  

static TVector< T > UnitZ()

   Math/Vector.h  

static TVector< T > VectorPlaneProject ( const TVector< T >& V,
const TVector< T >& PlaneNormal
)

 Calculate the projection of a vector on the plane defined by PlaneNormal. Math/Vector.h  

static TVector< T > Zero()

   Math/Vector.h  

Operators

Name Remarks Include Path Unreal Specifiers

TVector< T > operator- ( FArg Bias
) const

 Gets the result of subtracting from each component of the vector. Math/Vector.h  

TVector< T > operator- ( const TVector< T >& V
) const

 Gets the result of component-wise subtraction of this by another vector. Math/Vector.h  

TVector< T > operator-()

 Get a negated copy of the vector. Math/Vector.h  

bool operator!= ( const TVector< T >& V
) const

 Check against another vector for inequality. Math/Vector.h  

TVector< T > operator* ( const TVector< T >& V
) const

 Gets the result of component-wise multiplication of this vector by another. Math/Vector.h  

TVector< T > operator* ( FArg Scale
) const

 Gets the result of scaling the vector (multiplying each component by a value). Math/Vector.h  

TVector< T > operator*= ( const TVector< T >& V
)

 Multiplies the vector with another vector, using component-wise multiplication. Math/Vector.h  

TVector< T > operator*= ( FArg Scale
)

 Scales the vector. Math/Vector.h  

TVector< T > operator/ ( const TVector< T >& V
) const

 Gets the result of component-wise division of this vector by another. Math/Vector.h  

TVector< T > operator/ ( FArg Scale
) const

 Gets the result of dividing each component of the vector by a value. Math/Vector.h  

TVector< T > operator/= ( const TVector< T >& V
)

 Divides the vector by another vector, using component-wise division. Math/Vector.h  

TVector< T > operator/= ( FArg Scale
)

 Divides the vector by a number. Math/Vector.h  

T operator[] ( int32 Index
) const

 Gets specific component of the vector. Math/Vector.h  

T & operator[] ( int32 Index
)

 Gets specific component of the vector. Math/Vector.h  

TVector< T > operator^ ( const TVector< T >& V
) const

 Calculate cross product between this and another vector. Math/Vector.h  

T operator| ( const TVector< T >& V
) const

 Calculate the dot product between this and another vector. Math/Vector.h  

TVector< T > operator+ ( FArg Bias
) const

 Gets the result of adding to each component of the vector. Math/Vector.h  

TVector< T > operator+ ( const TVector< T >& V
) const

 Gets the result of component-wise addition of this and another vector. Math/Vector.h  

TVector< T > operator+= ( const TVector< T >& V
)

 Adds another vector to this. Uses component-wise addition. Math/Vector.h  

TVector< T > operator-= ( const TVector< T >& V
)

 Subtracts another vector from this. Uses component-wise subtraction. Math/Vector.h  

bool operator== ( const TVector< T >& V
) const

 Check against another vector for equality. Math/Vector.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page