Navigation
API > API/Plugins > API/Plugins/RigVM
| Name | FRigVMMemoryStorageStruct |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryStorageStruct.h |
| Include Path | #include "RigVMCore/RigVMMemoryStorageStruct.h" |
Syntax
USTRUCT ()
struct FRigVMMemoryStorageStruct : public FInstancedPropertyBag
Inheritance Hierarchy
- FInstancedPropertyBag → FRigVMMemoryStorageStruct
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMMemoryStorageStruct
(
ERigVMMemoryType InMemoryType |
RigVMCore/RigVMMemoryStorageStruct.h | ||
FRigVMMemoryStorageStruct
(
ERigVMMemoryType InMemoryType, |
RigVMCore/RigVMMemoryStorageStruct.h | ||
| RigVMCore/RigVMMemoryStorageStruct.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FRigVMMemoryStorageStruct() |
RigVMCore/RigVMMemoryStorageStruct.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| EmptyProperties | const TArray< const FProperty * > | RigVMCore/RigVMMemoryStorageStruct.h | |
| EmptyPropertyPaths | const TArray< FRigVMPropertyPath > | RigVMCore/RigVMMemoryStorageStruct.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddProperties
(
const TArray< FRigVMPropertyDescription >& InPropertyDescriptions, |
Adds properties to the storage. | RigVMCore/RigVMMemoryStorageStruct.h | |
void AddStructReferencedObjects
(
FReferenceCollector& Collector |
RigVMCore/RigVMMemoryStorageStruct.h | ||
| Returns a property given its name (or nullptr if the name wasn't found) | RigVMCore/RigVMMemoryStorageStruct.h | ||
void * GetContainerPtr() |
Returns the raw memory storage pointer. | RigVMCore/RigVMMemoryStorageStruct.h | |
| RigVMCore/RigVMMemoryStorageStruct.h | |||
T * GetData
(
int32 InPropertyIndex, |
Returns the memory for a property given its index and a matching property path. | RigVMCore/RigVMMemoryStorageStruct.h | |
T * GetData
(
const FRigVMOperand& InOperand |
Returns the memory for a property (and optionally a property path) given an operand. | RigVMCore/RigVMMemoryStorageStruct.h | |
T * GetData
(
int32 InPropertyIndex |
Returns the memory for a property given its index. | RigVMCore/RigVMMemoryStorageStruct.h | |
const T * GetData
(
int32 InPropertyIndex |
RigVMCore/RigVMMemoryStorageStruct.h | ||
| Returns the mutable memory for a given property (or nullptr if does not belong to this storage) | RigVMCore/RigVMMemoryStorageStruct.h | ||
FString GetDataAsString
(
const FRigVMOperand& InOperand, |
Returns the exported text for a given operand. | RigVMCore/RigVMMemoryStorageStruct.h | |
FString GetDataAsString
(
int32 InPropertyIndex, |
Returns the exported text for a given property index. | RigVMCore/RigVMMemoryStorageStruct.h | |
| Returns the exported text for given property name. | RigVMCore/RigVMMemoryStorageStruct.h | ||
| Returns the exported text for given property name. | RigVMCore/RigVMMemoryStorageStruct.h | ||
FString GetDataAsStringSafe
(
int32 InPropertyIndex, |
Returns the exported text for a given property index. | RigVMCore/RigVMMemoryStorageStruct.h | |
FString GetDataAsStringSafe
(
const FRigVMOperand& InOperand, |
Returns the exported text for a given operand. | RigVMCore/RigVMMemoryStorageStruct.h | |
T * GetDataByName
(
const FName& InName, |
Returns the memory for a property given its name and a matching property path (or nullptr) | RigVMCore/RigVMMemoryStorageStruct.h | |
T * GetDataByName
(
const FName& InName |
Returns the memory for a property given its name (or nullptr) | RigVMCore/RigVMMemoryStorageStruct.h | |
FRigVMMemoryHandle GetHandle
(
int32 InPropertyIndex, |
Returns the handle for a given property by index (and optionally property path) | RigVMCore/RigVMMemoryStorageStruct.h | |
FRigVMMemoryHandle GetHandleByName
(
const FName& InName, |
Returns the handle for a given property by name (and optionally property path) | RigVMCore/RigVMMemoryStorageStruct.h | |
uint32 GetMemoryHash() |
RigVMCore/RigVMMemoryStorageStruct.h | ||
ERigVMMemoryType GetMemoryType() |
RigVMCore/RigVMMemoryStorageStruct.h | ||
FRigVMOperand GetOperand
(
int32 InPropertyIndex, |
Creates and returns a new operand for a property (and optionally a property path) | RigVMCore/RigVMMemoryStorageStruct.h | |
FRigVMOperand GetOperandByName
(
const FName& InName, |
Creates and returns a new operand for a property (and optionally a property path) | RigVMCore/RigVMMemoryStorageStruct.h | |
| Returns the properties provided by this instance. | RigVMCore/RigVMMemoryStorageStruct.h | ||
const FProperty * GetProperty
(
int32 InPropertyIndex |
Returns a property given its index. | RigVMCore/RigVMMemoryStorageStruct.h | |
int32 GetPropertyIndex
(
const FProperty* InProperty |
Returns the index of a property given the property itself. | RigVMCore/RigVMMemoryStorageStruct.h | |
int32 GetPropertyIndexByName
(
const FName& InName |
Returns the index of a property given its name. | RigVMCore/RigVMMemoryStorageStruct.h | |
const FRigVMPropertyPathDescription * GetPropertyPathDescriptionByIndex
(
int32 Index |
RigVMCore/RigVMMemoryStorageStruct.h | ||
const TArray< FRigVMPropertyPath > & GetPropertyPaths() |
Returns the property paths provided by this instance. | RigVMCore/RigVMMemoryStorageStruct.h | |
T & GetRef
(
const FRigVMOperand& InOperand |
Returns the ref of an element stored for a given operand. | RigVMCore/RigVMMemoryStorageStruct.h | |
T & GetRef
(
int32 InPropertyIndex |
Returns the ref of an element stored at a given property index. | RigVMCore/RigVMMemoryStorageStruct.h | |
T & GetRef
(
int32 InPropertyIndex, |
Returns the ref of an element stored at a given property index and a property path. | RigVMCore/RigVMMemoryStorageStruct.h | |
T & GetRefByName
(
const FName& InName, |
Returns the ref of an element stored at a given property name and a property path (throws if name is invalid) | RigVMCore/RigVMMemoryStorageStruct.h | |
T & GetRefByName
(
const FName& InName |
Returns the ref of an element stored at a given property name (throws if name is invalid) | RigVMCore/RigVMMemoryStorageStruct.h | |
const UStruct * GetStruct() |
Returns the PropertyBag struct using a standard function signature, so it can be used at IStructureDataProvider | RigVMCore/RigVMMemoryStorageStruct.h | |
| RigVMCore/RigVMMemoryStorageStruct.h | |||
bool IsArray
(
int32 InPropertyIndex |
Returns true if the property at a given index is a TArray. | RigVMCore/RigVMMemoryStorageStruct.h | |
bool IsMap
(
int32 InPropertyIndex |
Returns true if the property at a given index is a TMap. | RigVMCore/RigVMMemoryStorageStruct.h | |
bool IsValidIndex
(
int32 InIndex |
Returns true if a provided property index is valid. | RigVMCore/RigVMMemoryStorageStruct.h | |
bool IsValidPropertyPathDescriptionIndex
(
int32 Index |
RigVMCore/RigVMMemoryStorageStruct.h | ||
int32 Num() |
Returns the number of properties stored in this instance. | RigVMCore/RigVMMemoryStorageStruct.h | |
void RefreshPropertyPaths() |
RigVMCore/RigVMMemoryStorageStruct.h | ||
void ResetPropertyPathDescriptions() |
RigVMCore/RigVMMemoryStorageStruct.h | ||
bool Serialize
(
FArchive& Ar |
RigVMCore/RigVMMemoryStorageStruct.h | ||
bool SetDataFromString
(
int32 InPropertyIndex, |
Sets the content of a property by index given an exported string. Returns true if succeeded. | RigVMCore/RigVMMemoryStorageStruct.h | |
| Sets the content of a property by name given an exported string. Returns true if succeeded. | RigVMCore/RigVMMemoryStorageStruct.h | ||
void SetMemoryType
(
ERigVMMemoryType InMemoryType |
RigVMCore/RigVMMemoryStorageStruct.h | ||
void SetPropertyPathDescriptions
(
const TArray< FRigVMPropertyPathDescription >& InPropertyPathDescriptions |
RigVMCore/RigVMMemoryStorageStruct.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void RefreshLinkedProperties() |
RigVMCore/RigVMMemoryStorageStruct.h | ||
void SetDefaultValues
(
const TArray< FRigVMPropertyDescription >& InPropertyDescriptions |
RigVMCore/RigVMMemoryStorageStruct.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CopyProperty
(
const FProperty* InTargetProperty, |
Copies the content of a source property and memory into the memory of a target property. | RigVMCore/RigVMMemoryStorageStruct.h | |
static bool CopyProperty
(
const FProperty* InTargetProperty, |
Copies the content of a source property and memory into the memory of a target property | RigVMCore/RigVMMemoryStorageStruct.h | |
static bool CopyProperty
(
FRigVMMemoryHandle& InTargetHandle, |
Copies the content of a source property and memory into the memory of a target property. | RigVMCore/RigVMMemoryStorageStruct.h | |
static bool CopyProperty
(
FRigVMMemoryStorageStruct* InTargetStorage, |
Copies the content of a source property and memory into the memory of a target property. | RigVMCore/RigVMMemoryStorageStruct.h | |
static FPropertyBagPropertyDesc GeneratePropertyBagDescriptor
(
const FRigVMPropertyDescription& RigVMDescriptor |
Helper function to generate a property bag desc from a FRigVMPropertyDescription. | RigVMCore/RigVMMemoryStorageStruct.h | |
static bool GetPropertyTypeDataFromVMDescriptor
(
const FRigVMPropertyDescription& RigVMDescriptor, |
RigVMCore/RigVMMemoryStorageStruct.h | ||
static bool IsClassOf
(
const FRigVMMemoryStorageStruct* InElement |
RigVMCore/RigVMMemoryStorageStruct.h |