Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzToolsFramework::PropertyEditorToolsSystem Class Reference

Implementation of PropertyEditorToolsSystemInterface,. More...

#include <PropertyEditorToolsSystem.h>

Inherits AzToolsFramework::PropertyEditorToolsSystemInterface.

Public Member Functions

 AZ_RTTI (PropertyEditorToolsSystem, "{78954B5C-D147-411F-BBDA-A28D2CA50A3A}", PropertyEditorToolsSystemInterface)
 
 AZ_CLASS_ALLOCATOR (PropertyEditorToolsSystem, AZ::OSAllocator)
 
void RegisterDefaultHandlers ()
 
PropertyHandlerId GetPropertyHandlerForNode (const AZ::Dom::Value node) override
 
PropertyHandlerInstance CreateHandlerInstance (PropertyHandlerId handlerId) override
 
PropertyHandlerId RegisterHandler (HandlerData handlerData) override
 
void UnregisterHandler (PropertyHandlerId handlerId) override
 Unregisters a previously registered property handler.
 
- Public Member Functions inherited from AzToolsFramework::PropertyEditorToolsSystemInterface
 AZ_RTTI (PropertyEditorToolsSystemInterface, "{4E45141B-D612-4DCB-A644-A874EE9A7A52}")
 
virtual PropertyHandlerId GetPropertyHandlerForNode (const AZ::Dom::Value node)=0
 
virtual PropertyHandlerInstance CreateHandlerInstance (PropertyHandlerId handlerId)=0
 
virtual PropertyHandlerId RegisterHandler (HandlerData handlerData)=0
 
virtual void UnregisterHandler (PropertyHandlerId handlerId)=0
 Unregisters a previously registered property handler.
 
template<typename HandlerType >
void RegisterHandler ()
 

Additional Inherited Members

- Public Types inherited from AzToolsFramework::PropertyEditorToolsSystemInterface
using PropertyHandlerInstance = AZStd::unique_ptr< PropertyHandlerWidgetInterface >
 
using PropertyHandlerInstanceFactory = AZStd::function< PropertyHandlerInstance()>
 
using PropertyHandlerId = HandlerData *
 A persistent ID for a given property handler.
 
- Static Public Member Functions inherited from AzToolsFramework::PropertyEditorToolsSystemInterface
template<class T >
constexpr bool IsDefaultHandler
 
- Static Public Attributes inherited from AzToolsFramework::PropertyEditorToolsSystemInterface
static constexpr PropertyHandlerId InvalidHandlerId = nullptr
 An invalid or nonexistent ID for a property handler.
 
template<class , class = void>
static constexpr bool IsDefaultHandler = false
 

Detailed Description

Implementation of PropertyEditorToolsSystemInterface,.

Member Function Documentation

◆ CreateHandlerInstance()

PropertyHandlerInstance AzToolsFramework::PropertyEditorToolsSystem::CreateHandlerInstance ( PropertyHandlerId  handlerId)
overridevirtual

Creates a PropertyHandlerInstance given a property handler ID. Any number of handler instances can be created for a given handler ID. This operation will fail if the ID is InvalidHandlerId.

Implements AzToolsFramework::PropertyEditorToolsSystemInterface.

◆ GetPropertyHandlerForNode()

PropertyHandlerId AzToolsFramework::PropertyEditorToolsSystem::GetPropertyHandlerForNode ( const AZ::Dom::Value  node)
overridevirtual

Looks up the property handler for a given node. Currently, only PropertyEditor nodes are supported.

Implements AzToolsFramework::PropertyEditorToolsSystemInterface.

◆ RegisterHandler()

PropertyHandlerId AzToolsFramework::PropertyEditorToolsSystem::RegisterHandler ( HandlerData  handlerData)
overridevirtual

Registers a property handler. For standard types that implement PropertyHandlerWidgetInterface, the templated helper may be used to automatically create HandlerData for a given type.

Implements AzToolsFramework::PropertyEditorToolsSystemInterface.

◆ UnregisterHandler()

void AzToolsFramework::PropertyEditorToolsSystem::UnregisterHandler ( PropertyHandlerId  handlerId)
overridevirtual

Unregisters a previously registered property handler.

Implements AzToolsFramework::PropertyEditorToolsSystemInterface.

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