Ark Server API (ASE) - Wiki
Loading...
Searching...
No Matches
FIntVector Struct Reference

#include <IntVector.h>

+ Collaboration diagram for FIntVector:

Public Member Functions

 FIntVector ()
 
 FIntVector (int32 InX, int32 InY, int32 InZ)
 
 FIntVector (int32 InValue)
 
 FIntVector (FVector InVector)
 
FORCEINLINE FIntVector (EForceInit)
 
const int32operator() (int32 ComponentIndex) const
 
int32operator() (int32 ComponentIndex)
 
const int32operator[] (int32 ComponentIndex) const
 
int32operator[] (int32 ComponentIndex)
 
bool operator== (const FIntVector &Other) const
 
bool operator!= (const FIntVector &Other) const
 
FIntVectoroperator*= (int32 Scale)
 
FIntVectoroperator/= (int32 Divisor)
 
FIntVectoroperator+= (const FIntVector &Other)
 
FIntVectoroperator-= (const FIntVector &Other)
 
FIntVectoroperator= (const FIntVector &Other)
 
FIntVector operator* (int32 Scale) const
 
FIntVector operator/ (int32 Divisor) const
 
FIntVector operator+ (const FIntVector &Other) const
 
FIntVector operator- (const FIntVector &Other) const
 
bool IsZero () const
 
float GetMax () const
 
float GetMin () const
 
int32 Size () const
 

Static Public Member Functions

static FIntVector DivideAndRoundUp (FIntVector lhs, int32 Divisor)
 
static int32 Num ()
 

Public Attributes

int32 X
 
int32 Y
 
int32 Z
 

Static Public Attributes

static const FIntVector ZeroValue
 
static const FIntVector NoneValue
 

Detailed Description

Structure for integer vectors in 3-d space.

Definition at line 16 of file IntVector.h.

Constructor & Destructor Documentation

◆ FIntVector() [1/5]

FORCEINLINE FIntVector::FIntVector ( )

Default constructor (no initialization).

Definition at line 246 of file IntVector.h.

◆ FIntVector() [2/5]

FORCEINLINE FIntVector::FIntVector ( int32 InX,
int32 InY,
int32 InZ )

Creates and initializes a new instance with the specified coordinates.

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

Definition at line 250 of file IntVector.h.

+ Here is the caller graph for this function:

◆ FIntVector() [3/5]

FORCEINLINE FIntVector::FIntVector ( int32 InValue)
explicit

Constructor

Parameters
InValuereplicated to all components

Definition at line 257 of file IntVector.h.

◆ FIntVector() [4/5]

FORCEINLINE FIntVector::FIntVector ( FVector InVector)
explicit

Constructor

Parameters
InVectorfloat vector converted to int

Definition at line 936 of file Vector.h.

+ Here is the call graph for this function:

◆ FIntVector() [5/5]

FORCEINLINE FIntVector::FIntVector ( EForceInit )
explicit

Constructor

Parameters
EForceInitForce init enum

Definition at line 264 of file IntVector.h.

Member Function Documentation

◆ DivideAndRoundUp()

FORCEINLINE FIntVector FIntVector::DivideAndRoundUp ( FIntVector lhs,
int32 Divisor )
static

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 379 of file IntVector.h.

+ Here is the call graph for this function:

◆ GetMax()

FORCEINLINE float FIntVector::GetMax ( ) const

Gets the maximum value in the point.

Returns
The maximum value in the point.

Definition at line 385 of file IntVector.h.

+ Here is the call graph for this function:

◆ GetMin()

FORCEINLINE float FIntVector::GetMin ( ) const

Gets the minimum value in the point.

Returns
The minimum value in the point.

Definition at line 391 of file IntVector.h.

+ Here is the call graph for this function:

◆ IsZero()

FORCEINLINE bool FIntVector::IsZero ( ) const

Is vector equal to zero.

Returns
is zero

Definition at line 411 of file IntVector.h.

+ Here is the call graph for this function:

◆ Num()

FORCEINLINE int32 FIntVector::Num ( )
static

Gets the number of components a point has.

Returns
Number of components point has.

Definition at line 397 of file IntVector.h.

◆ operator!=()

FORCEINLINE bool FIntVector::operator!= ( const FIntVector & Other) const

Compares points for inequality.

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

Definition at line 300 of file IntVector.h.

◆ operator()() [1/2]

FORCEINLINE int32 & FIntVector::operator() ( int32 ComponentIndex)

Gets specific component of a point.

Parameters
ComponentIndexIndex of point component.
Returns
reference to component.

Definition at line 277 of file IntVector.h.

◆ operator()() [2/2]

FORCEINLINE const int32 & FIntVector::operator() ( int32 ComponentIndex) const

Gets specific component of a point.

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

Definition at line 271 of file IntVector.h.

◆ operator*()

FORCEINLINE FIntVector FIntVector::operator* ( int32 Scale) const

Gets the result of scaling on this point.

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

Definition at line 356 of file IntVector.h.

+ Here is the call graph for this function:

◆ operator*=()

FORCEINLINE FIntVector & FIntVector::operator*= ( int32 Scale)

Scales this point.

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

Definition at line 306 of file IntVector.h.

+ Here is the caller graph for this function:

◆ operator+()

FORCEINLINE FIntVector FIntVector::operator+ ( const FIntVector & Other) const

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 368 of file IntVector.h.

+ Here is the call graph for this function:

◆ operator+=()

FORCEINLINE FIntVector & FIntVector::operator+= ( const FIntVector & Other)

Adds to this point.

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

Definition at line 326 of file IntVector.h.

+ Here is the caller graph for this function:

◆ operator-()

FORCEINLINE FIntVector FIntVector::operator- ( const FIntVector & Other) const

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 373 of file IntVector.h.

+ Here is the call graph for this function:

◆ operator-=()

FORCEINLINE FIntVector & FIntVector::operator-= ( const FIntVector & Other)

Subtracts from this point.

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

Definition at line 336 of file IntVector.h.

+ Here is the caller graph for this function:

◆ operator/()

FORCEINLINE FIntVector FIntVector::operator/ ( int32 Divisor) const

Gets the result of division on this point.

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

Definition at line 362 of file IntVector.h.

+ Here is the call graph for this function:

◆ operator/=()

FORCEINLINE FIntVector & FIntVector::operator/= ( int32 Divisor)

Divides this point.

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

Definition at line 316 of file IntVector.h.

+ Here is the caller graph for this function:

◆ operator=()

FORCEINLINE FIntVector & FIntVector::operator= ( const FIntVector & Other)

Assigns another point to this one.

Parameters
OtherThe point to assign this point from.
Returns
Reference to this point after assignment.

Definition at line 346 of file IntVector.h.

◆ operator==()

FORCEINLINE bool FIntVector::operator== ( const FIntVector & Other) const

Compares points for equality.

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

Definition at line 294 of file IntVector.h.

+ Here is the caller graph for this function:

◆ operator[]() [1/2]

FORCEINLINE int32 & FIntVector::operator[] ( int32 ComponentIndex)

Gets specific component of a point.

Parameters
ComponentIndexIndex of point component.
Returns
reference to component.

Definition at line 289 of file IntVector.h.

◆ operator[]() [2/2]

FORCEINLINE const int32 & FIntVector::operator[] ( int32 ComponentIndex) const

Gets specific component of a point.

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

Definition at line 283 of file IntVector.h.

◆ Size()

FORCEINLINE int32 FIntVector::Size ( ) const

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

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

Definition at line 403 of file IntVector.h.

+ Here is the call graph for this function:

Member Data Documentation

◆ NoneValue

const FIntVector FIntVector::NoneValue
static

An int point with INDEX_NONE values.

Definition at line 33 of file IntVector.h.

◆ X

int32 FIntVector::X

Holds the point's x-coordinate.

Definition at line 19 of file IntVector.h.

◆ Y

int32 FIntVector::Y

Holds the point's y-coordinate.

Definition at line 22 of file IntVector.h.

◆ Z

int32 FIntVector::Z

Holds the point's z-coordinate.

Definition at line 25 of file IntVector.h.

◆ ZeroValue

const FIntVector FIntVector::ZeroValue
static

An int point with zeroed values.

Definition at line 30 of file IntVector.h.


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