1. Epic GamesDeveloper
  3. FRigVMMemoryHandle

FRigVMMemoryHandle

Memory handle.

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 property's memory and use a property path of '[2].Translation.X' to retrieve the element 2's translation X float / double. Additionally the FRigVMMemoryHandle can be used to access 'sliced' memory. Sliced memory in this case simply means another level of a nested TArray. So a 'sliced' FTransform is stored as a TArray, which the handle can traverse into and return the memory of a specific FTransform within that array.

   
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,
const FProperty* InProperty,
const FRigVMPropertyPath* InPropertyPath,
FRigVMLazyBranch* InLazyBranch
)

 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,
uint32 InSliceHash
)

 Computes the data if necessary and returns true if the value is valid RigVMCore/RigVMMemoryStorage.h  

uint8 * GetData ( bool bFollowPropertyPath,
int32 InSliceIndex
)

 Returns the cached pointer stored within the handle. RigVMCore/RigVMMemoryStorage.h  

const uint8 * GetData ( bool bFollowPropertyPath,
int32 InSliceIndex
) const

 Computes the data if necessary and returns the cached pointer stored within the handle. RigVMCore/RigVMMemoryStorage.h  

TRigVMLazyValue< ComputedType > GetDataLazily ( int32 InSliceIndex
) const

 Computes the data if necessary and returns the cached pointer stored within the handle. RigVMCore/RigVMMemoryStorage.h  

const uint8 * GetInputData ( int32 InSliceIndex
) const

 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
) const

 Returns the resolved property the data is pointing to. RigVMCore/RigVMMemoryStorage.h  

bool IsBool ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a bool property. RigVMCore/RigVMMemoryStorage.h  

bool IsBoolArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a bool array property. RigVMCore/RigVMMemoryStorage.h  

bool IsDouble ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a double property. RigVMCore/RigVMMemoryStorage.h  

bool IsDoubleArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a double array property. RigVMCore/RigVMMemoryStorage.h  

bool IsEnum ( const UEnum* InEnum,
bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an enum property. RigVMCore/RigVMMemoryStorage.h  

bool IsEnum ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an enum property. RigVMCore/RigVMMemoryStorage.h  

bool IsEnumArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an enum array property. RigVMCore/RigVMMemoryStorage.h  

bool IsEnumArray ( const UEnum* InEnum,
bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an enum array property. RigVMCore/RigVMMemoryStorage.h  

bool IsFloat ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a float property. RigVMCore/RigVMMemoryStorage.h  

bool IsFloatArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a float array property. RigVMCore/RigVMMemoryStorage.h  

bool IsInt32 ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a int32 property. RigVMCore/RigVMMemoryStorage.h  

bool IsInt32Array ( bool bIsHiddenArgument
) const

 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
) const

 Returns true if this memory handle maps to an FName property. RigVMCore/RigVMMemoryStorage.h  

bool IsNameArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an FName array property. RigVMCore/RigVMMemoryStorage.h  

bool IsObject ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an object property. RigVMCore/RigVMMemoryStorage.h  

bool IsObject ( const UClass* InClass,
bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an object property. RigVMCore/RigVMMemoryStorage.h  

bool IsObjectArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an objct array property. RigVMCore/RigVMMemoryStorage.h  

bool IsObjectArray ( const UClass* InClass,
bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an objct array property. RigVMCore/RigVMMemoryStorage.h  

bool IsPropertyArrayType ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a given array type of property. RigVMCore/RigVMMemoryStorage.h  

bool IsPropertyType ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a given type of property. RigVMCore/RigVMMemoryStorage.h  

bool IsString ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an FString property. RigVMCore/RigVMMemoryStorage.h  

bool IsStringArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to an FString array property. RigVMCore/RigVMMemoryStorage.h  

bool IsStruct ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a struct property. RigVMCore/RigVMMemoryStorage.h  

bool IsStruct ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a struct property. RigVMCore/RigVMMemoryStorage.h  

bool IsStruct ( const UScriptStruct* InStruct,
bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a struct property. RigVMCore/RigVMMemoryStorage.h  

bool IsStructArray ( const UScriptStruct* InStruct,
bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a struct array property. RigVMCore/RigVMMemoryStorage.h  

bool IsStructArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a struct array property. RigVMCore/RigVMMemoryStorage.h  

bool IsStructArray ( bool bIsHiddenArgument
) const

 Returns true if this memory handle maps to a struct array property. RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsType ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

bool IsTypeArray ( bool bIsHiddenArgument
) const

 Returns true if the handle is of the given type RigVMCore/RigVMMemoryStorage.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FProperty * GetArrayElementProperty ( const FProperty* InProperty
)

   RigVMCore/RigVMMemoryStorage.h  

static const FProperty * GetArrayElementPropertyChecked ( const FProperty* InProperty
)

   RigVMCore/RigVMMemoryStorage.h  

static bool IsEnum ( const FProperty* InProperty,
const UEnum* InEnum,
bool bUseArrayElement
)

   RigVMCore/RigVMMemoryStorage.h  

static bool IsObject ( const FProperty* InProperty,
const UClass* InClass,
bool bUseArrayElement
)

   RigVMCore/RigVMMemoryStorage.h  

static bool IsStruct ( const FProperty* InProperty,
const UScriptStruct* InScriptStruct,
bool bUseArrayElement
)

   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