URigVMMemoryStorageGeneratorClass | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/RigVM

The URigVMMemoryStorageGeneratorClass is used to create / represent heterogeneous memory storages. The generator can produce a UClass which contains a series of properties. This UClass is then used to instantiate URigVMMemoryStorage objects to be consumed by the RigVM. The memory storage objects can contain the literals / constant values used by the virtual machine or work state.


Name	URigVMMemoryStorageGeneratorClass
Type	class
Header File	/Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryStorage.h
Include Path	#include "RigVMCore/RigVMMemoryStorage.h"

Syntax

UCLASS (MinimalAPI)  
class URigVMMemoryStorageGeneratorClass : public UClass

Inheritance Hierarchy

FStructBaseChain → UStruct → UClass → URigVMMemoryStorageGeneratorClass
UObjectBase → UObjectBaseUtility → UObject → UField → UStruct → UClass → URigVMMemoryStorageGeneratorClass

Constructors

Name	Remarks	Include Path	Unreal Specifiers
URigVMMemoryStorageGeneratorClass()	Default constructor.	RigVMCore/RigVMMemoryStorage.h

Typedefs

Name	Type	Remarks	Include Path
WithinClass	class UObject	DECLARE_WITHIN(UObject) is only kept for back-compat, please don't parent the class to the asset object.	RigVMCore/RigVMMemoryStorage.h

Variables

Protected

Name	Type	Remarks	Include Path
CachedMemoryHash	uint32		RigVMCore/RigVMMemoryStorage.h
LinkedProperties	TArray< const FProperty * >	A cached list of all linked properties (created by RefreshLinkedProperties)	RigVMCore/RigVMMemoryStorage.h
MemoryType	ERigVMMemoryType	The type of memory of this class.	RigVMCore/RigVMMemoryStorage.h
PropertyPathDescriptions	TArray< FRigVMPropertyPathDescription >	A list of decriptions for the property paths - used for serialization.	RigVMCore/RigVMMemoryStorage.h
PropertyPaths	TArray< FRigVMPropertyPath >	A cached list of all property paths (created by RefreshPropertyPaths)	RigVMCore/RigVMMemoryStorage.h

Functions

Public

Name	Remarks	Include Path
uint32 GetMemoryHash()	Returns a hash of unique to the configuration of the memory.	RigVMCore/RigVMMemoryStorage.h
ERigVMMemoryType GetMemoryType()	Returns the type of memory of this class (literal, work, etc)	RigVMCore/RigVMMemoryStorage.h
const TArray< const FProperty * > & GetProperties()	The properties stored within this class.	RigVMCore/RigVMMemoryStorage.h
const FRigVMPropertyPathDescription * GetPropertyPathDescriptionByIndex ( int32 Index ) const		RigVMCore/RigVMMemoryStorage.h
const TArray< FRigVMPropertyPath > & GetPropertyPaths()	The property paths stored within this class.	RigVMCore/RigVMMemoryStorage.h
FRigVMMemoryStatistics GetStatistics()	Returns the statistics information	RigVMCore/RigVMMemoryStorage.h
bool IsValidPropertyPathDescriptionIndex ( int32 Index ) const		RigVMCore/RigVMMemoryStorage.h
void RefreshLinkedProperties()		RigVMCore/RigVMMemoryStorage.h
void RefreshPropertyPaths()		RigVMCore/RigVMMemoryStorage.h

Overridden from UClass

Name	Remarks	Include Path	Unreal Specifiers
virtual void PurgeClass ( bool bRecompilingOnLoad )		RigVMCore/RigVMMemoryStorage.h

Overridden from UStruct

Name	Remarks	Include Path	Unreal Specifiers
virtual void Link ( FArchive& Ar, bool bRelinkExistingProperties )		RigVMCore/RigVMMemoryStorage.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostLoad()		RigVMCore/RigVMMemoryStorage.h
virtual void Serialize ( FArchive& Ar )		RigVMCore/RigVMMemoryStorage.h

Static

Name	Remarks	Include Path
static FProperty * AddProperty ( URigVMMemoryStorageGeneratorClass* InClass, const FRigVMPropertyDescription& InProperty, FField::FLinkedListBuilder& PropertyListBuilder )	Adds a single property to a class.	RigVMCore/RigVMMemoryStorage.h
static URigVMMemoryStorageGeneratorClass * CreateStorageClass ( UObject* InOuter, ERigVMMemoryType InMemoryType, const TArray< FRigVMPropertyDescription >& InProperties, const TArray< FRigVMPropertyPathDescription >& InPropertyPaths )	Creates a new class provided a list of properties and property paths	RigVMCore/RigVMMemoryStorage.h
static const FString & GetClassName ( ERigVMMemoryType InMemoryType )	Returns the name of a storage class for a given memory type. The name is unique within the package.	RigVMCore/RigVMMemoryStorage.h
static URigVMMemoryStorageGeneratorClass * GetStorageClass ( UObject* InOuter, ERigVMMemoryType InMemoryType )	Returns an existing class for a memory type within the package (or nullptr)	RigVMCore/RigVMMemoryStorage.h
static bool RemoveStorageClass ( UObject* InOuter, ERigVMMemoryType InMemoryType )	Removes an existing storage class	RigVMCore/RigVMMemoryStorage.h

Navigation