1. Epic GamesDeveloper
  3. FManagedArrayCollection

FManagedArrayCollection

ManagedArrayCollection

Unreal Engine C++ API Reference > Runtime > Chaos > GeometryCollection

Inheritance Hierarchy

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/ManagedArrayCollection.h
Include #include "GeometryCollection/ManagedArrayCollection.h"

Syntax

struct FManagedArrayCollection

Remarks

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 }

Variables

  Type Name Description
Public variable friend FSimulationProperties  
Protected variable int32 Version Version to indicate need for conditioning to current expected data layout during serialization loading.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TManagedArray< T > &

AddAttribute ( FName Name,
FName Group,
FConstructionParameters Parameters
)

 Add an attribute of Type(T) to the group
Public function int32

AddElements ( int32 NumberElements,
FName Group
)

 Add elements to a group
Public function void

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

 Add an external attribute of Type(T) to the group for size management.
Public function void

AddGroup ( FName Group
)

 Create a group on the collection. Adding attribute will also create unknown groups.
Public function Virtual void

Append ( const FManagedArrayCollection& Collection
)

 Append Collection and reindex dependencies on this collection.
Public function Const TArray< FName >

AttributeNames ( FName Group
)

 List all the attributes in a group names.
Public function Const const T *

Cast ()

  
Public function T *

Cast ()

  
Public function void

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

 Copy an attribute. Will perform an implicit group sync.
Public function void

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

 Copy an attribute.
Public function 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
Public function Const void

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

  
Public function void

EmptyGroup ( FName Group
)

 Empty the group
Public function TManagedArray< T > *

FindAttribute ( FName Name,
FName Group
)

 Returns attribute(Name) of Type(T) from the group
Public function Const const TManagedArray< T > *

FindAttribute ( FName Name,
FName Group
)

  
Public function 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
Public function Const const TManagedArray< T > *

FindAttributeTyped ( FName Name,
FName Group
)

  
Public function Const SIZE_T Get allocated memory size
Public function Const EArrayType

GetAttributeType ( FName Name,
FName Group
)

 Return attribute type
Public function Const void

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

 Get information on the total storage required for each element in each group
Public function Const TArray< FName > List all the group names.
Public function Const bool

HasAttribute ( FName Name,
FName Group
)

 Check for the existence of a attribute
Public function Const bool

HasAttributes ( const TArray< FManagedType >& Types
)

 Check for the existence of a attribute
Public function Const bool

HasGroup ( FName Group
)

 Check for the existence of a group
Public function int32

InsertElements ( int32 NumberElements,
int32 Position,
FName Group
)

 Insert elements to a group
Public function bool

IsA ()

  
Public function Const bool

IsAttributeDirty ( FName Name,
FName Group
)

 Check if an attribute is dirty
Public function Const bool Check if an attribute is persistent - ie its data will be serialized If the attribute does not exists this will return false
Public function Virtual Const bool

IsAType ( FName InTypeName
)

  
Public function bool

IsConnected ( FName StartingNode,
FName TargetNode
)

 Cycle Checking. Search for TargetNode from the StartingNode.
Public function Const bool

IsDirty ()

  
Public function void  
Public function void Updated for Render ( Mark it dirty ) question: is this the right place for this?
Protected function Virtual void 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()
Public function TManagedArray< T > &

ModifyAttribute ( FName Name,
FName Group
)

 Returns attribute access of Type(T) from the group for modification this will mark the collection dirty
Public function Const T *

NewCopy ()

 Duplicate the ManagedArrayCollection as the specified templated type
Public function Const int32

NumAttributes ( FName Group
)

 Returns the number of attributes in a group.
Public function Const int32

NumElements ( FName Group
)

 Number of elements in a group
Public function void

RemoveAttribute ( FName Name,
FName Group
)

 Remove the attribute from the collection.
Public function void  
Public function Virtual void

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

 Remove the elements at Position and reindex the dependent arrays
Public function Virtual void

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

 Remove the element at index and reindex the dependent arrays
Public function void

RemoveGroup ( FName Group
)

 Remove the group from the collection.
Public function Virtual void

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

 Reorders elements in a group. NewOrder must be the same length as the group.
Public function void

Reserve ( int32 Size,
FName Group
)

 Reserve a group
Public function Virtual void

Reset ()

 Clear the internal data.
Public function void

Resize ( int32 Size,
FName Group
)

 Resize a group
Public function Virtual void Serialize
Protected function Virtual void

SetDefaults ( FName Group,
uint32 StartSize,
uint32 NumElements
)

  
Public function void

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

  
Public function Static FName Type name for this class.
Protected function void

SyncGroupSizeFrom ( const FManagedArrayCollection& InCollection,
FName Group
)

 Size and order a group so that it matches the group found in the input collection.
Public function Const FString Dump the contents to a FString

Operators

  Type Name Description
Public function FManagedArrayCollection &  
Public function FManagedArrayCollection &  

Classes

  Type Name Description
Public struct FConstructionParameters    
Public struct FManagedType    
Public struct FProcessingParameters    
Public struct TManagedType    

Typedefs

Name Description
EArrayType  
FKeyType  

Constants

Name Description
Invalid  

Deprecated Functions

  Type Name Description
Public function Const const TManagedArray< T > &

GetAttribute ( FName Name,
FName Group
)

 non const GetAttribute() version is now deprecated, use ModifyAttribute instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page