Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
UE::Math::TIntVector3< InIntType > Struct Template Reference

#include <IntVector.h>

+ Collaboration diagram for UE::Math::TIntVector3< InIntType >:

Public Types

using IntType = InIntType
 

Public Member Functions

 TIntVector3 ()=default
 
 TIntVector3 (IntType InX, IntType InY, IntType InZ)
 
 TIntVector3 (IntType InValue)
 
 TIntVector3 (FVector InVector)
 
 TIntVector3 (EForceInit)
 
template<typename OtherIntType >
 TIntVector3 (TIntVector3< OtherIntType > Other)
 
const IntType & operator() (int32 ComponentIndex) const
 
IntType & operator() (int32 ComponentIndex)
 
const IntType & operator[] (int32 ComponentIndex) const
 
IntType & operator[] (int32 ComponentIndex)
 
bool operator== (const TIntVector3 &Other) const
 
bool operator!= (const TIntVector3 &Other) const
 
TIntVector3 & operator*= (const TIntVector3 &Other)
 
TIntVector3 & operator*= (IntType Scale)
 
TIntVector3 & operator/= (IntType Divisor)
 
TIntVector3 & operator%= (IntType Divisor)
 
TIntVector3 & operator+= (const TIntVector3 &Other)
 
TIntVector3 & operator-= (const TIntVector3 &Other)
 
TIntVector3 operator* (const TIntVector3 &Other) const
 
TIntVector3 operator* (IntType Scale) const
 
TIntVector3 operator/ (IntType Divisor) const
 
TIntVector3 operator% (IntType Divisor) const
 
TIntVector3 operator+ (const TIntVector3 &Other) const
 
TIntVector3 operator- (const TIntVector3 &Other) const
 
TIntVector3 operator>> (IntType Shift) const
 
TIntVector3 operator<< (IntType Shift) const
 
TIntVector3 operator& (IntType Value) const
 
TIntVector3 operator| (IntType Value) const
 
TIntVector3 operator^ (IntType Value) const
 
bool IsZero () const
 
IntType GetMax () const
 
IntType GetMin () const
 
IntType Size () const
 
FString ToString () const
 
bool Serialize (FArchive &Ar)
 
bool SerializeFromMismatchedTag (FName StructTag, FArchive &Ar)
 
FORCEINLINE TIntVector3 (FVector InVector)
 
FORCEINLINE TIntVector3 (FVector InVector)
 
FString ToString () const
 
FString ToString () const
 
FString ToString () const
 
FString ToString () const
 
FString ToString () const
 
FString ToString () const
 
FString ToString () const
 
FString ToString () const
 

Static Public Member Functions

static TIntVector3 DivideAndRoundUp (TIntVector3 lhs, IntType Divisor)
 
static TIntVector3 DivideAndRoundUp (TIntVector3 lhs, TIntVector3 Divisor)
 
static int32 Num ()
 

Public Attributes

union { 
 
   struct { 
 
      IntType   X 
 
      IntType   Y 
 
      IntType   Z 
 
   }  
 
   IntType   XYZ [3] 
 
};  
 

Static Public Attributes

static const TIntVector3 ZeroValue
 
static const TIntVector3 NoneValue
 

Friends

FArchive & operator<< (FArchive &Ar, TIntVector3 &Vector)
 
void operator<< (FStructuredArchive::FSlot Slot, TIntVector3 &Vector)
 

Detailed Description

template<typename InIntType>
struct UE::Math::TIntVector3< InIntType >

Structure for integer vectors in 3-d space.

Definition at line 19 of file IntVector.h.

Member Typedef Documentation

◆ IntType

template<typename InIntType >
using UE::Math::TIntVector3< InIntType >::IntType = InIntType

Definition at line 21 of file IntVector.h.

Constructor & Destructor Documentation

◆ TIntVector3() [1/8]

template<typename InIntType >
UE::Math::TIntVector3< InIntType >::TIntVector3 ( )
default

Default constructor (no initialization).

◆ TIntVector3() [2/8]

template<typename InIntType >
UE::Math::TIntVector3< InIntType >::TIntVector3 ( IntType InX,
IntType InY,
IntType InZ )
inline

Creates and initializes a new instance with the specified coordinates.

Parameters
InXThe x-coordinate.
InYThe y-coordinate.
InZThe z-coordinate.

Definition at line 60 of file IntVector.h.

◆ TIntVector3() [3/8]

template<typename InIntType >
UE::Math::TIntVector3< InIntType >::TIntVector3 ( IntType InValue)
inlineexplicit

Constructor

Parameters
InValuereplicated to all components

Definition at line 72 of file IntVector.h.

◆ TIntVector3() [4/8]

template<typename InIntType >
UE::Math::TIntVector3< InIntType >::TIntVector3 ( FVector InVector)
explicit

Constructor

Parameters
InVectorfloat vector converted to int

◆ TIntVector3() [5/8]

template<typename InIntType >
UE::Math::TIntVector3< InIntType >::TIntVector3 ( EForceInit )
inlineexplicit

Constructor

Parameters
EForceInitForce init enum

Definition at line 92 of file IntVector.h.

◆ TIntVector3() [6/8]

template<typename InIntType >
template<typename OtherIntType >
UE::Math::TIntVector3< InIntType >::TIntVector3 ( TIntVector3< OtherIntType > Other)
inlineexplicit

Converts to another int type. Checks that the cast will succeed.

Definition at line 103 of file IntVector.h.

◆ TIntVector3() [7/8]

FORCEINLINE UE::Math::TIntVector3< int32 >::TIntVector3 ( FVector InVector)

Definition at line 2659 of file Vector.h.

◆ TIntVector3() [8/8]

FORCEINLINE UE::Math::TIntVector3< uint32 >::TIntVector3 ( FVector InVector)

Definition at line 2667 of file Vector.h.

Member Function Documentation

◆ DivideAndRoundUp() [1/2]

template<typename InIntType >
static TIntVector3 UE::Math::TIntVector3< InIntType >::DivideAndRoundUp ( TIntVector3< InIntType > lhs,
IntType Divisor )
inlinestatic

Divide an int point and round up the result.

Parameters
lhsThe int point being divided.
DivisorWhat to divide the int point by.
Returns
A new divided int point.

Definition at line 454 of file IntVector.h.

◆ DivideAndRoundUp() [2/2]

template<typename InIntType >
static TIntVector3 UE::Math::TIntVector3< InIntType >::DivideAndRoundUp ( TIntVector3< InIntType > lhs,
TIntVector3< InIntType > Divisor )
inlinestatic

Definition at line 459 of file IntVector.h.

◆ GetMax()

template<typename InIntType >
IntType UE::Math::TIntVector3< InIntType >::GetMax ( ) const
inline

Gets the maximum value in the point.

Returns
The maximum value in the point.

Definition at line 409 of file IntVector.h.

◆ GetMin()

template<typename InIntType >
IntType UE::Math::TIntVector3< InIntType >::GetMin ( ) const
inline

Gets the minimum value in the point.

Returns
The minimum value in the point.

Definition at line 419 of file IntVector.h.

◆ IsZero()

template<typename InIntType >
bool UE::Math::TIntVector3< InIntType >::IsZero ( ) const
inline

Is vector equal to zero.

Returns
is zero

Definition at line 399 of file IntVector.h.

◆ Num()

template<typename InIntType >
static int32 UE::Math::TIntVector3< InIntType >::Num ( )
inlinestatic

Gets the number of components a point has.

Returns
Number of components point has.

Definition at line 469 of file IntVector.h.

◆ operator!=()

template<typename InIntType >
bool UE::Math::TIntVector3< InIntType >::operator!= ( const TIntVector3< InIntType > & Other) const
inline

Compares points for inequality.

Parameters
OtherThe other int point being compared.
Returns
true if the points are not equal, false otherwise..

Definition at line 179 of file IntVector.h.

◆ operator%()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator% ( IntType Divisor) const
inline

Gets the remainder of division on this point.

Parameters
DivisorWhat to divide the point by.
Returns
A new remainder int point.

Definition at line 313 of file IntVector.h.

◆ operator%=()

template<typename InIntType >
TIntVector3 & UE::Math::TIntVector3< InIntType >::operator%= ( IntType Divisor)
inline

Remainder of division of this point.

Parameters
DivisorWhat to divide the point by.
Returns
Reference to this point after remainder.

Definition at line 235 of file IntVector.h.

◆ operator&()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator& ( IntType Value) const
inline

Component-wise AND.

Parameters
ValueNumber to AND with the each component.
Returns
A new shifted int point.

Definition at line 368 of file IntVector.h.

◆ operator()() [1/2]

template<typename InIntType >
IntType & UE::Math::TIntVector3< InIntType >::operator() ( int32 ComponentIndex)
inline

Gets specific component of a point.

Parameters
ComponentIndexIndex of point component.
Returns
reference to component.

Definition at line 129 of file IntVector.h.

◆ operator()() [2/2]

template<typename InIntType >
const IntType & UE::Math::TIntVector3< InIntType >::operator() ( int32 ComponentIndex) const
inline

Gets specific component of a point.

Parameters
ComponentIndexIndex of point component.
Returns
const reference to component.

Definition at line 116 of file IntVector.h.

◆ operator*() [1/2]

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator* ( const TIntVector3< InIntType > & Other) const
inline

Gets the result of component-wise multiplication of this point by another.

Parameters
OtherThe point to multiply with.
Returns
The result of multiplication.

Definition at line 280 of file IntVector.h.

◆ operator*() [2/2]

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator* ( IntType Scale) const
inline

Gets the result of scaling on this point.

Parameters
ScaleWhat to multiply the point by.
Returns
A new scaled int point.

Definition at line 291 of file IntVector.h.

◆ operator*=() [1/2]

template<typename InIntType >
TIntVector3 & UE::Math::TIntVector3< InIntType >::operator*= ( const TIntVector3< InIntType > & Other)
inline

Multiplies this vector with another vector, using component-wise multiplication.

Parameters
OtherThe point to multiply with.
Returns
Reference to this point after multiplication.

Definition at line 190 of file IntVector.h.

◆ operator*=() [2/2]

template<typename InIntType >
TIntVector3 & UE::Math::TIntVector3< InIntType >::operator*= ( IntType Scale)
inline

Scales this point.

Parameters
ScaleWhat to multiply the point by.
Returns
Reference to this point after multiplication.

Definition at line 205 of file IntVector.h.

◆ operator+()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator+ ( const TIntVector3< InIntType > & Other) const
inline

Gets the result of addition on this point.

Parameters
OtherThe other point to add to this.
Returns
A new combined int point.

Definition at line 324 of file IntVector.h.

◆ operator+=()

template<typename InIntType >
TIntVector3 & UE::Math::TIntVector3< InIntType >::operator+= ( const TIntVector3< InIntType > & Other)
inline

Adds to this point.

Parameters
OtherThe point to add to this point.
Returns
Reference to this point after addition.

Definition at line 250 of file IntVector.h.

◆ operator-()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator- ( const TIntVector3< InIntType > & Other) const
inline

Gets the result of subtraction from this point.

Parameters
OtherThe other point to subtract from this.
Returns
A new subtracted int point.

Definition at line 335 of file IntVector.h.

◆ operator-=()

template<typename InIntType >
TIntVector3 & UE::Math::TIntVector3< InIntType >::operator-= ( const TIntVector3< InIntType > & Other)
inline

Subtracts from this point.

Parameters
OtherThe point to subtract from this point.
Returns
Reference to this point after subtraction.

Definition at line 265 of file IntVector.h.

◆ operator/()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator/ ( IntType Divisor) const
inline

Gets the result of division on this point.

Parameters
DivisorWhat to divide the point by.
Returns
A new divided int point.

Definition at line 302 of file IntVector.h.

◆ operator/=()

template<typename InIntType >
TIntVector3 & UE::Math::TIntVector3< InIntType >::operator/= ( IntType Divisor)
inline

Divides this point.

Parameters
DivisorWhat to divide the point by.
Returns
Reference to this point after division.

Definition at line 220 of file IntVector.h.

◆ operator<<()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator<< ( IntType Shift) const
inline

Shifts all components to the left.

Parameters
ShiftThe number of bits to shift.
Returns
A new shifted int point.

Definition at line 357 of file IntVector.h.

◆ operator==()

template<typename InIntType >
bool UE::Math::TIntVector3< InIntType >::operator== ( const TIntVector3< InIntType > & Other) const
inline

Compares points for equality.

Parameters
OtherThe other int point being compared.
Returns
true if the points are equal, false otherwise..

Definition at line 168 of file IntVector.h.

◆ operator>>()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator>> ( IntType Shift) const
inline

Shifts all components to the right.

Parameters
ShiftThe number of bits to shift.
Returns
A new shifted int point.

Definition at line 346 of file IntVector.h.

◆ operator[]() [1/2]

template<typename InIntType >
IntType & UE::Math::TIntVector3< InIntType >::operator[] ( int32 ComponentIndex)
inline

Gets specific component of a point.

Parameters
ComponentIndexIndex of point component.
Returns
reference to component.

Definition at line 155 of file IntVector.h.

◆ operator[]() [2/2]

template<typename InIntType >
const IntType & UE::Math::TIntVector3< InIntType >::operator[] ( int32 ComponentIndex) const
inline

Gets specific component of a point.

Parameters
ComponentIndexIndex of point component.
Returns
const reference to component.

Definition at line 142 of file IntVector.h.

◆ operator^()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator^ ( IntType Value) const
inline

Component-wise XOR.

Parameters
ValueNumber to XOR with the each component.
Returns
A new shifted int point.

Definition at line 390 of file IntVector.h.

◆ operator|()

template<typename InIntType >
TIntVector3 UE::Math::TIntVector3< InIntType >::operator| ( IntType Value) const
inline

Component-wise OR.

Parameters
ValueNumber to OR with the each component.
Returns
A new shifted int point.

Definition at line 379 of file IntVector.h.

◆ Serialize()

template<typename InIntType >
bool UE::Math::TIntVector3< InIntType >::Serialize ( FArchive & Ar)
inline

Definition at line 494 of file IntVector.h.

◆ SerializeFromMismatchedTag()

bool FUint64Vector3::SerializeFromMismatchedTag ( FName StructTag,
FArchive & Ar )
inline

Definition at line 1148 of file IntVector.h.

◆ Size()

template<typename InIntType >
IntType UE::Math::TIntVector3< InIntType >::Size ( ) const
inline

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

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

Definition at line 429 of file IntVector.h.

◆ ToString() [1/9]

template<typename InIntType >
FString UE::Math::TIntVector3< InIntType >::ToString ( ) const
inline

Get a textual representation of this vector.

Returns
A string describing the vector.

Definition at line 442 of file IntVector.h.

◆ ToString() [2/9]

FString UE::Math::TIntVector3< int64 >::ToString ( ) const
inline

Definition at line 504 of file IntVector.h.

◆ ToString() [3/9]

FString UE::Math::TIntVector3< int32 >::ToString ( ) const
inline

Definition at line 510 of file IntVector.h.

◆ ToString() [4/9]

FString UE::Math::TIntVector3< int16 >::ToString ( ) const
inline

Definition at line 516 of file IntVector.h.

◆ ToString() [5/9]

FString UE::Math::TIntVector3< int8 >::ToString ( ) const
inline

Definition at line 522 of file IntVector.h.

◆ ToString() [6/9]

FString UE::Math::TIntVector3< uint64 >::ToString ( ) const
inline

Definition at line 528 of file IntVector.h.

◆ ToString() [7/9]

FString UE::Math::TIntVector3< uint32 >::ToString ( ) const
inline

Definition at line 534 of file IntVector.h.

◆ ToString() [8/9]

FString UE::Math::TIntVector3< uint16 >::ToString ( ) const
inline

Definition at line 540 of file IntVector.h.

◆ ToString() [9/9]

FString UE::Math::TIntVector3< uint8 >::ToString ( ) const
inline

Definition at line 546 of file IntVector.h.

Friends And Related Symbol Documentation

◆ operator<< [1/2]

template<typename InIntType >
FArchive & operator<< ( FArchive & Ar,
TIntVector3< InIntType > & Vector )
friend

Serializes the Vector3.

Parameters
ArThe archive to serialize into.
VectorThe vector to serialize.
Returns
Reference to the Archive after serialization.

Definition at line 481 of file IntVector.h.

◆ operator<< [2/2]

template<typename InIntType >
void operator<< ( FStructuredArchive::FSlot Slot,
TIntVector3< InIntType > & Vector )
friend

Definition at line 486 of file IntVector.h.

Member Data Documentation

◆ [union]

union { ... } UE::Math::TIntVector3< InIntType >

◆ NoneValue

template<typename IntType >
const TIntVector3< IntType > UE::Math::TIntVector3< IntType >::NoneValue
static

An int point with INDEX_NONE values.

Definition at line 46 of file IntVector.h.

◆ X

template<typename InIntType >
IntType UE::Math::TIntVector3< InIntType >::X

Holds the point's x-coordinate.

Definition at line 29 of file IntVector.h.

◆ XYZ

template<typename InIntType >
IntType UE::Math::TIntVector3< InIntType >::XYZ[3]

Definition at line 39 of file IntVector.h.

◆ Y

template<typename InIntType >
IntType UE::Math::TIntVector3< InIntType >::Y

Holds the point's y-coordinate.

Definition at line 32 of file IntVector.h.

◆ Z

template<typename InIntType >
IntType UE::Math::TIntVector3< InIntType >::Z

Holds the point's z-coordinate.

Definition at line 35 of file IntVector.h.

◆ ZeroValue

template<typename IntType >
const TIntVector3< IntType > UE::Math::TIntVector3< IntType >::ZeroValue
static

An int point with zeroed values.

Definition at line 43 of file IntVector.h.

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