Navigation
API > API/Plugins > API/Plugins/RigVM > API/Plugins/RigVM/RigVMCore
References
| Module | RigVM |
| Header | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMPropertyPath.h |
| Include | #include "RigVMCore/RigVMPropertyPath.h" |
Syntax
class FRigVMPropertyPath
Remarks
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).
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Default constructor. | ||
 |
FRigVMPropertyPath
(
const FProperty* InProperty, |
Constructor from complete data |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
T * | Accessor for traversing the path and returning the memory of the tail | |
  |
const FProperty * | Returns the property of the last segment. | |
  |
bool | IsEmpty () |
Returns true if the property is empty (no segments) |
  |
bool | IsValid () |
Returns true if the property path is valid (has any segments) |
  |
int32 | Num () |
Returns the number of segments. |
  |
const FString & | ToString () |
Returns the property path as a string (the sanitized SegmentPath) |
Operators
| Type | Name | Description | |
|---|---|---|---|
  |
bool | operator!=
(
const FRigVMPropertyPath& Other |
|
  |
const FRigVMPropertyPathSegment & | operator[]
(
int32 InIndex |
Index based access operator for a segment. |
  |
bool | operator<
(
const FRigVMPropertyPath& Other |
|
  |
bool | operator==
(
const FRigVMPropertyPath& Other |
|
  |
bool | operator>
(
const FRigVMPropertyPath& Other |
Constants
| Name | Description |
|---|---|
| Empty | Static empty property path (used for comparisons) |