1. Epic GamesDeveloper
  3. FRigVMMemoryContainer

FRigVMMemoryContainer

The [FRigVMMemoryContainer](API\Plugins\RigVM\RigVMCore\FRigVMMemoryContainer) provides a heterogeneous memory container to store arbitrary data.

API > API/Plugins > API/Plugins/RigVM > API/Plugins/RigVM/RigVMCore

References

   
Module RigVM
Header /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryDeprecated.h
Include #include "RigVMCore/RigVMMemoryDeprecated.h"

Syntax

USTRUCT ()  
struct FRigVMMemoryContainer

Remarks

The FRigVMMemoryContainer provides a heterogeneous memory container to store arbitrary data. Each element stored can be referred to using a FRigVMRegister. Elements can be accessed by index (index of the register), FRigVMOperand or by name. Name access is optional and is specified upon construction of the container. The memory container provides a series of templated functions to add and get data.

For example: int32 Index = Container.Add(4.f); float& ValueRef = Container.GetRef(Index);

This can also be done with arrays: TArray MyArray = {3.f, 4.f, 5.f}; int32 Index = Container.AddFixedArray(MyArray); FRigVMFixedArray ArrayView = Container.GetFixedArray(Index);

Registers can store dynamically resizable memory as well by reyling on indirection.

Arrays with a single slice are going to be stored as a FRigVMByteArray, [unit8], so for example for a float array in C++ it would be (TArray Param). Single values with multiple slices are also going to be stored as a FRigVMByteArray, [unit8], so for example for a float array in C++ it would be (float Param). Arrays with multiple slices are going to be stored as a FRigVMNestedByteArray, [[unit8]], so for example for a float array in C++ it would be (TArray Param).

Variables

  Type Name Description
Public variable UProperty Transient bool bEncounteredErrorDuringLoad  
Public variable UProperty bool bUseNameMap  
Public variable UProperty Transient TArray< uint8 > Data  
Public variable UProperty ERigVMMemoryType MemoryType  
Public variable UProperty Transient TMap< FName, int32 > NameMap  
Public variable UProperty TArray< FRigVMRegisterOffset > RegisterOffsets  
Public variable UProperty TArray< FRigVMRegister > Registers  
Public variable UProperty Transient TArray< TObjectPtr< UScriptStruct > > ScriptStructs  

Constructors

  Type Name Description
Public function  

FRigVMMemoryContainer ( bool bInUseNames
)

  
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function int32

Allocate ( const FName& InNewName,
int32 InElementSize,
int32 InElementCount,
int32 InSliceCount,
const uint8* InDataPtr,
bool bUpdateRegisters
)

 Allocates a new named register.
Public function int32

Allocate ( int32 InElementSize,
int32 InElementCount,
int32 InSliceCount,
const uint8* InDataPtr,
bool bUpdateRegisters
)

 Allocates a new unnamed register.
Public function Const TArray< FRigVMRegister >::RangedForConstIteratorType

begin ()

  
Public function TArray< FRigVMRegister >::RangedForIteratorType

begin ()

  
Public function bool

Construct ( int32 InRegisterIndex,
int32 InElementIndex,
int32 InSliceIndex
)

 Performs optional construction of data within a struct register.
Public function bool  
Public function bool

Destroy ( int32 InRegisterIndex,
int32 InElementIndex,
int32 InSliceIndex
)

 Performs optional destruction of data within a struct register.
Public function void

Empty ()

 Resets the container and removes all storage.
Public function Const TArray< FRigVMRegister >::RangedForConstIteratorType

end ()

  
Public function TArray< FRigVMRegister >::RangedForIteratorType

end ()

  
Public function int32

FindOrAddScriptStruct ( UScriptStruct* InScriptStruct
)

 Ensures to add a script struct to the internal map if needed.
Public function Const int32

GetIndex ( const FName& InName
)

 Returns the index of a register based on the register name.
Public function Const ERigVMMemoryType Returns the memory type of this container
Public function FRigVMOperand

GetOperand ( int32 InRegisterIndex,
int32 InRegisterOffset
)

 Returns an argument for a given register.
Public function FRigVMOperand

GetOperand ( int32 InRegisterIndex,
const FString& InSegmentPath,
int32 InArrayElement
)

 Returns an argument for a given register.
Public function int32

GetOrAddRegisterOffset ( int32 InRegisterIndex,
UScriptStruct* InScriptStruct,
const FString& InSegmentPath,
int32 InInitialOffset,
int32 InElementSize
)

 Adds a register path and returns its index.
Public function int32

GetOrAddRegisterOffset ( int32 InRegisterIndex,
int32 InArrayElement
)

 Adds a register path and returns its index.
Public function int32

GetOrAddRegisterOffset ( int32 InRegisterIndex,
const FString& InSegmentPath,
int32 InArrayElement
)

 Adds a register path and returns its index.
Public function Const const FRigVMRegister &

GetRegister ( const FName& InName
)

 Const accessor for a register based on a a name. note: only works if SupportsNames() == true
Public function Const const FRigVMRegister &

GetRegister ( const FRigVMOperand& InArg
)

 Const accessor for a register based on an argument
Public function FRigVMRegister &

GetRegister ( const FName& InName
)

 Accessor for a register based on a a name. note: only works if SupportsNames() == true
Public function FRigVMRegister &

GetRegister ( const FRigVMOperand& InArg
)

 Accessor for a register based on an argument
Public function FRigVMRegister &

GetRegister ( int32 InIndex
)

 Accessor for a register based on index
Public function Const const FRigVMRegister &

GetRegister ( int32 InIndex
)

 Const accessor for a register based on index
Public function Const UScriptStruct *

GetScriptStruct ( int32 InRegisterIndex,
int32 InRegisterOffset
)

 Returns the script struct used for a given register index (can be nullptr for non-struct-registers).
Public function Const UScriptStruct *

GetScriptStruct ( const FRigVMRegister& Register
)

 Returns the script struct used for a given register (can be nullptr for non-struct-registers).
Public function Const bool

IsNameAvailable ( const FName& InPotentialNewName
)

 Returns true if a given name is available for a new register.
Public function void

Load ( FArchive& Ar
)

  
Public function Const int32

Num ()

 Returns the number of registers in this container
Public function void

Reset ()

 Resets the container but maintains storage.
Public function void

Save ( FArchive& Ar
)

  
Public function void

Serialize ( FArchive& Ar
)

  
Public function void

SetMemoryType ( ERigVMMemoryType InMemoryType
)

 Sets the memory type. should only be used when the container is empty
Public function Const bool Returns true if this container supports name based lookup
Public function void Updates internal data for topological changes.

Operators

  Type Name Description
Public function Const const FRigVMRegister &

operator[] ( const FRigVMOperand& InArg
)

 Const accessor for a register based on an argument
Public function FRigVMRegister &

operator[] ( int32 InIndex
)

 Accessor for a register based on index
Public function Const const FRigVMRegister &

operator[] ( int32 InIndex
)

 Const accessor for a register based on index
Public function FRigVMRegister &

operator[] ( const FRigVMOperand& InArg
)

 Accessor for a register based on an argument
Public function FRigVMRegister &

operator[] ( const FName& InName
)

 Accessor for a register based on a a name. note: only works if SupportsNames() == true
Public function Const const FRigVMRegister &

operator[] ( const FName& InName
)

 Const accessor for a register based on a a name. note: only works if SupportsNames() == true
Public function FRigVMMemoryContainer &

operator= ( const FRigVMMemoryContainer& InOther
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page