FRigVMMemoryStorageStruct

API > API/Plugins > API/Plugins/RigVM > API/Plugins/RigVM/RigVMCore

Inheritance Hierarchy

  • FInstancedPropertyBag
  • FRigVMMemoryStorageStruct

References

   
Module RigVM
Header /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryStorageStruct.h
Include #include "RigVMCore/RigVMMemoryStorageStruct.h"

Syntax

USTRUCT ()  
struct FRigVMMemoryStorageStruct : public FInstancedPropertyBag

Variables

  Type Name Description
Protected variable int32 CachedMemoryHash  
Protected variable TArray< const FProperty * > LinkedProperties A cached list of all linked properties (created by RefreshLinkedProperties)
Protected variable ERigVMMemoryType MemoryType  
Protected variable TArray< FRigVMPropertyPathDescription > PropertyPathDescriptions  
Protected variable TArray< FRigVMPropertyPath > PropertyPaths A cached list of all property paths (created by RefreshPropertyPaths)

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FRigVMMemoryStorageStruct ( ERigVMMemoryType InMemoryType,
const TArray< FRigVMPropertyDescription >& InPropertyDescriptions,
const TArray< FRigVMPropertyPathDescription >& InPropertyPaths
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddProperties ( const TArray< FRigVMPropertyDescription >& InPropertyDescriptions,
const TArray< FRigVMPropertyPathDescription >& InPropertyPathDescriptions
)

 Adds properties to the storage.
Public function void

AddStructReferencedObjects ( FReferenceCollector& Collector
)

  
Public function 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
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 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.
Public function Static bool

CopyProperty ( FRigVMMemoryStorageStruct* InTargetStorage,
int32 InTargetPropertyIndex,
const FRigVMPropertyPath& InTargetPropertyPath,
FRigVMMemoryStorageStruct* InSourceStorage,
int32 InSourcePropertyIndex,
const FRigVMPropertyPath& InSourcePropertyPath
)

 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)
Protected function Static FPropertyBagPropertyDesc  
Public function Const void * Returns the raw memory storage pointer.
Public function T *

GetData ( int32 InPropertyIndex
)

 Returns the memory for a property given its index.
Public function T *

GetData ( const FProperty* Property
)

 Returns the mutable memory for a given property (or nullptr if does not belong to this storage)
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,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the memory for a property given its index and a matching property path.
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 ( const FRigVMOperand& InOperand,
int32 PortFlags
)

 Returns the exported text for a given operand.
Public function FString

GetDataAsStringSafe ( int32 InPropertyIndex,
int32 PortFlags
)

 Returns the exported text for a given property index.
Public function T *

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

 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 FRigVMMemoryHandle

GetHandle ( int32 InPropertyIndex,
const FRigVMPropertyPath* InPropertyPath
)

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

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

 Returns the handle for a given property by name (and optionally property path)
Public function Const uint32  
Public function Const ERigVMMemoryType  
Public function Const FRigVMOperand

GetOperand ( int32 InPropertyIndex,
int32 InPropertyPathIndex
)

 Creates and returns a new operand for a property (and optionally a property path)
Public function Const FRigVMOperand

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< const FProperty * > & Returns the properties provided by this instance.
Public function Const const FProperty *

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 FRigVMPropertyPathDescription *  
Public function Const const TArray< FRigVMPropertyPath > & Returns the property paths provided by this instance.
Protected function Static bool

GetPropertyTypeDataFromVMDescriptor ( const FRigVMPropertyDescription& RigVMDescriptor,
EPropertyBagPropertyType& OutBagPropertyType,
FPropertyBagContainerTypes& OutBagContainerTypes
)

  
Public function T &

GetRef ( int32 InPropertyIndex,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the ref of an element stored at a given property index and a property path.
Public function T &

GetRef ( const FRigVMOperand& InOperand
)

 Returns the ref of an element stored for a given operand.
Public function T &

GetRef ( int32 InPropertyIndex
)

 Returns the ref of an element stored at a given property index.
Public function 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)
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 const UStruct * Returns the PropertyBag struct using a standard function signature, so it can be used at IStructureDataProvider
Public function Const bool

IsArray ( int32 InPropertyIndex
)

 Returns true if the property at a given index is a TArray.
Public function Static bool

IsClassOf ( const FRigVMMemoryStorageStruct* InElement
)

  
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 bool  
Public function Const int32

Num ()

 Returns the number of properties stored in this instance.
Protected function void  
Public function void  
Public function void  
Public function bool

Serialize ( FArchive& Ar
)

  
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.
Protected function void

SetDefaultValues ( const TArray< FRigVMPropertyDescription >& InPropertyDescriptions
)

  
Public function void

SetMemoryType ( ERigVMMemoryType InMemoryType
)

  
Public function void

SetPropertyPathDescriptions ( const TArray< FRigVMPropertyPathDescription >& InPropertyPathDescriptions
)

  

Constants

Name Description
EmptyProperties  
EmptyPropertyPaths  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page