FRigVMPropertyPath

The RigVMPropertyPath is used to access a memory pointer for a tail property given the memory of the head property.

Choose your operating system:

Windows

macOS

Linux

References

Module	RigVM
Header	/Engine/Source/Runtime/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

	Name	Description
	FRigVMPropertyPath()	Default constructor.
	FRigVMPropertyPath ( const FRigVMPropertyPath& InOther )	Copy constructor.
	FRigVMPropertyPath ( const FProperty* InProperty, const FString& InSegmentPath )	Constructor from complete data

Functions

	Name	Description
T *	GetData ( uint8* InPtr, const FProperty* InProperty )	Accessor for traversing the path and returning the memory of the tail
const FPrope...	GetTailProperty()	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 FStrin...	ToString()	Returns the property path as a string (the sanitized SegmentPath)

Operators

	Name	Description
bool	operator!= ( const FRigVMPropertyPath& Other )
const FRigVM...	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)