UE::Geometry::FIndex3i Struct Reference

#include <IndexTypes.h>

Public Member Functions
constexpr	FIndex3i ()=default
constexpr	FIndex3i (int ValA, int ValB, int ValC)
int &	operator[] (int Idx)
const int &	operator[] (int Idx) const
bool	operator== (const FIndex3i &Other) const
bool	operator!= (const FIndex3i &Other) const
int	IndexOf (int Value) const
bool	Contains (int Value) const
FIndex3i	GetOffsetBy (int32 OffsetIndicesBy) const
FIndex3i	GetCycled (int32 WantIndex0Value) const
	operator FIntVector () const
	FIndex3i (const FIntVector &Vec)
void	Serialize (FArchive &Ar)

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

Public Attributes
union {
struct {
int   A
int   B
int   C
}
int   ABC [3] = { IndexConstants::InvalidID, IndexConstants::InvalidID, IndexConstants::InvalidID }
};

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

Detailed Description

3-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.

Implicit casts to/from FIntVector are defined.

Constructor & Destructor Documentation

FIndex3i() [1/3]

constexpr UE::Geometry::FIndex3i::FIndex3i ( )

constexprdefault

FIndex3i() [2/3]

constexpr UE::Geometry::FIndex3i::FIndex3i ( int  ValA, int  ValB, int  ValC  )

inlineconstexpr

FIndex3i() [3/3]

UE::Geometry::FIndex3i::FIndex3i ( const FIntVector &  Vec )

inline

Member Function Documentation

Contains()

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

inline

GetCycled()

FIndex3i UE::Geometry::FIndex3i::GetCycled ( int32  WantIndex0Value ) const

inline

Returns

shifted triplet such that A=WantIndex0Value, and B,C values maintain the same relative ordering

GetOffsetBy()

FIndex3i UE::Geometry::FIndex3i::GetOffsetBy ( int32  OffsetIndicesBy ) const

inline

Returns

offset triplet, with the OffsetIndicesBy value added to each index

IndexOf()

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

inline

Invalid()

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

inlinestaticconstexpr

Max()

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

inlinestaticconstexpr

operator FIntVector()

UE::Geometry::FIndex3i::operator FIntVector ( ) const

inline

operator!=()

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

inline

operator==()

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

inline

operator[]() [1/2]

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

inline

operator[]() [2/2]

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

inline

Serialize()

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

inline

Serialize FIndex3i to an archive

Zero()

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

inlinestaticconstexpr

Friends And Related Symbol Documentation

operator<<

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

friend

Serialization operator for FIndex3i.

Parameters

Ar	Archive to serialize with.
I	Index to serialize.

Returns

Passing down serializing archive.

Member Data Documentation

[union]

union { ... } UE::Geometry::FIndex3i

A

int UE::Geometry::FIndex3i::A

ABC

int UE::Geometry::FIndex3i::ABC[3] = { IndexConstants::InvalidID, IndexConstants::InvalidID, IndexConstants::InvalidID }

B

int UE::Geometry::FIndex3i::B

C

int UE::Geometry::FIndex3i::C

---

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

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