Navigation
API > API/Plugins > API/Plugins/RigVM
The RigVMPropertyPath is used to access a memory pointer for a tail property given the memory of the head property. A property path allows to traverse struct members, array elements and map values. For example given an array of transforms the property path '[2].Translation.X' is represented as three segments (1 array element and 2 struct members).
| Name | FRigVMPropertyPath |
| Type | class |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMPropertyPath.h |
| Include Path | #include "RigVMCore/RigVMPropertyPath.h" |
Syntax
class FRigVMPropertyPath
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor. | RigVMCore/RigVMPropertyPath.h | ||
FRigVMPropertyPath
(
const FProperty* InProperty, |
Constructor from complete data | RigVMCore/RigVMPropertyPath.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Empty | FRigVMPropertyPath | Static empty property path (used for comparisons) | RigVMCore/RigVMPropertyPath.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Path | FString | Stored string representation of the segment path. | RigVMCore/RigVMPropertyPath.h | |
| Segments | TArray< FRigVMPropertyPathSegment > | Resolved segments of the property path. | RigVMCore/RigVMPropertyPath.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
T * GetData
(
uint8* InPtr, |
Accessor for traversing the path and returning the memory of the tail | RigVMCore/RigVMPropertyPath.h | |
const TArray< FRigVMPropertyPathSegment > & GetSegments() |
Returns the segments of this property path. | RigVMCore/RigVMPropertyPath.h | |
const FProperty * GetTailProperty() |
Returns the property of the last segment. | RigVMCore/RigVMPropertyPath.h | |
bool IsEmpty() |
Returns true if the property is empty (no segments) | RigVMCore/RigVMPropertyPath.h | |
bool IsValid() |
Returns true if the property path is valid (has any segments) | RigVMCore/RigVMPropertyPath.h | |
int32 Num() |
Returns the number of segments. | RigVMCore/RigVMPropertyPath.h | |
const FString & ToString() |
Returns the property path as a string (the sanitized SegmentPath) | RigVMCore/RigVMPropertyPath.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FRigVMPropertyPath& Other |
RigVMCore/RigVMPropertyPath.h | ||
const FRigVMPropertyPathSegment & operator[]
(
int32 InIndex |
Index based access operator for a segment. | RigVMCore/RigVMPropertyPath.h | |
bool operator==
(
const FRigVMPropertyPath& Other |
RigVMCore/RigVMPropertyPath.h | ||
bool operator>
(
const FRigVMPropertyPath& Other |
RigVMCore/RigVMPropertyPath.h |