ComponentAdapter is responsible to listening for signals that affect each component in the Entity Inspector.
More...
#include <DPEComponentAdapter.h>
Inherits ReflectionAdapter, AzToolsFramework::PropertyEditorEntityChangeNotificationBus::MultiHandler, AzToolsFramework::ToolsApplicationEvents::Bus::Handler, AzToolsFramework::PropertyEditorGUIMessages::Bus::Handler, and AZ::EntitySystemBus::Handler.
Inherited by AzToolsFramework::Prefab::PrefabComponentAdapter.
|
| ComponentAdapter () |
| Creates an uninitialized (empty) ComponentAdapter.
|
|
| ComponentAdapter (AZ::Component *componentInstance) |
| Creates a ComponentAdapter with a specific component instance, see SetComponent.
|
|
void | OnEntityComponentPropertyChanged (AZ::ComponentId componentId) override |
|
void | InvalidatePropertyDisplay (AzToolsFramework::PropertyModificationRefreshLevel level) override |
|
void | RequestRefresh (AzToolsFramework::PropertyModificationRefreshLevel level) override |
|
virtual void | SetComponent (AZ::Component *componentInstance) |
| Sets the component, connects the appropriate Bus Handlers and sets the reflect data for this instance.
|
|
void | DoRefresh () |
| Trigger a refresh based on messages from the listeners.
|
|
Dom::Value | HandleMessage (const AdapterMessage &message) override |
|
void | CreateLabel (AdapterBuilder *adapterBuilder, AZStd::string_view labelText, AZStd::string_view serializedPath) override |
|
void | OnEntityDestruction (const AZ::EntityId &) override |
| Gets notification from the EntitySystemBus before destroying an entity.
|
|
ComponentAdapter is responsible to listening for signals that affect each component in the Entity Inspector.
◆ CreateLabel()
void AZ::DocumentPropertyEditor::ComponentAdapter::CreateLabel |
( |
AdapterBuilder * |
adapterBuilder, |
|
|
AZStd::string_view |
labelText, |
|
|
AZStd::string_view |
serializedPath |
|
) |
| |
|
override |
Creates a node for displaying label information. Requests the PrefabAdapterInterface to add a property node and configures its style if an override exist.
- Parameters
-
adapterBuilder | The adapter builder to use for adding property node. |
labelText | The text string to be displayed in label. |
serializedPath | The serialized path to use to check whether an override is present corresponding to it. |
◆ SetComponent()
virtual void AZ::DocumentPropertyEditor::ComponentAdapter::SetComponent |
( |
AZ::Component * |
componentInstance | ) |
|
|
virtual |
◆ m_queuedRefreshLevel
enum AzToolsFramework::PropertyModificationRefreshLevel AZ::DocumentPropertyEditor::ComponentAdapter::m_queuedRefreshLevel |
|
protected |
Initial value:=
AzToolsFramework::PropertyModificationRefreshLevel::Refresh_None
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/UI/DocumentPropertyEditor/DPEComponentAdapter.h