1. Epic GamesDeveloper
  3. FManagedArrayCollection

FManagedArrayCollection

ManagedArrayCollection

API > API/Runtime > API/Runtime/Chaos

ManagedArrayCollection

The ManagedArrayCollection is an entity system that implements a homogeneous, dynamically allocated, manager of primitive TArray structures. The collection stores groups of TArray attributes, where each attribute within a group is the same length. The collection will make use of the TManagedArray class, providing limited interaction with the underlying TArray.

For example:

FManagedArrayCollection* Collection(NewObject()); Collection->AddElements(10, "GroupBar"); // Create a group GroupBar and add 10 elements. Collection->AddAttribute("AttributeFoo", "GroupBar"); // Add a FVector array named AttributeFoo to GroupBar. TManagedArray& Foo = Collection->GetAttribute("AttributeFoo", "GroupBar"); // Get AttributeFoo for (int32 i = 0; i < Foo.Num(); i++) { Foo[i] = FVector(i, i, i); // Update AttribureFoo's elements }

   
Name FManagedArrayCollection
Type struct
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/ManagedArrayCollection.h
Include Path #include "GeometryCollection/ManagedArrayCollection.h"

Syntax

USTRUCT ()  
struct FManagedArrayCollection

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  GeometryCollection/ManagedArrayCollection.h  
  GeometryCollection/ManagedArrayCollection.h  
  GeometryCollection/ManagedArrayCollection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FManagedArrayCollection()

   GeometryCollection/ManagedArrayCollection.h  

Structs

Name Remarks
FConstructionParameters  
FGroupInfo  
FManagedType  
FProcessingParameters  
FValueType  
TManagedType  

Typedefs

Name Type Remarks Include Path
EArrayType EManagedArrayType   GeometryCollection/ManagedArrayCollection.h
FKeyType TTuple< FName, FName >   GeometryCollection/ManagedArrayCollection.h

Constants

Name Type Remarks Include Path
Invalid int8   GeometryCollection/ManagedArrayCollection.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FSimulationProperties friend   GeometryCollection/ManagedArrayCollection.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bDirty bool   GeometryCollection/ManagedArrayCollection.h  
GroupInfo TMap< FName, FGroupInfo >   GeometryCollection/ManagedArrayCollection.h  
Map TMap< FKeyType, FValueType >   GeometryCollection/ManagedArrayCollection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TManagedArray< T > & AddAttribute ( FName Name,
FName Group,
FConstructionParameters Parameters
)

 Add an attribute of Type(T) to the group GeometryCollection/ManagedArrayCollection.h  

int32 AddElements ( int32 NumberElements,
FName Group
)

 Add elements to a group GeometryCollection/ManagedArrayCollection.h  

void AddExternalAttribute ( FName Name,
FName Group,
TManagedArray< T >& ValueIn,
FConstructionParameters Parameters
)

 Add an external attribute of Type(T) to the group for size management. GeometryCollection/ManagedArrayCollection.h  

void AddGroup ( FName Group
)

 Create a group on the collection. Adding attribute will also create unknown groups. GeometryCollection/ManagedArrayCollection.h  

virtual void Append ( const FManagedArrayCollection& Collection
)

 Append Collection and reindex dependencies on this collection. GeometryCollection/ManagedArrayCollection.h  

TArray< FName > AttributeNames ( FName Group
) const

 List all the attributes in a group names. GeometryCollection/ManagedArrayCollection.h  

const T * Cast ()

   GeometryCollection/ManagedArrayCollection.h  

T * Cast ()

   GeometryCollection/ManagedArrayCollection.h  

void CopyAttribute ( const FManagedArrayCollection& InCollection,
FName SrcName,
FName DestName,
FName SrcGroup,
FName DstGroup
)

 Copy an attribute from one group to another group. Will perform an implicit group sync. GeometryCollection/ManagedArrayCollection.h  

void CopyAttribute ( const FManagedArrayCollection& InCollection,
FName SrcName,
FName DestName,
FName Group
)

 Copy an attribute. Will perform an implicit group sync. GeometryCollection/ManagedArrayCollection.h  

void CopyAttribute ( const FManagedArrayCollection& InCollection,
FName Name,
FName Group
)

 Copy an attribute. GeometryCollection/ManagedArrayCollection.h  

void CopyMatchingAttributesFrom ( const FManagedArrayCollection& FromCollection,
const TArrayView< const FAttributeAndGroupId > SkipList
)

 Copy attributes that match the input collection. GeometryCollection/ManagedArrayCollection.h  

void CopyMatchingAttributesFrom ( const FManagedArrayCollection& InCollection,
const TMap< FName, TSet< FName > >* SkipList
)

 Copy attributes that match the input collection. This is a utility to easily sync collections GeometryCollection/ManagedArrayCollection.h  

void CopyTo ( FManagedArrayCollection* Collection,
const TArray< FName >& GroupsToSkip,
TArray< TTuple< FName, FName > > AttributesToSkip
) const

   GeometryCollection/ManagedArrayCollection.h  

void EmptyGroup ( FName Group
)

 Empty the group GeometryCollection/ManagedArrayCollection.h  

const TManagedArray< T > * FindAttribute ( FName Name,
FName Group
) const

   GeometryCollection/ManagedArrayCollection.h  

TManagedArray< T > * FindAttribute ( FName Name,
FName Group
)

 Returns attribute(Name) of Type(T) from the group GeometryCollection/ManagedArrayCollection.h  

const TManagedArray< T > * FindAttributeTyped ( FName Name,
FName Group
) const

   GeometryCollection/ManagedArrayCollection.h  

TManagedArray< T > * FindAttributeTyped ( FName Name,
FName Group
)

 Returns attribute(Name) of Type(T) from the group if and only if the types of T and the array match GeometryCollection/ManagedArrayCollection.h  

TManagedArray< T > * FindOrAddAttributeTyped ( FName Name,
FName Group,
FConstructionParameters Parameters
)

 Add an attribute of Type(T) to the group or find the existing attribute with the same name and type. GeometryCollection/ManagedArrayCollection.h  

SIZE_T GetAllocatedSize()

 Get allocated memory size GeometryCollection/ManagedArrayCollection.h  

const TManagedArray< T > & GetAttribute ( FName Name,
FName Group
) const

 Returns attribute access of Type(T) from the group GeometryCollection/ManagedArrayCollection.h  

EArrayType GetAttributeType ( FName Name,
FName Group
) const

 Return attribute type GeometryCollection/ManagedArrayCollection.h  

FName GetDependency ( FName Name,
FName Group
) const

 Return the group index dependency for the specified attribute. GeometryCollection/ManagedArrayCollection.h  

void GetElementSizeInfoForGroups ( TArray< TPair< FName, SIZE_T > >& OutSizeInfo
) const

 Get information on the total storage required for each element in each group GeometryCollection/ManagedArrayCollection.h  

TArray< FName > GroupNames()

 List all the group names. GeometryCollection/ManagedArrayCollection.h  

bool HasAttribute ( FName Name,
FName Group
) const

 Check for the existence of a attribute GeometryCollection/ManagedArrayCollection.h  

bool HasAttributes ( const TArray< FManagedType >& Types
) const

 Check for the existence of a attribute GeometryCollection/ManagedArrayCollection.h  

bool HasGroup ( FName Group
) const

 Check for the existence of a group GeometryCollection/ManagedArrayCollection.h  

int32 InsertElements ( int32 NumberElements,
int32 Position,
FName Group
)

 Insert elements to a group GeometryCollection/ManagedArrayCollection.h  

bool IsA()

   GeometryCollection/ManagedArrayCollection.h  

bool IsAttributeDirty ( FName Name,
FName Group
) const

 Check if an attribute is dirty GeometryCollection/ManagedArrayCollection.h  

bool IsAttributePersistent ( FName Name,
FName Group
) const

 Check if an attribute is persistent - ie its data will be serialized If the attribute does not exists this will return false GeometryCollection/ManagedArrayCollection.h  

virtual bool IsAType ( FName InTypeName
) const

   GeometryCollection/ManagedArrayCollection.h  

bool IsConnected ( FName StartingNode,
FName TargetNode
)

 Cycle Checking. Search for TargetNode from the StartingNode. GeometryCollection/ManagedArrayCollection.h  

bool IsDirty()

   GeometryCollection/ManagedArrayCollection.h  

bool IsEmpty()

 Whether the collection is ampty ( no group / no attributes ) GeometryCollection/ManagedArrayCollection.h  

void MakeClean()

   GeometryCollection/ManagedArrayCollection.h  

void MakeDirty()

 Updated for Render ( Mark it dirty ) question: is this the right place for this? GeometryCollection/ManagedArrayCollection.h  

virtual void MergeElements ( const FName& Group,
const TArray< int32 >& SortedMergeList,
const TArray< int32 >& MergeRemapIndex,
FProcessingParameters Params
)

 Merge the element indexed SortedMergeList[Idx] to the element indexed MergeRemapIndex[Idx] first redirect references of SortedMergeList[Idx] then delete GeometryCollection/ManagedArrayCollection.h  

TManagedArray< T > & ModifyAttribute ( FName Name,
FName Group
)

 Returns attribute access of Type(T) from the group for modification this will mark the collection dirty GeometryCollection/ManagedArrayCollection.h  

TManagedArray< T > * ModifyAttributeTyped ( FName Name,
FName Group
)

 Returns attribute access of Type(T) from the group for modification if and only if the types of T and the array match this will mark the collection dirty GeometryCollection/ManagedArrayCollection.h  

T * NewCopy()

 Duplicate the ManagedArrayCollection as the specified templated type GeometryCollection/ManagedArrayCollection.h  

int32 NumAttributes ( FName Group
) const

 Returns the number of attributes in a group. GeometryCollection/ManagedArrayCollection.h  

int32 NumElements ( FName Group
) const

 Number of elements in a group GeometryCollection/ManagedArrayCollection.h  

void RemoveAttribute ( FName Name,
FName Group
)

 Remove the attribute from the collection, and clear the memory. GeometryCollection/ManagedArrayCollection.h  

void RemoveDependencyFor ( FName Group
)

   GeometryCollection/ManagedArrayCollection.h  

virtual void RemoveElements ( const FName& Group,
const TArray< int32 >& SortedDeletionList,
FProcessingParameters Params
)

 Remove the element at index and reindex the dependent arrays GeometryCollection/ManagedArrayCollection.h  

virtual void RemoveElements ( const FName& Group,
int32 NumberElements,
int32 Position
)

 Remove the elements at Position and reindex the dependent arrays GeometryCollection/ManagedArrayCollection.h  

void RemoveGroup ( FName Group
)

 Remove the group from the collection. GeometryCollection/ManagedArrayCollection.h  

virtual void ReorderElements ( FName Group,
const TArray< int32 >& NewOrder
)

 Reorders elements in a group. NewOrder must be the same length as the group. GeometryCollection/ManagedArrayCollection.h  

void Reserve ( int32 Size,
FName Group
)

 Reserve a group GeometryCollection/ManagedArrayCollection.h  

virtual void Reset()

 Clear the internal data. GeometryCollection/ManagedArrayCollection.h  

void Resize ( int32 Size,
FName Group
)

 Resize a group GeometryCollection/ManagedArrayCollection.h  

bool Serialize ( FArchive& Ar
)

   GeometryCollection/ManagedArrayCollection.h  

virtual void Serialize ( Chaos::FChaosArchive& Ar
)

 Serialize GeometryCollection/ManagedArrayCollection.h  

void SetDependency ( FName Name,
FName Group,
FName DependencyGroup,
bool bAllowCircularDependency
)

   GeometryCollection/ManagedArrayCollection.h  

FString ToString()

 Dump the contents to a FString GeometryCollection/ManagedArrayCollection.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void MatchOptionalDefaultAttributes ( const FManagedArrayCollection& InCollection
)

 Virtual helper function called by CopyMatchingAttributesFrom; adds attributes 'default, but optional' attributes that are present in InCollection This is used by FGeometryCollection to make sure all UV layers are copied over by CopyMatchingAttributesFrom() GeometryCollection/ManagedArrayCollection.h  

virtual void SetDefaults ( FName Group,
uint32 StartSize,
uint32 NumElements
)

   GeometryCollection/ManagedArrayCollection.h  

void SyncGroupSizeFrom ( const FManagedArrayCollection& InCollection,
FName Group
)

 Size and order a group so that it matches the group found in the input collection. GeometryCollection/ManagedArrayCollection.h  

void SyncGroupSizeFrom ( const FManagedArrayCollection& InCollection,
FName SrcGroup,
FName DstGroup
)

 Size and order a dstgroup so that it matches the srcgroup found in the input collection. GeometryCollection/ManagedArrayCollection.h  

Static

Name Remarks Include Path Unreal Specifiers

static FKeyType MakeMapKey ( FName Name,
FName Group
)

   GeometryCollection/ManagedArrayCollection.h  

static FName StaticType()

 Type name for this class. GeometryCollection/ManagedArrayCollection.h  

Operators

Name Remarks Include Path Unreal Specifiers
  GeometryCollection/ManagedArrayCollection.h  
  GeometryCollection/ManagedArrayCollection.h  

bool operator== ( const FManagedArrayCollection& Other
) const

   GeometryCollection/ManagedArrayCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page