#include <PropertyTreeEditor.h>

Public Types
using	PropertyAccessOutcome = AZ::Outcome< AZStd::any, AZStd::string >

Public Member Functions
	PropertyTreeEditor ()=default
	Required to expose the class to Behavior Context; creates an empty object.

	PropertyTreeEditor (void *pointer, AZ::TypeId typeId)

const AZStd::vector< AZStd::string >	BuildPathsList () const
	returns a list of properties in the form of 'property path'

const AZStd::vector< AZStd::string >	BuildPathsListWithTypes ()
	returns a list of properties in the form of 'property path (type name, [ShowChildrenOnly], [ReadOnly])'

AZStd::string	GetPropertyType (const AZStd::string_view propertyPath)
	returns the type of the property a 'property path' points to

void	SetVisibleEnforcement (bool enforceVisiblity)
	toggles enforcement of skipping hidden node types such as ShowChildrenOnly and NotVisible

PropertyAccessOutcome	GetProperty (const AZStd::string_view propertyPath)

PropertyAccessOutcome	SetProperty (const AZStd::string_view propertyPath, const AZStd::any &value)

bool	CompareProperty (const AZStd::string_view propertyPath, const AZStd::any &value)

bool	IsContainer (AZStd::string_view propertyPath) const

PropertyAccessOutcome	GetContainerCount (AZStd::string_view propertyPath) const

PropertyAccessOutcome	ResetContainer (AZStd::string_view propertyPath)

PropertyAccessOutcome	AppendContainerItem (AZStd::string_view propertyPath, const AZStd::any &value)

PropertyAccessOutcome	AddContainerItem (AZStd::string_view propertyPath, const AZStd::any &key, const AZStd::any &value)

PropertyAccessOutcome	RemoveContainerItem (AZStd::string_view propertyPath, const AZStd::any &key)

PropertyAccessOutcome	UpdateContainerItem (AZStd::string_view propertyPath, const AZStd::any &key, const AZStd::any &value)

PropertyAccessOutcome	GetContainerItem (AZStd::string_view propertyPath, const AZStd::any &key) const

bool	HasAttribute (AZStd::string_view propertyPath, AZStd::string_view attribute) const

Detailed Description

A class to easily access, enumerate and alter Edit Context properties of an object. The constructor automatically builds the InstanceDataHierarchy for the object provided and maps the property paths to the respective InstanceDataNode for easy access. Used to allow editor scripts to access and edit properties of Components, CryMaterials and more.

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

Code/Framework/AzToolsFramework/AzToolsFramework/PropertyTreeEditor/PropertyTreeEditor.h

Public Types

Public Member Functions

Detailed Description