1. Epic GamesDeveloper
  3. FRigVMMemoryHandle

FRigVMMemoryHandle

Memory handle.

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

References

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

Syntax

struct FRigVMMemoryHandle

Remarks

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.

Constructors

  Type Name Description
Public function   Default constructor.
Public function  

FRigVMMemoryHandle ( uint8* InPtr,
const FProperty* InProperty,
const FRigVMPropertyPath* InPropertyPath,
FRigVMLazyBranch* InLazyBranch
)

 Constructor from complete data.

Functions

  Type Name Description
Public function bool Computes the data if necessary and returns true if the value is valid
Public function uint8 *

GetData ( bool bFollowPropertyPath,
int32 InSliceIndex
)

 Returns the cached pointer stored within the handle.
Public function Const const uint8 *

GetData ( bool bFollowPropertyPath,
int32 InSliceIndex
)

 Computes the data if necessary and returns the cached pointer stored within the handle.
Public function Const TRigVMLazyValue< ComputedType >

GetDataLazily ( bool bFollowPropertyPath,
int32 InSliceIndex
)

 Computes the data if necessary and returns the cached pointer stored within the handle.
Public function Const const FProperty * Returns the head property of this handle.
Public function Const const FRigVMPropertyPath * Returns the [optional] property path used within this handle.
Public function Const const FRigVMPropertyPath & Returns the [optional] property path used within this handle (ref)
Public function Const const FProperty *

GetResolvedProperty ( bool bIsHiddenArgument
)

 Returns the resolved property the data is pointing to.
Public function Const bool

IsBool ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a bool property.
Public function Const bool

IsBoolArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a bool array property.
Public function Const bool

IsDouble ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a double property.
Public function Const bool

IsDoubleArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a double array property.
Public function Const bool

IsEnum ( const UEnum* InEnum,
bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an enum property.
Public function Const bool

IsEnum ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an enum property.
Public function Const bool

IsEnumArray ( const UEnum* InEnum,
bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an enum array property.
Public function Const bool

IsEnumArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an enum array property.
Public function Const bool

IsFloat ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a float property.
Public function Const bool

IsFloatArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a float array property.
Public function Const bool

IsInt32 ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a int32 property.
Public function Const bool

IsInt32Array ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a int32 array property.
Public function Const bool

IsLazy ()

 Returns true if this memory handle depends on a lazily executed branch
Public function Const bool

IsName ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an FName property.
Public function Const bool

IsNameArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an FName array property.
Public function Const bool

IsObject ( const UClass* InClass,
bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an object property.
Public function Const bool

IsObject ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an object property.
Public function Const bool

IsObjectArray ( const UClass* InClass,
bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an objct array property.
Public function Const bool

IsObjectArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an objct array property.
Public function Const bool

IsPropertyArrayType ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a given array type of property.
Public function Const bool

IsPropertyType ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a given type of property.
Public function Const bool

IsString ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an FString property.
Public function Const bool

IsStringArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to an FString array property.
Public function Const bool

IsStruct ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a struct property.
Public function Const bool

IsStruct ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a struct property.
Public function Const bool

IsStruct ( const UScriptStruct* InStruct,
bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a struct property.
Public function Const bool

IsStructArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a struct array property.
Public function Const bool

IsStructArray ( bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a struct array property.
Public function Const bool

IsStructArray ( const UScriptStruct* InStruct,
bool bIsHiddenArgument
)

 Returns true if this memory handle maps to a struct array property.
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsType ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type
Public function Const bool

IsTypeArray ( bool bIsHiddenArgument
)

 Returns true if the handle is of the given type

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page