ezPropertyPath Class Reference

Stores a path from an object of a given type to a property inside of it. More...

#include <PropertyPath.h>

Public Member Functions
bool	IsValid () const
	Returns true if InitializeFromPath() has been successfully called and it is therefore possible to use the other functions.
ezResult	InitializeFromPath (const ezRTTI &rootObjectRtti, const char *szPath)
	Resolves a path string into property steps and validates them against the root type.
ezResult	InitializeFromPath (const ezRTTI *pRootObjectRtti, const ezArrayPtr< const ezPropertyPathStep > path)
	Resolves a path provided as an array of ezPropertyPathStep and validates it.
ezResult	WriteToLeafObject (void *pRootObject, const ezRTTI *pType, ezDelegate< void(void *pLeaf, const ezRTTI &pType)> func) const
	Applies the entire path and allows writing to the target object.
ezResult	ReadFromLeafObject (void *pRootObject, const ezRTTI *pType, ezDelegate< void(void *pLeaf, const ezRTTI &pType)> func) const
	Applies the entire path and allows reading from the target object.
ezResult	WriteProperty (void *pRootObject, const ezRTTI &type, ezDelegate< void(void *pLeafObject, const ezRTTI &pLeafType, const ezAbstractProperty *pProp, const ezVariant &index)> func) const
	Applies the path up to the last step and allows a functor to write to the final property.
ezResult	ReadProperty (void *pRootObject, const ezRTTI &type, ezDelegate< void(void *pLeafObject, const ezRTTI &pLeafType, const ezAbstractProperty *pProp, const ezVariant &index)> func) const
	Applies the path up to the last step and allows a functor to read from the final property.
void	SetValue (void *pRootObject, const ezRTTI &type, const ezVariant &value) const
	Convenience function that writes 'value' to the 'pRootObject' at the current path.
template<typename T >
EZ_ALWAYS_INLINE void	SetValue (T *pRootObject, const ezVariant &value) const
	Convenience function that writes 'value' to the 'pRootObject' at the current path.
void	GetValue (void *pRootObject, const ezRTTI &type, ezVariant &out_value) const
	Convenience function that reads the value from 'pRootObject' at the current path and stores it in 'out_value'.
template<typename T >
EZ_ALWAYS_INLINE void	GetValue (T *pRootObject, ezVariant &out_value) const
	Convenience function that reads the value from 'pRootObject' at the current path and stores it in 'out_value'.

Detailed Description

Stores a path from an object of a given type to a property inside of it.

Once initialized to a specific path, the target property/object of the path can be read or written on multiple root objects. This is useful for implementing property binding, serialization, and generic property editors.

Path syntax: 'propertyName[index]/propertyName[index]/...'

• The '[index]' part is only required for properties that need indices (arrays and maps)
• Example: "Transform/Position[0]" accesses the X component of a Position vector in a Transform property
• An empty path is allowed, in which case operations work directly on the root object

Usage pattern:

1. Create ezPropertyPath instance
2. Initialize with InitializeFromPath() using root type and path string
3. Use SetValue()/GetValue() for simple access or WriteProperty()/ReadProperty() for complex operations
4. Reuse the same path instance for multiple objects of the same root type

Member Function Documentation

InitializeFromPath() [1/2]

ezResult ezPropertyPath::InitializeFromPath	(	const ezRTTI &	rootObjectRtti,
		const char *	szPath
	)

Resolves a path string into property steps and validates them against the root type.

The path syntax is 'propertyName[index]/propertyName[index]/...'. The '[index]' part is only required for properties that need indices (arrays and maps). Returns failure if any property in the path doesn't exist or has incompatible types.

InitializeFromPath() [2/2]

ezResult ezPropertyPath::InitializeFromPath	(	const ezRTTI *	pRootObjectRtti,
		const ezArrayPtr< const ezPropertyPathStep >	path
	)

Resolves a path provided as an array of ezPropertyPathStep and validates it.

This overload allows programmatic construction of paths. Each step must have a valid property name and appropriate index (if required by the property type).

---

The documentation for this class was generated from the following files:

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Reflection/PropertyPath.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Reflection/Implementation/PropertyPath.cpp