UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::TVector< FRealSingle, 2 > Class Reference

#include <Vector.h>

+ Inheritance diagram for Chaos::TVector< FRealSingle, 2 >:

Public Types

using FElement = decltype(FVector2f::X)
 
- Public Types inherited from UE::Math::TVector2< float >
using FReal = float
 

Public Member Functions

 TVector ()=default
 
 TVector (const FRealSingle x)
 
 TVector (const FRealSingle x, const FRealSingle y)
 
 TVector (const FVector2f &vec)
 
template<typename OtherT >
 TVector (const TVector< OtherT, 2 > &InVector)
 
FRealSingle Product () const
 
FRealSingle Max () const
 
FRealSingle Min () const
 
template<class T2 >
TVector< FRealSingle, 2 > operator/ (const TVector< T2, 2 > &Other) const
 
TVector< FRealSingle, 2 > operator/ (const FRealSingle Other) const
 
TVector< FRealSingle, 2 > operator* (const FRealSingle Other) const
 
TVector< FRealSingle, 2 > operator* (const TVector< FRealSingle, 2 > &Other) const
 
- Public Member Functions inherited from UE::Math::TVector2< float >
 TVector2 ()=default
 
UE_FORCEINLINE_HINT TVector2 (float InX, float InY)
 
UE_FORCEINLINE_HINT TVector2 (float InF)
 
UE_FORCEINLINE_HINT TVector2 (TIntPoint< IntType > InPos)
 
 TVector2 (TIntVector2< IntType > V)
 
UE_FORCEINLINE_HINT TVector2 (EForceInit)
 
UE_FORCEINLINE_HINT TVector2 (ENoInit)
 
 TVector2 (const TVector< float > &V)
 
 TVector2 (const TVector4< float > &V)
 
 TVector2 (const TVector2< FArg > &From)
 
 TVector2 (TIntPoint< IntType > InPos)
 
UE_FORCEINLINE_HINT TVector2< floatoperator+ (const TVector2< float > &V) const
 
UE_FORCEINLINE_HINT TVector2< floatoperator+ (float A) const
 
UE_FORCEINLINE_HINT TVector2< floatoperator- (const TVector2< float > &V) const
 
UE_FORCEINLINE_HINT TVector2< floatoperator- (float A) const
 
UE_FORCEINLINE_HINT TVector2< floatoperator- () const
 
UE_FORCEINLINE_HINT TVector2< floatoperator* (float Scale) const
 
UE_FORCEINLINE_HINT TVector2< floatoperator* (const TVector2< float > &V) const
 
TVector2< floatoperator/ (float Scale) const
 
UE_FORCEINLINE_HINT TVector2< floatoperator/ (const TVector2< float > &V) const
 
UE_FORCEINLINE_HINT float operator| (const TVector2< float > &V) const
 
UE_FORCEINLINE_HINT float operator^ (const TVector2< float > &V) const
 
bool operator== (const TVector2< float > &V) const
 
bool operator!= (const TVector2< float > &V) const
 
bool ComponentwiseAllLessThan (const TVector2< float > &Other) const
 
bool ComponentwiseAllGreaterThan (const TVector2< float > &Other) const
 
bool ComponentwiseAllLessOrEqual (const TVector2< float > &Other) const
 
bool ComponentwiseAllGreaterOrEqual (const TVector2< float > &Other) const
 
TVector2< floatoperator+= (const TVector2< float > &V)
 
TVector2< floatoperator-= (const TVector2< float > &V)
 
TVector2< floatoperator*= (float Scale)
 
TVector2< floatoperator*= (const TVector2< float > &V)
 
TVector2< floatoperator/= (float V)
 
TVector2< floatoperator/= (const TVector2< float > &V)
 
floatoperator[] (int32 Index)
 
float operator[] (int32 Index) const
 
floatComponent (int32 Index)
 
float Component (int32 Index) const
 
bool IsValidIndex (int32 Index) const
 
bool Equals (const TVector2< float > &V, float Tolerance=UE_KINDA_SMALL_NUMBER) const
 
void Set (float InX, float InY)
 
float GetMax () const
 
float GetAbsMax () const
 
float GetMin () const
 
TVector2< floatComponentMin (const TVector2< float > &Other) const
 
TVector2< floatComponentMax (const TVector2< float > &Other) const
 
float Size () const
 
UE_FORCEINLINE_HINT float Length () const
 
float SizeSquared () const
 
UE_FORCEINLINE_HINT float SquaredLength () const
 
float Dot (const TVector2< float > &V2) const
 
TVector2< floatGetRotated (float AngleDeg) const
 
TVector2< floatGetSafeNormal (float Tolerance=UE_SMALL_NUMBER) const
 
bool Normalize (float Tolerance=UE_SMALL_NUMBER)
 
bool IsNearlyZero (float Tolerance=UE_KINDA_SMALL_NUMBER) const
 
void ToDirectionAndLength (TVector2< float > &OutDir, float &OutLength) const
 
void ToDirectionAndLength (TVector2< float > &OutDir, FArg &OutLength) const
 
bool IsZero () const
 
FIntPoint IntPoint () const
 
TVector2< floatRoundToVector () const
 
TVector2< floatClampAxes (float MinAxisVal, float MaxAxisVal) const
 
TVector2< floatGetClampedToSize (float Min, float Max) const
 
TVector2< floatGetClampedToMaxSize (float MaxSize) const
 
TVector2< floatGetSignVector () const
 
UE_FORCEINLINE_HINT TVector2< floatGetAbs () const
 
FString ToString () const
 
bool InitFromString (const FString &InSourceString)
 
bool Serialize (FArchive &Ar)
 
bool Serialize (FStructuredArchive::FSlot Slot)
 
bool SerializeFromMismatchedTag (FName StructTag, FArchive &Ar)
 
UE_FORCEINLINE_HINT void DiagnosticCheckNaN ()
 
bool ContainsNaN () const
 
bool NetSerialize (FArchive &Ar, class UPackageMap *Map, bool &bOutSuccess)
 
TVector< floatSphericalToUnitCartesian () const
 

Static Public Member Functions

static TVector< FRealSingle, 2 > AxisVector (const int32 Axis)
 
static TVector< FRealSingle, 2 > Max (const TVector< FRealSingle, 2 > &V1, const TVector< FRealSingle, 2 > &V2)
 
static Pair< FRealSingle, int32MaxAndAxis (const TVector< FRealSingle, 2 > &V1, const TVector< FRealSingle, 2 > &V2)
 
- Static Public Member Functions inherited from UE::Math::TVector2< float >
static TVector2< floatZero ()
 
static TVector2< floatOne ()
 
static TVector2< floatUnitX ()
 
static TVector2< floatUnitY ()
 
static UE_FORCEINLINE_HINT float DotProduct (const TVector2< float > &A, const TVector2< float > &B)
 
static UE_FORCEINLINE_HINT float DistSquared (const TVector2< float > &V1, const TVector2< float > &V2)
 
static UE_FORCEINLINE_HINT float Distance (const TVector2< float > &V1, const TVector2< float > &V2)
 
static UE_FORCEINLINE_HINT float CrossProduct (const TVector2< float > &A, const TVector2< float > &B)
 
static UE_FORCEINLINE_HINT TVector2< floatMax (const TVector2< float > &A, const TVector2< float > &B)
 
static UE_FORCEINLINE_HINT TVector2< floatMin (const TVector2< float > &A, const TVector2< float > &B)
 
static UE_FORCEINLINE_HINT TVector2< floatClamp (const TVector2< float > &V, const TVector2< float > &MinValue, const TVector2< float > &MaxValue)
 

Additional Inherited Members

- Public Attributes inherited from UE::Math::TVector2< float >
float X
 
float Y
 
float XY [2]
 
union { 
 
   struct { 
 
      T   X 
 
      T   Y 
 
   }  
 
   T   XY [2] 
 
};  
 
- Static Public Attributes inherited from UE::Math::TVector2< float >
static constexpr int32 NumComponents
 
static CORE_API const TVector2< floatZeroVector
 
static CORE_API const TVector2< floatUnitVector
 
static CORE_API const TVector2< floatUnit45Deg
 

Member Typedef Documentation

◆ FElement

using Chaos::TVector< FRealSingle, 2 >::FElement = decltype(FVector2f::X)

Constructor & Destructor Documentation

◆ TVector() [1/5]

Chaos::TVector< FRealSingle, 2 >::TVector ( )
default

◆ TVector() [2/5]

Chaos::TVector< FRealSingle, 2 >::TVector ( const FRealSingle  x)
inline

◆ TVector() [3/5]

Chaos::TVector< FRealSingle, 2 >::TVector ( const FRealSingle  x,
const FRealSingle  y 
)
inline

◆ TVector() [4/5]

Chaos::TVector< FRealSingle, 2 >::TVector ( const FVector2f vec)
inline

◆ TVector() [5/5]

template<typename OtherT >
Chaos::TVector< FRealSingle, 2 >::TVector ( const TVector< OtherT, 2 > &  InVector)
inline

Member Function Documentation

◆ AxisVector()

static TVector< FRealSingle, 2 > Chaos::TVector< FRealSingle, 2 >::AxisVector ( const int32  Axis)
inlinestatic

◆ Max() [1/2]

FRealSingle Chaos::TVector< FRealSingle, 2 >::Max ( ) const
inline

◆ Max() [2/2]

static TVector< FRealSingle, 2 > Chaos::TVector< FRealSingle, 2 >::Max ( const TVector< FRealSingle, 2 > &  V1,
const TVector< FRealSingle, 2 > &  V2 
)
inlinestatic

◆ MaxAndAxis()

static Pair< FRealSingle, int32 > Chaos::TVector< FRealSingle, 2 >::MaxAndAxis ( const TVector< FRealSingle, 2 > &  V1,
const TVector< FRealSingle, 2 > &  V2 
)
inlinestatic

◆ Min()

FRealSingle Chaos::TVector< FRealSingle, 2 >::Min ( ) const
inline

◆ operator*() [1/2]

TVector< FRealSingle, 2 > Chaos::TVector< FRealSingle, 2 >::operator* ( const FRealSingle  Other) const
inline

◆ operator*() [2/2]

TVector< FRealSingle, 2 > Chaos::TVector< FRealSingle, 2 >::operator* ( const TVector< FRealSingle, 2 > &  Other) const
inline

◆ operator/() [1/2]

TVector< FRealSingle, 2 > Chaos::TVector< FRealSingle, 2 >::operator/ ( const FRealSingle  Other) const
inline

◆ operator/() [2/2]

template<class T2 >
TVector< FRealSingle, 2 > Chaos::TVector< FRealSingle, 2 >::operator/ ( const TVector< T2, 2 > &  Other) const
inline

◆ Product()

FRealSingle Chaos::TVector< FRealSingle, 2 >::Product ( ) const
inline

The documentation for this class was generated from the following file: