UE::Geometry::FIndex2i Struct Reference

#include <IndexTypes.h>

Public Member Functions
constexpr	FIndex2i ()=default
constexpr	FIndex2i (int ValA, int ValB)
int &	operator[] (int Idx)
const int &	operator[] (int Idx) const
bool	operator== (const FIndex2i &Other) const
bool	operator!= (const FIndex2i &Other) const
int	IndexOf (int Value) const
bool	Contains (int Value) const
int	OtherElement (int Value) const
void	Swap ()
void	Sort ()
void	Serialize (FArchive &Ar)

Static Public Member Functions
static constexpr FIndex2i	Zero ()
static constexpr FIndex2i	Max ()
static constexpr FIndex2i	Invalid ()

Public Attributes
union {
struct {
int   A
int   B
}
int   AB [2] = { IndexConstants::InvalidID, IndexConstants::InvalidID }
};

Friends
FArchive &	operator<< (FArchive &Ar, FIndex2i &I)

Detailed Description

2-index tuple. Ported from g3Sharp library, with the intention of maintaining compatibility with existing g3Sharp code. Has an API similar to WildMagic, GTEngine, Eigen, etc.

Constructor & Destructor Documentation

FIndex2i() [1/2]

constexpr UE::Geometry::FIndex2i::FIndex2i ( )

constexprdefault

FIndex2i() [2/2]

constexpr UE::Geometry::FIndex2i::FIndex2i ( int  ValA, int  ValB  )

inlineconstexpr

Member Function Documentation

Contains()

bool UE::Geometry::FIndex2i::Contains ( int  Value ) const

inline

IndexOf()

int UE::Geometry::FIndex2i::IndexOf ( int  Value ) const

inline

Invalid()

static constexpr FIndex2i UE::Geometry::FIndex2i::Invalid ( )

inlinestaticconstexpr

Max()

static constexpr FIndex2i UE::Geometry::FIndex2i::Max ( )

inlinestaticconstexpr

operator!=()

bool UE::Geometry::FIndex2i::operator!= ( const FIndex2i &  Other ) const

inline

operator==()

bool UE::Geometry::FIndex2i::operator== ( const FIndex2i &  Other ) const

inline

operator[]() [1/2]

int & UE::Geometry::FIndex2i::operator[] ( int  Idx )

inline

operator[]() [2/2]

const int & UE::Geometry::FIndex2i::operator[] ( int  Idx ) const

inline

OtherElement()

int UE::Geometry::FIndex2i::OtherElement ( int  Value ) const

inline

Returns

whichever of A or B is not Value, or IndexConstants::InvalidID if neither is Value

Serialize()

void UE::Geometry::FIndex2i::Serialize ( FArchive &  Ar )

inline

Serialize FIndex2i to an archive.

Sort()

void UE::Geometry::FIndex2i::Sort ( )

inline

Swap()

void UE::Geometry::FIndex2i::Swap ( )

inline

Zero()

static constexpr FIndex2i UE::Geometry::FIndex2i::Zero ( )

inlinestaticconstexpr

Friends And Related Symbol Documentation

operator<<

FArchive & operator<< ( FArchive &  Ar, FIndex2i &  I  )

friend

Serialization operator for FIndex2i.

Parameters

Ar	Archive to serialize with.
I	Index to serialize.

Returns

Passing down serializing archive.

Member Data Documentation

[union]

union { ... } UE::Geometry::FIndex2i

A

int UE::Geometry::FIndex2i::A

AB

int UE::Geometry::FIndex2i::AB[2] = { IndexConstants::InvalidID, IndexConstants::InvalidID }

B

int UE::Geometry::FIndex2i::B

---

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

• Engine/Source/Runtime/GeometryCore/Public/IndexTypes.h