Language:
Discover
By Skill Level
By Category

# FIntPoint

Syntax

struct FIntPoint

Remarks

Structure for integer points in 2-d space.

Screen coordinates. The full C++ class is located here: Engine\Source\Runtime\Core\Public\Math\IntPoint.h

Variables

Name Description

X

Holds the point's x-coordinate.

Y

Holds the point's y-coordinate.

Constructors

Name Description

FIntPoint()

Default constructor (no initialization).

FIntPoint

Create and initialize a new instance to zero.

FIntPoint

(
int32 InX,
int32 InY
)

Create and initialize a new instance with the specified coordinates.

Functions

Name Description

ComponentMax

(
const FIntPoint & Other
)

Get the component-wise max of two points.

ComponentMin

(
const FIntPoint & Other
)

Get the component-wise min of two points.

DivideAndRoundDown

(
FIntPoint lhs,
int32 Divisor
)

Divide an int point and round down the result.

A new divided int point.

DivideAndRoundUp

(
FIntPoint lhs,
int32 Divisor
)

Divide an int point and round up the result.

A new divided int point.

DivideAndRoundUp

(
FIntPoint lhs,
FIntPoint Divisor
)

GetMax()

Get the larger of the point's two components.

The maximum component of the point.

GetMin()

Get the smaller of the point's two components.

The minimum component of the point.

Num()

Get number of components point has.

number of components point has.

bool

Serialize

(
FArchive & Ar
)

Serialize the point.

true on success, false otherwise.

Size()

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

The distance of this point from (0,0).

SizeSquared()

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

ToString()

Get a textual representation of this point.

A string describing the point.

Operators

Name Description

operator-

(
const FIntPoint & Other
)

Get the result of subtraction from this point.

A new subtracted int point.

bool

operator!=

(
const FIntPoint & Other
)

Compare two points for inequality.

true if the points are not equal, false otherwise.

operator()

(
int32 PointIndex
)

Get specific component of a point.

reference to component.

const int32 ...

operator()

(
int32 PointIndex
)

Get specific component of a point.

const reference to component.

operator*

(
int32 Scale
)

Get the result of scaling on this point.

A new scaled int point.

operator*=

(
int32 Scale
)

Scale this point.

Reference to this point after multiplication.

operator/

(
const FIntPoint & Other
)

Get the result of division on this point.

A new subtracted int point.

operator/

(
int32 Divisor
)

Get the result of division on this point.

A new divided int point.

operator/=

(
int32 Divisor
)

Divide this point by a scalar.

Reference to this point after division.

operator/=

(
const FIntPoint & Other
)

Divide this point component-wise by another point.

Reference to this point after division.

operator[]

(
int32 Index
)

Get specific component of the point.

copy of component value.

operator[]

(
int32 Index
)

Get specific component of the point.

reference to component.

operator+

(
const FIntPoint & Other
)

Get the result of addition on this point.

A new combined int point.

operator+=

(
const FIntPoint & Other
)

Add another point component-wise to this point.

Reference to this point after addition.

operator=

(
const FIntPoint & Other
)

Assign another point to this one.

Reference to this point after assignment.

operator-=

(
const FIntPoint & Other
)

Subtract another point component-wise from this point.

bool

operator==

(
const FIntPoint & Other
)

Compare two points for equality.

true if the points are equal, false otherwise.

Constants

Name

Description

NoneValue

An integer point with INDEX_NONE values.

ZeroValue

An integer point with zeroed values.

References