1. Epic GamesDeveloper
  3. URigVMMemoryStorage

URigVMMemoryStorage

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

API > API/Plugins > API/Plugins/RigVM

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

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

Syntax

UCLASS (MinimalAPI)  
class URigVMMemoryStorage : public UObject

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
EmptyProperties const TArray< const FProperty * >   RigVMCore/RigVMMemoryStorage.h
EmptyPropertyPaths const TArray< FRigVMPropertyPath >   RigVMCore/RigVMMemoryStorage.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CopyFrom ( URigVMMemoryStorage* InSourceMemory
)

   RigVMCore/RigVMMemoryStorage.h  

FProperty * FindPropertyByName ( const FName& InName
) const

 Returns a property given its name (or nullptr if the name wasn't found) RigVMCore/RigVMMemoryStorage.h  

T * GetData ( int32 InPropertyIndex,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the memory for a property given its index and a matching property path. RigVMCore/RigVMMemoryStorage.h  

T * GetData ( const FRigVMOperand& InOperand
)

 Returns the memory for a property (and optionally a property path) given an operand. RigVMCore/RigVMMemoryStorage.h  

T * GetData ( int32 InPropertyIndex
)

 Returns the memory for a property given its index. RigVMCore/RigVMMemoryStorage.h  

FString GetDataAsString ( int32 InPropertyIndex,
int32 PortFlags
)

 Returns the exported text for a given property index. RigVMCore/RigVMMemoryStorage.h  

FString GetDataAsString ( const FRigVMOperand& InOperand,
int32 PortFlags
)

 Returns the exported text for a given operand. RigVMCore/RigVMMemoryStorage.h  

FString GetDataAsStringByName ( const FName& InName,
int32 PortFlags
)

 Returns the exported text for given property name. RigVMCore/RigVMMemoryStorage.h  

FString GetDataAsStringByNameSafe ( const FName& InName,
int32 PortFlags
)

 Returns the exported text for given property name. RigVMCore/RigVMMemoryStorage.h  

FString GetDataAsStringSafe ( const FRigVMOperand& InOperand,
int32 PortFlags
)

 Returns the exported text for a given operand. RigVMCore/RigVMMemoryStorage.h  

FString GetDataAsStringSafe ( int32 InPropertyIndex,
int32 PortFlags
)

 Returns the exported text for a given property index. RigVMCore/RigVMMemoryStorage.h  

T * GetDataByName ( const FName& InName,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the memory for a property given its name and a matching property path (or nullptr) RigVMCore/RigVMMemoryStorage.h  

T * GetDataByName ( const FName& InName
)

 Returns the memory for a property given its name (or nullptr) RigVMCore/RigVMMemoryStorage.h  

FRigVMMemoryHandle GetHandle ( int32 InPropertyIndex,
const FRigVMPropertyPath* InPropertyPath
)

 Returns the handle for a given property by index (and optionally property path) RigVMCore/RigVMMemoryStorage.h  

FRigVMMemoryHandle GetHandleByName ( const FName& InName,
const FRigVMPropertyPath* InPropertyPath
)

 Returns the handle for a given property by name (and optionally property path) RigVMCore/RigVMMemoryStorage.h  

uint32 GetMemoryHash()

 Returns a hash of unique to the configuration of the memory. RigVMCore/RigVMMemoryStorage.h  
Memory Access. RigVMCore/RigVMMemoryStorage.h  

FRigVMOperand GetOperand ( int32 InPropertyIndex,
int32 InPropertyPathIndex
) const

 Creates and returns a new operand for a property (and optionally a property path) RigVMCore/RigVMMemoryStorage.h  

FRigVMOperand GetOperandByName ( const FName& InName,
int32 InPropertyPathIndex
) const

 Creates and returns a new operand for a property (and optionally a property path) RigVMCore/RigVMMemoryStorage.h  

const TArray< const FProperty * > & GetProperties()

 Returns the properties provided by this instance. RigVMCore/RigVMMemoryStorage.h  

const FProperty * GetProperty ( int32 InPropertyIndex
) const

 Returns a property given its index. RigVMCore/RigVMMemoryStorage.h  

int32 GetPropertyIndex ( const FProperty* InProperty
) const

 Returns the index of a property given the property itself. RigVMCore/RigVMMemoryStorage.h  

int32 GetPropertyIndexByName ( const FName& InName
) const

 Returns the index of a property given its name. RigVMCore/RigVMMemoryStorage.h  

const TArray< FRigVMPropertyPath > & GetPropertyPaths()

 Returns the property paths provided by this instance. RigVMCore/RigVMMemoryStorage.h  

T & GetRef ( const FRigVMOperand& InOperand
)

 Returns the ref of an element stored for a given operand. RigVMCore/RigVMMemoryStorage.h  

T & GetRef ( int32 InPropertyIndex
)

 Returns the ref of an element stored at a given property index. RigVMCore/RigVMMemoryStorage.h  

T & GetRef ( int32 InPropertyIndex,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the ref of an element stored at a given property index and a property path. RigVMCore/RigVMMemoryStorage.h  

T & GetRefByName ( const FName& InName,
const FRigVMPropertyPath& InPropertyPath
)

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

T & GetRefByName ( const FName& InName
)

 Returns the ref of an element stored at a given property name (throws if name is invalid) RigVMCore/RigVMMemoryStorage.h  

FRigVMMemoryStatistics GetStatistics()

 Returns the statistics information RigVMCore/RigVMMemoryStorage.h  

bool IsArray ( int32 InPropertyIndex
) const

 Returns true if the property at a given index is a TArray. RigVMCore/RigVMMemoryStorage.h  

bool IsMap ( int32 InPropertyIndex
) const

 Returns true if the property at a given index is a TMap. RigVMCore/RigVMMemoryStorage.h  

bool IsValidIndex ( int32 InIndex
) const

 Returns true if a provided property index is valid. RigVMCore/RigVMMemoryStorage.h  

int32 Num()

 Returns the number of properties stored in this instance. RigVMCore/RigVMMemoryStorage.h  

bool SetDataFromString ( int32 InPropertyIndex,
const FString& InValue
)

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

bool SetDataFromStringByName ( const FName& InName,
const FString& InValue
)

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

Static

Name Remarks Include Path Unreal Specifiers

static bool CopyProperty ( URigVMMemoryStorage* InTargetStorage,
int32 InTargetPropertyIndex,
const FRigVMPropertyPath& InTargetPropertyPath,
URigVMMemoryStorage* InSourceStorage,
int32 InSourcePropertyIndex,
const FRigVMPropertyPath& InSourcePropertyPath
)

 Copies the content of a source property and memory into the memory of a target property. RigVMCore/RigVMMemoryStorage.h  

static bool CopyProperty ( const FProperty* InTargetProperty,
uint8* InTargetPtr,
const FRigVMPropertyPath& InTargetPropertyPath,
const FProperty* InSourceProperty,
const uint8* InSourcePtr,
const FRigVMPropertyPath& InSourcePropertyPath
)

 Copies the content of a source property and memory into the memory of a target property. RigVMCore/RigVMMemoryStorage.h  

static bool CopyProperty ( const FProperty* InTargetProperty,
uint8* InTargetPtr,
const FProperty* InSourceProperty,
const uint8* InSourcePtr
)

 Copies the content of a source property and memory into the memory of a target property RigVMCore/RigVMMemoryStorage.h  

static bool CopyProperty ( FRigVMMemoryHandle& InTargetHandle,
FRigVMMemoryHandle& InSourceHandle
)

 Copies the content of a source property and memory into the memory of a target property. RigVMCore/RigVMMemoryStorage.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page