Navigation
API > API/Plugins > API/Plugins/RigVM
The FRigVMMemoryHandle is used to access the memory used within a URigMemoryStorage. The Memory Handle caches the pointer of the head property, and can rely on a RigVMPropertyPath to traverse towards a tail property. For example it can cache the pointer of a TArray
| Name | FRigVMMemoryHandle |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryStorage.h |
| Include Path | #include "RigVMCore/RigVMMemoryStorage.h" |
Syntax
struct FRigVMMemoryHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMMemoryHandle
(
uint8* InPtr, |
Constructor from complete data. | RigVMCore/RigVMMemoryStorage.h | |
| Default constructor. | RigVMCore/RigVMMemoryStorage.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LazyBranch | FRigVMLazyBranch * | The [optional] lazy branch used by this handle. | RigVMCore/RigVMMemoryStorage.h | |
| Property | const FProperty * | The head property used by this handle. | RigVMCore/RigVMMemoryStorage.h | |
| PropertyPath | const FRigVMPropertyPath * | The [optional] property path used by this handle. | RigVMCore/RigVMMemoryStorage.h | |
| Ptr | uint8 * | The pointer of the memory of the head property. | RigVMCore/RigVMMemoryStorage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ComputeLazyValueIfNecessary
(
FRigVMExtendedExecuteContext& Context, |
Computes the data if necessary and returns true if the value is valid | RigVMCore/RigVMMemoryStorage.h | |
uint8 * GetData
(
bool bFollowPropertyPath, |
Returns the cached pointer stored within the handle. | RigVMCore/RigVMMemoryStorage.h | |
const uint8 * GetData
(
bool bFollowPropertyPath, |
Computes the data if necessary and returns the cached pointer stored within the handle. | RigVMCore/RigVMMemoryStorage.h | |
TRigVMLazyValue< ComputedType > GetDataLazily
(
int32 InSliceIndex |
Computes the data if necessary and returns the cached pointer stored within the handle. | RigVMCore/RigVMMemoryStorage.h | |
const uint8 * GetInputData
(
int32 InSliceIndex |
Returns the cached pointer stored within the handle. | RigVMCore/RigVMMemoryStorage.h | |
uint8 * GetOutputData
(
int32 InSliceIndex |
Returns the cached pointer stored within the handle. | RigVMCore/RigVMMemoryStorage.h | |
uint8 * GetPrivateData
(
int32 InSliceIndex |
Returns the cached pointer stored within the handle. | RigVMCore/RigVMMemoryStorage.h | |
const FProperty * GetProperty() |
Returns the head property of this handle. | RigVMCore/RigVMMemoryStorage.h | |
const FRigVMPropertyPath * GetPropertyPath() |
Returns the [optional] property path used within this handle. | RigVMCore/RigVMMemoryStorage.h | |
const FRigVMPropertyPath & GetPropertyPathRef() |
Returns the [optional] property path used within this handle (ref) | RigVMCore/RigVMMemoryStorage.h | |
const FProperty * GetResolvedProperty
(
bool bIsHiddenArgument |
Returns the resolved property the data is pointing to. | RigVMCore/RigVMMemoryStorage.h | |
bool IsBool
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a bool property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsBoolArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a bool array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsDouble
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a double property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsDoubleArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a double array property. | RigVMCore/RigVMMemoryStorage.h | |
| Returns true if this memory handle maps to an enum property. | RigVMCore/RigVMMemoryStorage.h | ||
bool IsEnum
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an enum property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsEnumArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an enum array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsEnumArray
(
const UEnum* InEnum, |
Returns true if this memory handle maps to an enum array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsFloat
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a float property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsFloatArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a float array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsInt32
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a int32 property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsInt32Array
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a int32 array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsLazy() |
Returns true if this memory handle depends on a lazily executed branch | RigVMCore/RigVMMemoryStorage.h | |
bool IsName
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an FName property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsNameArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an FName array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsObject
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an object property. | RigVMCore/RigVMMemoryStorage.h | |
| Returns true if this memory handle maps to an object property. | RigVMCore/RigVMMemoryStorage.h | ||
bool IsObjectArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an objct array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsObjectArray
(
const UClass* InClass, |
Returns true if this memory handle maps to an objct array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsPropertyArrayType
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a given array type of property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsPropertyType
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a given type of property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsString
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an FString property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsStringArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to an FString array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsStruct
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a struct property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsStruct
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a struct property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsStruct
(
const UScriptStruct* InStruct, |
Returns true if this memory handle maps to a struct property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsStructArray
(
const UScriptStruct* InStruct, |
Returns true if this memory handle maps to a struct array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsStructArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a struct array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsStructArray
(
bool bIsHiddenArgument |
Returns true if this memory handle maps to a struct array property. | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsType
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h | |
bool IsTypeArray
(
bool bIsHiddenArgument |
Returns true if the handle is of the given type | RigVMCore/RigVMMemoryStorage.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RigVMCore/RigVMMemoryStorage.h | |||
| RigVMCore/RigVMMemoryStorage.h | |||
| RigVMCore/RigVMMemoryStorage.h | |||
| RigVMCore/RigVMMemoryStorage.h | |||
static bool IsStruct
(
const FProperty* InProperty, |
RigVMCore/RigVMMemoryStorage.h |