Navigation
API > API/Runtime > API/Runtime/Core
Structure for integer points in 2-d space.
| Name | TIntPoint |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/Math/IntPoint.h |
| Include Path | #include "Math/IntPoint.h" |
| Source | /Engine/Source/Runtime/Core/Public/Math/MathFwd.h |
Syntax
template<typename IntType>
struct TIntPoint
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TIntPoint () |
Default constructor (no initialization). | Math/IntPoint.h | |
TIntPoint
(
IntType InXY |
Create and initialize a new instance with a single int. | Math/IntPoint.h | |
TIntPoint
(
EForceInit |
Create and initialize a new instance to zero. | Math/IntPoint.h | |
| Converts to another int type. Checks that the cast will succeed. | Math/IntPoint.h | ||
| Workaround for clang deprecation warnings for deprecated XY member in implicitly-defined special member functions. | Math/IntPoint.h | ||
| Math/IntPoint.h | |||
TIntPoint
(
IntType InX, |
Create and initialize a new instance with the specified coordinates. | Math/IntPoint.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| IntType | InIntType | Math/IntPoint.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NoneValue | const TIntPoint | An integer point with INDEX_NONE values. | Math/IntPoint.h |
| ZeroValue | const TIntPoint | An integer point with zeroed values. | Math/IntPoint.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| TIntPoint | union UE::Math::TIntPoint | Math/IntPoint.h | ||
| X | IntType | Holds the point's x-coordinate. | Math/IntPoint.h | |
| XY | IntType | Math/IntPoint.h | ||
| Y | IntType | Holds the point's y-coordinate. | Math/IntPoint.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TIntPoint ComponentMax
(
const TIntPoint& Other |
Get the component-wise max of two points. | Math/IntPoint.h | |
TIntPoint ComponentMin
(
const TIntPoint& Other |
Get the component-wise min of two points. | Math/IntPoint.h | |
IntType GetMax () |
Get the larger of the point's two components. | Math/IntPoint.h | |
IntType GetMin () |
Get the smaller of the point's two components. | Math/IntPoint.h | |
bool InitFromString
(
const FString& InSourceString |
Initialize this FIntPoint based on an FString. | Math/IntPoint.h | |
bool Serialize
(
FArchive& Ar |
Serialize the point. | Math/IntPoint.h | |
| Math/IntPoint.h | |||
IntType Size () |
Get the distance of this point from (0,0). | Math/IntPoint.h | |
IntType SizeSquared () |
Get the squared distance of this point from (0,0). | Math/IntPoint.h | |
FString ToString () |
Math/IntPoint.h | ||
FString ToString () |
Math/IntPoint.h | ||
FString ToString () |
Math/IntPoint.h | ||
FString ToString () |
Get a textual representation of this point. | Math/IntPoint.h | |
FString ToString () |
Math/IntPoint.h | ||
FString ToString () |
Math/IntPoint.h | ||
FString ToString () |
Math/IntPoint.h | ||
FString ToString () |
Math/IntPoint.h | ||
FString ToString () |
Math/IntPoint.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TIntPoint DivideAndRoundDown
(
TIntPoint lhs, |
Math/IntPoint.h | ||
static TIntPoint DivideAndRoundDown
(
TIntPoint lhs, |
Divide an int point and round down the result. | Math/IntPoint.h | |
static TIntPoint DivideAndRoundUp
(
TIntPoint lhs, |
Math/IntPoint.h | ||
static TIntPoint DivideAndRoundUp
(
TIntPoint lhs, |
Divide an int point and round up the result. | Math/IntPoint.h | |
static int32 Num() |
Get number of components point has. | Math/IntPoint.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Get the result of subtraction from this point. | Math/IntPoint.h | ||
bool operator!=
(
const TIntPoint& Other |
Compare two points for inequality. | Math/IntPoint.h | |
IntType & operator()
(
int32 PointIndex |
Get specific component of a point. | Math/IntPoint.h | |
const IntType & operator()
(
int32 PointIndex |
Get specific component of a point. | Math/IntPoint.h | |
| Get the result of multiplication on this point. | Math/IntPoint.h | ||
| Get the result of scaling on this point. | Math/IntPoint.h | ||
TIntPoint & operator*=
(
const TIntPoint& Other |
Multiply another point component-wise from this point. | Math/IntPoint.h | |
TIntPoint & operator*=
(
IntType Scale |
Scale this point. | Math/IntPoint.h | |
| Get the result of division on this point. | Math/IntPoint.h | ||
| Get the result of division on this point. | Math/IntPoint.h | ||
TIntPoint & operator/=
(
IntType Divisor |
Divide this point by a scalar. | Math/IntPoint.h | |
TIntPoint & operator/=
(
const TIntPoint& Other |
Divide this point component-wise by another point. | Math/IntPoint.h | |
IntType & operator[]
(
IntType Index |
Get specific component of the point. | Math/IntPoint.h | |
IntType operator[]
(
IntType Index |
Get specific component of the point. | Math/IntPoint.h | |
| Get the result of addition on this point. | Math/IntPoint.h | ||
| Add another point component-wise to this point. | Math/IntPoint.h | ||
| Math/IntPoint.h | |||
| Math/IntPoint.h | |||
| Subtract another point component-wise from this point. | Math/IntPoint.h | ||
bool operator==
(
const TIntPoint& Other |
Compare two points for equality. | Math/IntPoint.h |