UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Namespaces | Macros | Typedefs | Functions
SlateVector2.h File Reference
#include "CoreTypes.h"
#include "Math/Vector2D.h"
#include "Math/IntPoint.h"
#include "Math/UnrealMathUtility.h"
#include "Misc/Optional.h"
#include "SlateVector2.generated.h"

Go to the source code of this file.

Classes

struct  UE::Slate::FDeprecateSlateVectorPtrVariant
 
struct  TStructOpsTypeTraits< FDeprecateSlateVector2D >
 
struct  UE::Slate::FDeprecateVector2DParameter
 
struct  UE::Slate::FDeprecateOptionalVector2DParameter
 

Namespaces

namespace  UE
 
namespace  UE::Slate
 

Macros

#define UE_ENABLE_SLATE_VECTOR_DEPRECATION_MECHANISMS   1
 
#define UE_INCLUDETOOL_IGNORE_INCONSISTENT_STATE
 
#define UE_REPORT_SLATE_VECTOR_DEPRECATION   0
 
#define UE_REPORT_SLATE_VECTOR_DEPRECATION_VERSION   all
 
#define UE_SLATE_VECTOR_DEPRECATED(Text)
 
#define UE_SLATE_VECTOR_DEPRECATED_DEFAULT()
 
#define UE_SLATE_DEPRECATED_VECTOR_VIRTUAL_FUNCTION
 
#define UE_SLATE_BINARY_VECTOR_OPERATORS_A(Type, ...)
 
#define UE_SLATE_BINARY_ASSIGNMENT_VECTOR_OPERATORS_A(Type, ...)
 
#define UE_SLATE_BINARY_VECTOR_OPERATORS_B(Type, ...)
 
#define UE_SLATE_BINARY_ASSIGNMENT_VECTOR_OPERATORS_B(Type, ...)
 

Typedefs

using UE::Slate::FDeprecateVector2DResult = FDeprecateSlateVector2D
 

Functions

const FVector2f & UE::Slate::CastToVector2f (const FVector2f &InValue)
 
FVector2f UE::Slate::CastToVector2f (const FVector2d &InValue)
 
FVector2f UE::Slate::CastToVector2f (const FIntPoint &InValue)
 
const FVector2f & UE::Slate::CastToVector2f (const FDeprecateSlateVector2D &InValue)
 
const FVector2f & UE::Slate::CastToVector2f (const FDeprecateVector2DParameter &InValue)
 
UE::Slate::FDeprecateVector2DResult TransformPoint (float Transform, const UE::Slate::FDeprecateVector2DResult &Point)
 
UE::Slate::FDeprecateVector2DResult TransformVector (float Transform, const UE::Slate::FDeprecateVector2DResult &Vector)
 
template<typename TransformType >
UE::Slate::FDeprecateVector2DResult TransformPoint (const TransformType &Transform, const UE::Slate::FDeprecateVector2DResult &Point)
 
template<typename TransformType >
UE::Slate::FDeprecateVector2DResult TransformVector (const TransformType &Transform, const UE::Slate::FDeprecateVector2DResult &Point)
 

Macro Definition Documentation

◆ UE_ENABLE_SLATE_VECTOR_DEPRECATION_MECHANISMS

#define UE_ENABLE_SLATE_VECTOR_DEPRECATION_MECHANISMS   1

When disabled, all deprecation mechanisms will be disabled, and public slate APIs will only compile with single-precision

◆ UE_INCLUDETOOL_IGNORE_INCONSISTENT_STATE

#define UE_INCLUDETOOL_IGNORE_INCONSISTENT_STATE

The subsequent deprecation macros can be enabled or disabled per-module Tell the IncludeTool static analyzer to ignore that divergence

◆ UE_REPORT_SLATE_VECTOR_DEPRECATION

#define UE_REPORT_SLATE_VECTOR_DEPRECATION   0

When a module enables UE_REPORT_SLATE_VECTOR_DEPRECATION through PrivateDefines.Add("UE_REPORT_SLATE_VECTOR_DEPRECATION=1"), deprecation mechanisms will be enabled on that module for Slate double/single vector APIs

◆ UE_REPORT_SLATE_VECTOR_DEPRECATION_VERSION

#define UE_REPORT_SLATE_VECTOR_DEPRECATION_VERSION   all

◆ UE_SLATE_BINARY_ASSIGNMENT_VECTOR_OPERATORS_A

#define UE_SLATE_BINARY_ASSIGNMENT_VECTOR_OPERATORS_A (   Type,
  ... 
)
Value:
__VA_ARGS__\
friend Type& operator+=(Type& A, const FDeprecateSlateVector2D& B)\
{\
A = Type(FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) + UE::Slate::CastToVector2f(B)));\
return A;\
}\
__VA_ARGS__\
friend Type& operator-=(Type& A, const FDeprecateSlateVector2D& B)\
{\
A = Type(FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) - UE::Slate::CastToVector2f(B)));\
return A;\
}\
__VA_ARGS__\
friend Type& operator*=(Type& A, const FDeprecateSlateVector2D& B)\
{\
A = Type(FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) * UE::Slate::CastToVector2f(B)));\
return A;\
}\
__VA_ARGS__\
friend Type& operator/=(Type& A, const FDeprecateSlateVector2D& B)\
{\
A = Type(FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) / UE::Slate::CastToVector2f(B)));\
return A;\
}
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
operator*=
FFrameTime & operator*=(FFrameTime &InTime, const FMovieSceneSequenceTransform &RHS)
Definition MovieSceneSequenceTransform.h:1072
operator+=
FStringBuilderBase & operator+=(FStringBuilderBase &Builder, ANSICHAR Char)
Definition StringBuilder.h:582
EPawnActionMoveMode::Type
Type
Definition PawnAction_Move.h:11
UE::Slate::CastToVector2f
const FVector2f & CastToVector2f(const FVector2f &InValue)
Definition SlateVector2.h:591

◆ UE_SLATE_BINARY_ASSIGNMENT_VECTOR_OPERATORS_B

#define UE_SLATE_BINARY_ASSIGNMENT_VECTOR_OPERATORS_B (   Type,
  ... 
)
Value:
__VA_ARGS__\
friend FDeprecateSlateVector2D& operator+=(FDeprecateSlateVector2D& A, const Type& B)\
{\
static_cast<FVector2f&>(A) += UE::Slate::CastToVector2f(B);\
return A;\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D& operator-=(FDeprecateSlateVector2D& A, const Type& B)\
{\
static_cast<FVector2f&>(A) -= UE::Slate::CastToVector2f(B);\
return A;\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D& operator*=(FDeprecateSlateVector2D& A, const Type& B)\
{\
static_cast<FVector2f&>(A) *= UE::Slate::CastToVector2f(B);\
return A;\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D& operator/=(FDeprecateSlateVector2D& A, const Type& B)\
{\
static_cast<FVector2f&>(A) /= UE::Slate::CastToVector2f(B);\
return A;\
}

◆ UE_SLATE_BINARY_VECTOR_OPERATORS_A

#define UE_SLATE_BINARY_VECTOR_OPERATORS_A (   Type,
  ... 
)
Value:
__VA_ARGS__\
friend FDeprecateSlateVector2D operator+(const Type& A, const FDeprecateSlateVector2D& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) + UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D operator-(const Type& A, const FDeprecateSlateVector2D& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) - UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D operator*(const Type& A, const FDeprecateSlateVector2D& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) * UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D operator/(const Type& A, const FDeprecateSlateVector2D& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) / UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend bool operator==(const Type& A, const FDeprecateSlateVector2D& B)\
{\
return UE::Slate::CastToVector2f(A) == UE::Slate::CastToVector2f(B);\
}\
__VA_ARGS__\
friend bool operator!=(const Type& A, const FDeprecateSlateVector2D& B)\
{\
return UE::Slate::CastToVector2f(A) != UE::Slate::CastToVector2f(B);\
}
operator*
UE_FORCEINLINE_HINT FLinearColor operator*(float Scalar, const FLinearColor &Color)
Definition Color.h:473
operator+
constexpr EIOSEventType operator+(EIOSEventType type, int Index)
Definition IOSInputInterface.cpp:138
operator!=
UE_FORCEINLINE_HINT bool operator!=(const FIndexedPointer &Other) const
Definition LockFreeList.h:76
operator/
FScreenTransform operator/(const FScreenTransform &AToB, const FVector2f &InvertedScale)
Definition ScreenPass.inl:280
operator-
FScreenTransform operator-(const FScreenTransform &AToB, const FVector2f &Bias)
Definition ScreenPass.inl:264
UE::AssetRegistry::Private::operator==
bool operator==(const FCachedAssetKey &A, const FCachedAssetKey &B)
Definition AssetDataMap.h:501

◆ UE_SLATE_BINARY_VECTOR_OPERATORS_B

#define UE_SLATE_BINARY_VECTOR_OPERATORS_B (   Type,
  ... 
)
Value:
__VA_ARGS__\
friend FDeprecateSlateVector2D operator+(const FDeprecateSlateVector2D& A, const Type& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) + UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D operator-(const FDeprecateSlateVector2D& A, const Type& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) - UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D operator*(const FDeprecateSlateVector2D& A, const Type& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) * UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend FDeprecateSlateVector2D operator/(const FDeprecateSlateVector2D& A, const Type& B)\
{\
return FDeprecateSlateVector2D(UE::Slate::CastToVector2f(A) / UE::Slate::CastToVector2f(B));\
}\
__VA_ARGS__\
friend bool operator==(const FDeprecateSlateVector2D& A, const Type& B)\
{\
return UE::Slate::CastToVector2f(A) == UE::Slate::CastToVector2f(B);\
}\
__VA_ARGS__\
friend bool operator!=(const FDeprecateSlateVector2D& A, const Type& B)\
{\
return UE::Slate::CastToVector2f(A) != UE::Slate::CastToVector2f(B);\
}

◆ UE_SLATE_DEPRECATED_VECTOR_VIRTUAL_FUNCTION

#define UE_SLATE_DEPRECATED_VECTOR_VIRTUAL_FUNCTION

◆ UE_SLATE_VECTOR_DEPRECATED

#define UE_SLATE_VECTOR_DEPRECATED (   Text)

◆ UE_SLATE_VECTOR_DEPRECATED_DEFAULT

#define UE_SLATE_VECTOR_DEPRECATED_DEFAULT ( )

Function Documentation

◆ TransformPoint() [1/2]

template<typename TransformType >
UE::Slate::FDeprecateVector2DResult TransformPoint ( const TransformType &  Transform,
const UE::Slate::FDeprecateVector2DResult &  Point 
)
inline

◆ TransformPoint() [2/2]

UE::Slate::FDeprecateVector2DResult TransformPoint ( float  Transform,
const UE::Slate::FDeprecateVector2DResult &  Point 
)
inline

◆ TransformVector() [1/2]

template<typename TransformType >
UE::Slate::FDeprecateVector2DResult TransformVector ( const TransformType &  Transform,
const UE::Slate::FDeprecateVector2DResult &  Point 
)
inline

◆ TransformVector() [2/2]

UE::Slate::FDeprecateVector2DResult TransformVector ( float  Transform,
const UE::Slate::FDeprecateVector2DResult &  Vector 
)
inline