1. Epic GamesDeveloper
  3. FStructArrayView

FStructArrayView

A generic, transient view of a homogeneously-typed array of instances of a specific [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct)[FStructArrayView](API\Plugins\StructUtils\FStructArrayView) supplies mutable access to the elements of the Array.

API > API/Plugins > API/Plugins/StructUtils

References

   
Module StructUtils
Header /Engine/Plugins/Experimental/StructUtils/Source/StructUtils/Public/StructArrayView.h
Include #include "StructArrayView.h"

Syntax

struct FStructArrayView

Remarks

A generic, transient view of a homogeneously-typed array of instances of a specific UScriptStructFStructArrayView supplies mutable access to the elements of the Array. Note const FStructArrayView only what the view is pointing to can not be modified the actual struct data is still mutable. For a more indepth overview of the constness of views see FConstStructView

Constructors

  Type Name Description
Public function    
Public function  

FStructArrayView ( TArray< T >& InArray
)

  
Public function  

FStructArrayView ( TArrayView< T > InArrayView
)

  
Public function  

FStructArrayView ( const UScriptStruct& InScriptStruct,
void* InData,
const int32 InCount
)

  
Public function  

FStructArrayView ( const UScriptStruct* InScriptStruct,
void* InData,
const int32 InCount
)

 Use constructor that takes a reference instead
Public function  

FStructArrayView ( const UScriptStruct* InScriptStruct,
void* InData,
const uint32 InElementSize,
const int32 InCount
)

  

Functions

  Type Name Description
Public function Const FIterator

begin ()

 Ranged iteration support. DO NOT USE DIRECTLY.
Public function Const void Checks array invariants: if array size is greater than or equal to zero.
Public function Const FIterator

end ()

  
Public function Const T &

GetAt ( const int32 Index
)

 Returns reference to element at given index.
Public function Const void *

GetData ()

 Helper function for returning a pointer to the first array element.
Public function Const void *

GetDataAt ( const int32 Index
)

 Helper function for returning a pointer to an element in the array.
Public function Const T *

GetPtrAt ( const int32 Index
)

 Returns pointer to element at given index.
Public function Const const UScriptStruct * Returns struct type.
Public function Const uint32 Helper function returning the size of the inner type.
Public function Const bool

IsEmpty ()

 Returns true if the array is empty and contains no elements.
Public function Const bool

IsValidIndex ( const int32 Index
)

 Tests if index is valid, i.e. greater than or equal to zero, and less than the number of elements in the array.
Public function Const T &

Last ( const int32 IndexFromTheEnd
)

 Returns n-th last element from the array.
Public function Const FStructArrayView

Left ( const int32 Count
)

 Returns the left-most part of the view by taking the given number of elements from the left.
Public function Const FStructArrayView

LeftChop ( const int32 Count
)

 Returns the left-most part of the view by chopping the given number of elements from the right.
Public function void

LeftChopInline ( const int32 Count
)

 Modifies the view by chopping the given number of elements from the right.
Public function void

LeftInline ( const int32 Count
)

 Modifies the view to be the given number of elements from the left.
Public function Const FStructArrayView

Mid ( int32 Index,
int32 Count
)

 Returns the middle part of the view by taking up to the given number of elements from the given position.
Public function void

MidInline ( const int32 Position,
const int32 Count
)

 Modifies the view to be the middle part by taking up to the given number of elements from the given position.
Public function Const int32

Num ()

 Returns number of elements in array.
Public function Const void

RangeCheck ( int32 Index
)

 Checks if index is in array range.
Public function Const FStructArrayView

Right ( const int32 Count
)

 Returns the right-most part of the view by taking the given number of elements from the right.
Public function Const FStructArrayView

RightChop ( const int32 Count
)

 Returns the right-most part of the view by chopping the given number of elements from the left.
Public function void

RightChopInline ( const int32 Count
)

 Modifies the view by chopping the given number of elements from the left.
Public function void

RightInline ( const int32 Count
)

 Modifies the view to be the given number of elements from the right.
Public function Const FStructArrayView

Slice ( const int32 Index,
const int32 InNum
)

 Returns a sliced view This is similar to Mid(), but with a narrow contract, i.e. slicing outside of the range of the view is illegal.
Public function Const void

SliceRangeCheck ( const int32 Index,
const int32 InNum
)

 Checks if a slice range [Index, Index+InNum) is in array range.
Public function void

Swap ( const int32 Index1,
const int32 Index2
)

 Swaps the elements at the specified Indicies. The indicies must be valid!

Operators

  Type Name Description
Public function Const FStructView

operator[] ( const int32 Index
)

 Array bracket operator.

Classes

  Type Name Description
Public struct FIterator    

Deprecated Functions

  Type Name Description
Public function  

FStructArrayView ( const UScriptStruct* InScriptStruct,
void* InData,
const int32 InCount
)

 Use constructor that takes a reference instead
Public function Const const T &

GetElementAt ( const int32 Index
)

 Use GetAt() instead!
Public function Const const T &

GetElementAtChecked ( const int32 Index
)

 Use GetAt() instead!
Public function Const SIZE_T Removed to bring in to line with ArrayView, use GetTypeSize() instead
Public function Const const UScriptStruct & Use GetScriptStruct() instead
Public function Const const UScriptStruct & Use GetScriptStruct() instead
Public function Const void *

GetMutableDataAt ( const int32 Index
)

 Use GetDataAt() instead
Public function Const T &

GetMutableElementAt ( const int32 Index
)

 Use GetAt() instead!
Public function Const T &

GetMutableElementAtChecked ( const int32 Index
)

 Use GetAt() instead!

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page