1. Epic GamesDeveloper
  3. TIntVector3

TIntVector3

Structure for integer vectors in 3-d space.

API > API/Runtime > API/Runtime/Core

Structure for integer vectors in 3-d space.

   
Name TIntVector3
Type struct
Header File /Engine/Source/Runtime/Core/Public/Math/IntVector.h
Include Path #include "Math/IntVector.h"
Source /Engine/Source/Runtime/Core/Public/Math/MathFwd.h

Syntax

template<typename IntType>  
struct TIntVector3

Constructors

Name Remarks Include Path Unreal Specifiers
  Math/IntVector.h  
Default constructor (no initialization). Math/IntVector.h  

TIntVector3 ( IntType InValue
)

 Constructor Math/IntVector.h  

TIntVector3 ( TIntVector4< IntType > Other
)

   Math/IntVector.h  

TIntVector3 ( TVector< FloatType > InVector
)

 Constructor Math/IntVector.h  
Constructor Math/IntVector.h  

TIntVector3 ( TIntVector3< OtherIntType > Other
)

 Converts to another int type. Checks that the cast will succeed. Math/IntVector.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS TIntVector3 ( TIntVector3&&
)

 Workaround for clang deprecation warnings for deprecated XYZ member in implicitly-defined special member functions. Math/IntVector.h  

TIntVector3 ( IntType InX,
IntType InY,
IntType InZ
)

 Creates and initializes a new instance with the specified coordinates. Math/IntVector.h  

Typedefs

Name Type Remarks Include Path
IntType InIntType   Math/IntVector.h

Constants

Name Type Remarks Include Path
NoneValue const TIntVector3 An int vector with INDEX_NONE values. Math/IntVector.h
ZeroValue const TIntVector3 An int vector with zeroed values. Math/IntVector.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TIntVector3 union UE::Math::TIntVector3   Math/IntVector.h  
X IntType Holds the vector's x-coordinate. Math/IntVector.h  
XYZ IntType   Math/IntVector.h  
Y IntType Holds the vector's y-coordinate. Math/IntVector.h  
Z IntType Holds the vector's z-coordinate. Math/IntVector.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AppendString ( TStringBuilderBase< CharType >& Out
) const

 Appends a textual representation of this vector to the output string builder. Math/IntVector.h  

void AppendString ( FString& Out
) const

 Appends a textual representation of this vector to the output string. Math/IntVector.h  

TIntVector3 ComponentMax ( const TIntVector3& Other
) const

 Get the component-wise max of this vector and the parameter vector. Math/IntVector.h  

TIntVector3 ComponentMin ( const TIntVector3& Other
) const

 Get the component-wise min of this vector and the parameter vector. Math/IntVector.h  

IntType GetAbsMax()

 Get the maximum absolute value in the vector. Math/IntVector.h  

IntType GetAbsMin()

 Get the minimum absolute value in the vector. Math/IntVector.h  

IntType GetMax()

 Gets the maximum value in the vector. Math/IntVector.h  

IntType GetMin()

 Gets the minimum value in the vector. Math/IntVector.h  

bool InitFromString ( const FString& InSourceString
)

 Initialize this vector based on an FString. Math/IntVector.h  

bool IsZero()

 Is vector equal to zero. Math/IntVector.h  

bool Serialize ( FArchive& Ar
)

   Math/IntVector.h  

bool SerializeFromMismatchedTag ( FName StructTag,
FArchive& Ar
)

   Math/IntVector.h  

IntType Size()

 Gets the distance of this vector from (0,0,0). Math/IntVector.h  

FString ToString()

 Get a textual representation of this vector. Math/IntVector.h  

Static

Name Remarks Include Path Unreal Specifiers

static TIntVector3 DivideAndRoundUp ( TIntVector3 Lhs,
IntType Divisor
)

 Divide an int vector and round up the result. Math/IntVector.h  
  Math/IntVector.h  

static int32 Num()

 Gets the number of components a vector has. Math/IntVector.h  

Operators

Name Remarks Include Path Unreal Specifiers

TIntVector3 operator- ( const TIntVector3& Other
) const

 Gets the result of subtraction from this vector. Math/IntVector.h  

bool operator!= ( const TIntVector3& Other
) const

 Compares vectors for inequality. Math/IntVector.h  

TIntVector3 operator% ( IntType Divisor
) const

 Gets the remainder of division on this vector. Math/IntVector.h  

TIntVector3 & operator%= ( IntType Divisor
)

 Remainder of division of this vector. Math/IntVector.h  

TIntVector3 operator& ( IntType Value
) const

 Component-wise AND. Math/IntVector.h  

IntType & operator() ( int32 ComponentIndex
)

 Gets specific component of a vector. Math/IntVector.h  

const IntType & operator() ( int32 ComponentIndex
) const

 Gets specific component of a vector. Math/IntVector.h  

TIntVector3 operator* ( IntType Scale
) const

 Gets the result of scaling on this vector. Math/IntVector.h  

TIntVector3 operator* ( const TIntVector3& Other
) const

 Gets the result of component-wise multiplication of this vector by another. Math/IntVector.h  

TIntVector3 & operator*= ( IntType Scale
)

 Scales this vector. Math/IntVector.h  

TIntVector3 & operator*= ( const TIntVector3& Other
)

 Multiplies this vector with another vector, using component-wise multiplication. Math/IntVector.h  

TIntVector3 operator/ ( IntType Divisor
) const

 Gets the result of division on this vector. Math/IntVector.h  

TIntVector3 & operator/= ( IntType Divisor
)

 Divides this vector. Math/IntVector.h  

const IntType & operator[] ( int32 ComponentIndex
) const

 Gets specific component of a vector. Math/IntVector.h  

IntType & operator[] ( int32 ComponentIndex
)

 Gets specific component of a vector. Math/IntVector.h  

TIntVector3 operator^ ( IntType Value
) const

 Component-wise XOR. Math/IntVector.h  

TIntVector3 operator| ( IntType Value
) const

 Component-wise OR. Math/IntVector.h  

TIntVector3 operator+ ( const TIntVector3& Other
) const

 Gets the result of addition on this vector. Math/IntVector.h  

TIntVector3 & operator+= ( const TIntVector3& Other
)

 Adds to this vector. Math/IntVector.h  
  Math/IntVector.h  
  Math/IntVector.h  

TIntVector3 & operator-= ( const TIntVector3& Other
)

 Subtracts from this vector. Math/IntVector.h  

bool operator== ( const TIntVector3& Other
) const

 Compares vectors for equality. Math/IntVector.h  

TIntVector3 operator>> ( IntType Shift
) const

 Shifts all components to the right. Math/IntVector.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page