1. Epic GamesDeveloper
  3. FRowHandleArray

FRowHandleArray

Array dedicated to handling row handles.

API > API/Runtime > API/Runtime/TypedElementFramework

Array dedicated to handling row handles. This provides various unique and optimized functionality that makes working with a large number row handles easier and more efficient.

   
Name FRowHandleArray
Type class
Header File /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementRowHandleArray.h
Include Path #include "Elements/Framework/TypedElementRowHandleArray.h"

Syntax

class FRowHandleArray

Constructors

Name Remarks Include Path Unreal Specifiers
  Elements/Framework/TypedElementRowHandleArray.h  
  Elements/Framework/TypedElementRowHandleArray.h  

Typedefs

Name Type Remarks Include Path
EFlags FRowHandleArrayView::EFlags   Elements/Framework/TypedElementRowHandleArray.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsSorted bool   Elements/Framework/TypedElementRowHandleArray.h  
bIsUnique bool   Elements/Framework/TypedElementRowHandleArray.h  
Rows TArray< RowHandle >   Elements/Framework/TypedElementRowHandleArray.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( RowHandle Row,
EFlags Guarantee
)

 Appends the provided row handle at the end of the array. Elements/Framework/TypedElementRowHandleArray.h  

void Append ( FRowHandleArrayView AdditionalRows
)

 Append the provided list of rows to the end of the array. Elements/Framework/TypedElementRowHandleArray.h  

void Append ( TConstArrayView< RowHandle > AdditionalRows,
EFlags Guarantee
)

 Append the provided list of rows to the end of the array. Elements/Framework/TypedElementRowHandleArray.h  

bool Contains ( RowHandle Row
) const

 Checks if the provided row is stored in this array. Elements/Framework/TypedElementRowHandleArray.h  

void Empty ( int32 Slack
)

 Removes all row handles and releases all allocated memory. Elements/Framework/TypedElementRowHandleArray.h  

TArrayView< RowHandle > GetMutableRows ( EFlags Guarantee
)

 Returns a mutable view of the array of rows. Elements/Framework/TypedElementRowHandleArray.h  
Constructs a view of the array to provide access to its rows. Elements/Framework/TypedElementRowHandleArray.h  

void InvertOrder ()

 Reverses the order in which the rows are stored, making the first element the last and vice versa. Elements/Framework/TypedElementRowHandleArray.h  

bool IsEmpty()

 Whether or not there are any values in the view. Elements/Framework/TypedElementRowHandleArray.h  

bool IsSame ( const FRowHandleArray& Other
) const

 Whether or not the two arrays contain the same values. Elements/Framework/TypedElementRowHandleArray.h  

bool IsSorted()

 Whether or not the contained rows are numerically ordered from smallest to largest. Elements/Framework/TypedElementRowHandleArray.h  

bool IsUnique()

 Whether or all rows in the view only appear once. Elements/Framework/TypedElementRowHandleArray.h  

void MakeUnique ()

 Goes through the array and removes any duplicate entries. Elements/Framework/TypedElementRowHandleArray.h  

int32 Num()

 Returns the number of rows stored. Elements/Framework/TypedElementRowHandleArray.h  
Goes through the array and only keeps a single instance of any value that appears twice or more. Elements/Framework/TypedElementRowHandleArray.h  

void Remove ( FRowHandleArrayView RowsToRemove
)

 Removes the provided list of rows. Elements/Framework/TypedElementRowHandleArray.h  

void Remove ( TConstArrayView< RowHandle > RowsToRemove
)

 Removes the provided list of rows. Elements/Framework/TypedElementRowHandleArray.h  

void Remove ( RowHandle Row
)

 Removes the provided row. Elements/Framework/TypedElementRowHandleArray.h  

void Reserve ( int32 Count
)

 Reserve space for additional row handles. Elements/Framework/TypedElementRowHandleArray.h  

void Reset ( int32 NewSize
)

 Removes all row handles, but keeps the allocated memory around. Elements/Framework/TypedElementRowHandleArray.h  

void Shrink()

 Reduces the amount of memory used by the array to exactly fit the current number or elements. Elements/Framework/TypedElementRowHandleArray.h  

void Sort ()

 Sorts the row handles in numerical order from lowest to highest. Elements/Framework/TypedElementRowHandleArray.h  

void Sort ( TArrayView< RowHandle > ScratchBuffer
)

 Sorts the row handles in numerical order from lowest to highest. Elements/Framework/TypedElementRowHandleArray.h  

void SortedMerge ( const FRowHandleArray& AddedRows
)

 Merges the provided array into the array while remaining sorted. Elements/Framework/TypedElementRowHandleArray.h  

void SortedMerge ( FRowHandleArrayView AddedRows
)

 Merges the provided array into the array while remaining sorted. Elements/Framework/TypedElementRowHandleArray.h  

void SortedMerge ( FRowHandleArray&& AddedRows
)

 Merges the provided array into the array while remaining sorted. Elements/Framework/TypedElementRowHandleArray.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page