FIntPoint

Structure for integer points in 2-d space.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Math/IntPoint.h

Include

#include "Math/IntPoint.h"

Syntax

struct FIntPoint

Remarks

Structure for integer points in 2-d space.

Variables

Name Description

Public variable

int32

 

X

Holds the point's x-coordinate.

Public variable

int32

 

Y

Holds the point's y-coordinate.

Constructors

Name Description

Public function

FIntPoint()

Default constructor (no initialization).

Public function

FIntPoint

(
    int32 InXY
)

Create and initialize a new instance with a single int.

Public function

FIntPoint

(
    EForceInit
)

Create and initialize a new instance to zero.

Public function

FIntPoint

(
    int32 InX,
    int32 InY
)

Create and initialize a new instance with the specified coordinates.

Functions

Name Description

Public function Const

FIntPoint

 

ComponentMax

(
    const FIntPoint& Other
)

Get the component-wise max of two points.

Public function Const

FIntPoint

 

ComponentMin

(
    const FIntPoint& Other
)

Get the component-wise min of two points.

Public function Static

FIntPoint

 

DivideAndRoundDown

(
    FIntPoint lhs,
    int32 Divisor
)

Divide an int point and round down the result.

Public function Static

FIntPoint

 

DivideAndRoundUp

(
    FIntPoint lhs,
    int32 Divisor
)

Divide an int point and round up the result.

Public function Static

FIntPoint

 

DivideAndRoundUp

(
    FIntPoint lhs,
    FIntPoint Divisor
)

Divide an int point and round up the result.

Public function Const

int32

 

GetMax()

Get the larger of the point's two components.

Public function Const

int32

 

GetMin()

Get the smaller of the point's two components.

Public function Static

int32

 

Num()

Get number of components point has.

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Serialize the point.

Public function

bool

 

Serialize

(
    FStructuredArchive::FSlot Slot
)

Serialize the point.

Public function Const

int32

 

Size()

Get the distance of this point from (0,0).

Public function Const

int32

 

SizeSquared()

Get the squared distance of this point from (0,0).

Public function Const

FString

 

ToString()

Get a textual representation of this point.

Operators

Name Description

Public function Const

FIntPoint

 

operator-

(
    const FIntPoint& Other
)

Get the result of subtraction from this point.

Public function Const

bool

 

operator!=

(
    const FIntPoint& Other
)

Compare two points for inequality.

Public function Const

const int32 ...

 

operator()

(
    int32 PointIndex
)

Get specific component of a point.

Public function

int32 &

 

operator()

(
    int32 PointIndex
)

Get specific component of a point.

Public function Const

FIntPoint

 

operator*

(
    int32 Scale
)

Get the result of scaling on this point.

Public function Const

FIntPoint

 

operator*

(
    const FIntPoint& Other
)

Get the result of multiplication on this point.

Public function

FIntPoint &

 

operator*=

(
    int32 Scale
)

Scale this point.

Public function

FIntPoint &

 

operator*=

(
    const FIntPoint& Other
)

Multiply another point component-wise from this point.

Public function Const

FIntPoint

 

operator/

(
    int32 Divisor
)

Get the result of division on this point.

Public function Const

FIntPoint

 

operator/

(
    const FIntPoint& Other
)

Get the result of division on this point.

Public function

FIntPoint &

 

operator/=

(
    int32 Divisor
)

Divide this point by a scalar.

Public function

FIntPoint &

 

operator/=

(
    const FIntPoint& Other
)

Divide this point component-wise by another point.

Public function

int32 &

 

operator[]

(
    int32 Index
)

Get specific component of the point.

Public function Const

int32

 

operator[]

(
    int32 Index
)

Get specific component of the point.

Public function Const

FIntPoint

 

operator+

(
    const FIntPoint& Other
)

Get the result of addition on this point.

Public function

FIntPoint &

 

operator+=

(
    const FIntPoint& Other
)

Add another point component-wise to this point.

Public function

FIntPoint &

 

operator=

(
    const FIntPoint& Other
)

Assign another point to this one.

Public function

FIntPoint &

 

operator-=

(
    const FIntPoint& Other
)

Subtract another point component-wise from this point.

Public function Const

bool

 

operator==

(
    const FIntPoint& Other
)

Compare two points for equality.

Constants

Name

Description

NoneValue

An integer point with INDEX_NONE values.

ZeroValue

An integer point with zeroed values.