URigVMMemoryStorageGeneratorClass

The [URigVMMemoryStorageGeneratorClass](API\Runtime\RigVM\RigVMCore\URigVMMemoryStorageGeneratorClas-) is used to create / represent heterogeneous memory storages.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UField

UStruct

UClass

URigVMMemoryStorageGeneratorClass

References

Module

RigVM

Header

/Engine/Source/Runtime/RigVM/Public/RigVMCore/RigVMMemoryStorage.h

Include

#include "RigVMCore/RigVMMemoryStorage.h"

Syntax

class URigVMMemoryStorageGeneratorClass : public UClass

Remarks

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.

Constructors

Name Description

Public function

URigVMMemoryStorageGeneratorClass()

Default constructor.

Functions

Name Description

Protected function Static

FProperty &#...

 

AddProperty

(
    URigVMMemoryStorageGeneratorClass&...,
    const FRigVMPropertyDescription& I...,
    FField** LinkToProperty
)

Adds a single property to a class.

Public function Static

URigVMMemory...

 

CreateStorageClass

(
    UObject* InOuter,
    ERigVMMemoryType InMemoryType,
    const TArray< FRigVMPropertyDescrip...,
    const TArray< FRigVMPropertyPathDes...
)

Creates a new class provided a list of properties and property paths

Public function Static

const FStrin...

 

GetClassName

(
    ERigVMMemoryType InMemoryType
)

Returns the name of a storage class for a given memory type. The name is unique within the package.

Public function Const

ERigVMMemory...

 

GetMemoryType()

Returns the type of memory of this class (literal, work, etc)

Public function Const

const TArray...

 

GetProperties()

The properties stored within this class.

Public function Const

const TArray...

 

GetPropertyPaths()

The property paths stored within this class.

Public function Const

FRigVMMemory...

 

GetStatistics()

Returns the statistics information

Public function Static

URigVMMemory...

 

GetStorageClass

(
    UObject* InOuter,
    ERigVMMemoryType InMemoryType
)

Returns an existing class for a memory type within the package (or nullptr)

Public function

void

 

RefreshLinkedProperties()

Public function

void

 

RefreshPropertyPaths()

Public function Static

bool

 

RemoveStorageClass

(
    UObject* InOuter,
    ERigVMMemoryType InMemoryType
)

Removes an existing storage class

Overridden from UClass

Name Description

Public function Virtual

void

 

PurgeClass

(
    bool bRecompilingOnLoad
)

Purges out the properties of this class in preparation for it to be regenerated

Overridden from UStruct

Name Description

Public function Virtual

void

 

Link

(
    FArchive& Ar,
    bool bRelinkExistingProperties
)

Creates the field/property links and gets structure ready for use at runtime

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.