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.
AzToolsFramework::Prefab::PrefabComponentAdapter Class Reference

Inherits AZ::DocumentPropertyEditor::ComponentAdapter.

Public Member Functions

void SetComponent (AZ::Component *componentInstance) override
 Sets the component, connects the appropriate Bus Handlers and sets the reflect data for this instance.
 
void CreateLabel (AZ::DocumentPropertyEditor::AdapterBuilder *adapterBuilder, AZStd::string_view labelText, AZStd::string_view serializedPath) override
 
AZ::Dom::Value HandleMessage (const AZ::DocumentPropertyEditor::AdapterMessage &message) override
 
void UpdateDomContents (const PropertyChangeInfo &propertyChangeInfo) override
 
- Public Member Functions inherited from AZ::DocumentPropertyEditor::ComponentAdapter
 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.
 

Additional Inherited Members

- Protected Attributes inherited from AZ::DocumentPropertyEditor::ComponentAdapter
AZ::EntityId m_entityId
 
AZ::ComponentId m_componentId = AZ::InvalidComponentId
 
AzToolsFramework::UndoSystem::URSequencePointm_currentUndoBatch = nullptr
 
enum AzToolsFramework::PropertyModificationRefreshLevel m_queuedRefreshLevel
 

Member Function Documentation

◆ SetComponent()

void AzToolsFramework::Prefab::PrefabComponentAdapter::SetComponent ( AZ::Component *  componentInstance)
overridevirtual

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

Reimplemented from AZ::DocumentPropertyEditor::ComponentAdapter.

◆ UpdateDomContents()

void AzToolsFramework::Prefab::PrefabComponentAdapter::UpdateDomContents ( const PropertyChangeInfo &  propertyChangeInfo)
override

Updates the DPE DOM using the property change information provided. If the property is owned by the focused prefab, the change is applied as direct template edit. If the property is owned by descendant of the focused prefab, it is applied as an override from the focused prefab.

Parameters
propertyChangeInfoThe object containing information about the property change.

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