URigVMMemoryStorage

The [URigVMMemoryStorage](API\Runtime\RigVM\RigVMCore\URigVMMemoryStorage) represents an instance of heterogeneous memory.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

URigVMMemoryStorage

References

Module

RigVM

Header

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

Include

#include "RigVMCore/RigVMMemoryStorage.h"

Syntax

class URigVMMemoryStorage : public UObject

Remarks

The URigVMMemoryStorage represents an instance of heterogeneous memory. The memory layout is defined by the URigVMMemoryStorageGeneratorClass.

Functions

Name Description

Public function Static

bool

 

CopyProperty

(
    URigVMMemoryStorage* InTargetS...,
    int32 InTargetPropertyIndex,
    const FRigVMPropertyPath& InTarget...,
    URigVMMemoryStorage* InSourceS...,
    int32 InSourcePropertyIndex,
    const FRigVMPropertyPath& InSource...
)

Copies the content of a source property and memory into the memory of a target property.

Public function Static

bool

 

CopyProperty

(
    const FProperty* InTargetPrope...,
    uint8* InTargetPtr,
    const FRigVMPropertyPath& InTarget...,
    const FProperty* InSourcePrope...,
    const uint8* InSourcePtr,
    const FRigVMPropertyPath& InSource...
)

Copies the content of a source property and memory into the memory of a target property.

Public function Static

bool

 

CopyProperty

(
    const FProperty* InTargetPrope...,
    uint8* InTargetPtr,
    const FProperty* InSourcePrope...,
    const uint8* InSourcePtr
)

Copies the content of a source property and memory into the memory of a target property

Public function Static

bool

 

CopyProperty

(
    FRigVMMemoryHandle& InTargetHandle,
    FRigVMMemoryHandle& InSourceHandle
)

Copies the content of a source property and memory into the memory of a target property.

Public function Const

FProperty &#...

 

FindPropertyByName

(
    const FName& InName
)

Returns a property given its name (or nullptr if the name wasn't found)

Public function

T *

 

GetData

(
    int32 InPropertyIndex,
    const FRigVMPropertyPath& InProper...
)

Returns the memory for a property given its index and a matching property path.

Public function

T *

 

GetData

(
    const FRigVMOperand& InOperand
)

Returns the memory for a property (and optionally a property path) given an operand.

Public function

T *

 

GetData

(
    int32 InPropertyIndex
)

Returns the memory for a property given its index.

Public function

FString

 

GetDataAsString

(
    int32 InPropertyIndex,
    int32 PortFlags
)

Returns the exported text for a given property index.

Public function

FString

 

GetDataAsString

(
    const FRigVMOperand& InOperand,
    int32 PortFlags
)

Returns the exported text for a given operand.

Public function

FString

 

GetDataAsStringByName

(
    const FName& InName,
    int32 PortFlags
)

Returns the exported text for given property name.

Public function

FString

 

GetDataAsStringByNameSafe

(
    const FName& InName,
    int32 PortFlags
)

Returns the exported text for given property name.

Public function

FString

 

GetDataAsStringSafe

(
    int32 InPropertyIndex,
    int32 PortFlags
)

Returns the exported text for a given property index.

Public function

FString

 

GetDataAsStringSafe

(
    const FRigVMOperand& InOperand,
    int32 PortFlags
)

Returns the exported text for a given operand.

Public function

T *

 

GetDataByName

(
    const FName& InName,
    const FRigVMPropertyPath& InProper...
)

Returns the memory for a property given its name and a matching property path (or nullptr)

Public function

T *

 

GetDataByName

(
    const FName& InName
)

Returns the memory for a property given its name (or nullptr)

Public function

FRigVMMemory...

 

GetHandle

(
    int32 InPropertyIndex,
    const FRigVMPropertyPath* InPr...
)

Returns the handle for a given property by index (and optionally property path)

Public function

FRigVMMemory...

 

GetHandleByName

(
    const FName& InName,
    const FRigVMPropertyPath* InPr...
)

Returns the handle for a given property by name (and optionally property path)

Public function Const

ERigVMMemory...

 

GetMemoryType()

Memory Access.

Public function Const

FRigVMOperan...

 

GetOperand

(
    int32 InPropertyIndex,
    int32 InPropertyPathIndex
)

Creates and returns a new operand for a property (and optionally a property path)

Public function Const

FRigVMOperan...

 

GetOperandByName

(
    const FName& InName,
    int32 InPropertyPathIndex
)

Creates and returns a new operand for a property (and optionally a property path)

Public function Const

const TArray...

 

GetProperties()

Returns the properties provided by this instance.

Public function Const

const FPrope...

 

GetProperty

(
    int32 InPropertyIndex
)

Returns a property given its index.

Public function Const

int32

 

GetPropertyIndex

(
    const FProperty* InProperty
)

Returns the index of a property given the property itself.

Public function Const

int32

 

GetPropertyIndexByName

(
    const FName& InName
)

Returns the index of a property given its name.

Public function Const

const TArray...

 

GetPropertyPaths()

Returns the property paths provided by this instance.

Public function

T &

 

GetRef

(
    int32 InPropertyIndex,
    const FRigVMPropertyPath& InProper...
)

Returns the ref of an element stored at a given property index and a property path.

Public function

T &

 

GetRef

(
    int32 InPropertyIndex
)

Returns the ref of an element stored at a given property index.

Public function

T &

 

GetRef

(
    const FRigVMOperand& InOperand
)

Returns the ref of an element stored for a given operand.

Public function

T &

 

GetRefByName

(
    const FName& InName,
    const FRigVMPropertyPath& InProper...
)

Returns the ref of an element stored at a given property name and a property path (throws if name is invalid)

Public function

T &

 

GetRefByName

(
    const FName& InName
)

Returns the ref of an element stored at a given property name (throws if name is invalid)

Public function Const

FRigVMMemory...

 

GetStatistics()

Returns the statistics information

Public function Const

bool

 

IsArray

(
    int32 InPropertyIndex
)

Returns true if the property at a given index is a TArray.

Public function Const

bool

 

IsMap

(
    int32 InPropertyIndex
)

Returns true if the property at a given index is a TMap.

Public function Const

bool

 

IsValidIndex

(
    int32 InIndex
)

Returns true if a provided property index is valid.

Public function Const

int32

 

Num()

Returns the number of properties stored in this instance.

Public function

bool

 

SetDataFromString

(
    int32 InPropertyIndex,
    const FString& InValue
)

Sets the content of a property by index given an exported string. Returns true if succeeded.

Public function

bool

 

SetDataFromStringByName

(
    const FName& InName,
    const FString& InValue
)

Sets the content of a property by name given an exported string. Returns true if succeeded.

Constants