1. Epic GamesDeveloper
  3. TIntVector3

TIntVector3

Structure for integer vectors in 3-d space.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Math

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Math/IntVector.h
Include #include "Math/IntVector.h"
Source /Engine/Source/Runtime/Core/Public/Math/MathFwd.h

Syntax

template<typename IntType >  
struct TIntVector3

Remarks

Structure for integer vectors in 3-d space.

Variables

  Type Name Description
Public variable union UE::Math::TIntVector3    
Public variable IntType X Holds the vector's x-coordinate.
Public variable IntType[3] XYZ  
Public variable IntType Y Holds the vector's y-coordinate.
Public variable IntType Z Holds the vector's z-coordinate.

Constructors

  Type Name Description
Public function   Default constructor (no initialization).
Public function  

TIntVector3 ( IntType InX,
IntType InY,
IntType InZ
)

 Creates and initializes a new instance with the specified coordinates.
Public function  

TIntVector3 ( IntType InValue
)

 Constructor
Public function  

TIntVector3 ( TVector< FloatType > InVector
)

 Constructor
Public function   Constructor
Public function  

TIntVector3 ( TIntVector3< OtherIntType > Other
)

 Converts to another int type. Checks that the cast will succeed.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS Workaround for clang deprecation warnings for deprecated XYZ member in implicitly-defined special member functions.
Public function    
Public function  

TIntVector3 ( TVector< T > InVector
)

  
Public function  

TIntVector3 ( TVector< T > InVector
)

  

Functions

  Type Name Description
Public function Const void Appends a textual representation of this vector to the output string.
Public function Const void

AppendString ( TStringBuilderBase< CharType >& Out
)

 Appends a textual representation of this vector to the output string builder.
Public function Const TIntVector3

ComponentMax ( const TIntVector3& Other
)

 Get the component-wise max of this vector and the parameter vector.
Public function Const TIntVector3

ComponentMin ( const TIntVector3& Other
)

 Get the component-wise min of this vector and the parameter vector.
Public function Static TIntVector3 Divide an int vector and round up the result.
Public function Static TIntVector3  
Public function Const IntType Get the maximum absolute value in the vector.
Public function Const IntType Get the minimum absolute value in the vector.
Public function Const IntType

GetMax ()

 Gets the maximum value in the vector.
Public function Const IntType

GetMin ()

 Gets the minimum value in the vector.
Public function bool

InitFromString ( const FString& InSourceString
)

 Initialize this vector based on an FString.
Public function Const bool

IsZero ()

 Is vector equal to zero.
Public function Static int32

Num ()

 Gets the number of components a vector has.
Public function bool  
Public function bool  
Public function Const IntType

Size ()

 Gets the distance of this vector from (0,0,0).
Public function Const FString Get a textual representation of this vector.

Operators

  Type Name Description
Public function Const TIntVector3

operator- ( const TIntVector3& Other
)

 Gets the result of subtraction from this vector.
Public function Const bool

operator!= ( const TIntVector3& Other
)

 Compares vectors for inequality.
Public function Const TIntVector3

operator% ( IntType Divisor
)

 Gets the remainder of division on this vector.
Public function TIntVector3 &

operator%= ( IntType Divisor
)

 Remainder of division of this vector.
Public function Const TIntVector3

operator& ( IntType Value
)

 Component-wise AND.
Public function IntType &

operator() ( int32 ComponentIndex
)

 Gets specific component of a vector.
Public function Const const IntType &

operator() ( int32 ComponentIndex
)

 Gets specific component of a vector.
Public function Const TIntVector3

operator* ( const TIntVector3& Other
)

 Gets the result of component-wise multiplication of this vector by another.
Public function Const TIntVector3

operator* ( IntType Scale
)

 Gets the result of scaling on this vector.
Public function TIntVector3 &

operator*= ( IntType Scale
)

 Scales this vector.
Public function TIntVector3 &

operator*= ( const TIntVector3& Other
)

 Multiplies this vector with another vector, using component-wise multiplication.
Public function Const TIntVector3

operator/ ( IntType Divisor
)

 Gets the result of division on this vector.
Public function TIntVector3 &

operator/= ( IntType Divisor
)

 Divides this vector.
Public function IntType &

operator[] ( int32 ComponentIndex
)

 Gets specific component of a vector.
Public function Const const IntType &

operator[] ( int32 ComponentIndex
)

 Gets specific component of a vector.
Public function Const TIntVector3

operator^ ( IntType Value
)

 Component-wise XOR.
Public function Const TIntVector3

operator| ( IntType Value
)

 Component-wise OR.
Public function Const TIntVector3

operator+ ( const TIntVector3& Other
)

 Gets the result of addition on this vector.
Public function TIntVector3 &

operator+= ( const TIntVector3& Other
)

 Adds to this vector.
Public function Const TIntVector3

operator<< ( IntType Shift
)

 Shifts all components to the left.
Public function TIntVector3 &

operator= ( const TIntVector3&
)

  
Public function TIntVector3 &  
Public function TIntVector3 &

operator-= ( const TIntVector3& Other
)

 Subtracts from this vector.
Public function Const bool

operator== ( const TIntVector3& Other
)

 Compares vectors for equality.
Public function Const TIntVector3

operator>> ( IntType Shift
)

 Shifts all components to the right.

Typedefs

Name Description
IntType  

Constants

Name Description
NoneValue An int vector with INDEX_NONE values.
ZeroValue An int vector with zeroed values.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page