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.

Public Member Functions
	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.

Protected Attributes
AZ::EntityId	m_entityId

AZ::ComponentId	m_componentId = AZ::InvalidComponentId

AzToolsFramework::UndoSystem::URSequencePoint *	m_currentUndoBatch = nullptr

enum AzToolsFramework::PropertyModificationRefreshLevel	m_queuedRefreshLevel

Detailed Description

ComponentAdapter is responsible to listening for signals that affect each component in the Entity Inspector.

Member Function Documentation

◆ 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

Sets the component, connects the appropriate Bus Handlers and sets the reflect data for this instance.

Reimplemented in AzToolsFramework::Prefab::PrefabComponentAdapter.

Member Data Documentation

◆ 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