AzToolsFramework::ProceduralPrefabUiHandler Class Reference
Implements the Editor UI for Procedural Prefabs. More...
#include <ProceduralPrefabUiHandler.h>
Inherits AzToolsFramework::PrefabUiHandler.
Public Member Functions | |
| AZ_CLASS_ALLOCATOR (ProceduralPrefabUiHandler, AZ::SystemAllocator) | |
| AZ_RTTI (AzToolsFramework::ProceduralPrefabUiHandler, "{3A3DF9FF-9C2E-4439-B7B4-72173B5A3502}", PrefabUiHandler) | |
| QString | GenerateItemTooltip (AZ::EntityId entityId) const override |
| Returns the item tooltip text to display in the Outliner. | |
 Public Member Functions inherited from AzToolsFramework::PrefabUiHandler | |
| AZ_CLASS_ALLOCATOR (PrefabUiHandler, AZ::SystemAllocator) | |
| AZ_RTTI (AzToolsFramework::PrefabUiHandler, "{598154A2-89E3-45CB-A3CB-337CB1C73DE7}", EditorEntityUiHandlerBase) | |
| QString | GenerateItemInfoString (AZ::EntityId entityId) const override |
| Returns the item info string that is appended to the item name in the Outliner. | |
| QString | GenerateItemTooltip (AZ::EntityId entityId) const override |
| Returns the item tooltip text to display in the Outliner. | |
| QIcon | GenerateItemIcon (AZ::EntityId entityId) const override |
| Returns the item icon pixmap to display in the Outliner. | |
| bool | CanToggleLockVisibility (AZ::EntityId entityId) const override |
| Returns whether the element's lock and visibility state should be accessible in the Outliner. | |
| void | PaintItemBackground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override |
| Paints the background of the item in the Outliner. | |
| void | PaintDescendantBackground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index, const QModelIndex &descendantIndex) const override |
| Paints the background of the descendants of the item in the Outliner. | |
| void | PaintItemForeground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override |
| Paints visual elements on the foreground of the item in the Outliner. | |
| void | PaintDescendantForeground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index, const QModelIndex &descendantIndex) const override |
| Paints visual elements on the foreground of the descendants of the item in the Outliner. | |
| bool | OnOutlinerItemClick (const QPoint &position, const QStyleOptionViewItem &option, const QModelIndex &index) const override |
| bool | OnOutlinerItemDoubleClick (const QModelIndex &index) const override |
| void | OnOutlinerItemCollapse (const QModelIndex &index) const override |
| Triggered when an entity's children are collapsed in the Outliner. | |
| Public Member Functions inherited from AzToolsFramework::EditorEntityUiHandlerBase | |
| AZ_RTTI (EditorEntityUiHandlerBase, "{EFB6CBC0-3A0A-4302-92EB-62CAF1C47163}") | |
| EditorEntityUiHandlerId | GetHandlerId () |
| virtual QString | GenerateItemInfoString (AZ::EntityId entityId) const |
| Returns the item info string that is appended to the item name in the Outliner. | |
| virtual QString | GenerateItemTooltip (AZ::EntityId entityId) const |
| Returns the item tooltip text to display in the Outliner. | |
| virtual QIcon | GenerateItemIcon (AZ::EntityId entityId) const |
| Returns the item icon pixmap to display in the Outliner. | |
| virtual bool | CanRename (AZ::EntityId entityId) const |
| Returns whether the element's name should be editable. | |
| virtual bool | CanToggleLockVisibility (AZ::EntityId entityId) const |
| Returns whether the element's lock and visibility state should be accessible in the Outliner. | |
| virtual void | PaintItemBackground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const |
| Paints the background of the item in the Outliner. | |
| virtual void | PaintDescendantBackground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index, const QModelIndex &descendantIndex) const |
| Paints the background of the descendants of the item in the Outliner. | |
| virtual void | PaintDescendantBranchBackground (QPainter *painter, const QTreeView *view, const QRect &rect, const QModelIndex &index, const QModelIndex &descendantIndex) const |
| Paints the background of the descendant branches of the item in the Outliner. | |
| virtual void | PaintItemForeground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const |
| Paints visual elements on the foreground of the item in the Outliner. | |
| virtual void | PaintDescendantForeground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index, const QModelIndex &descendantIndex) const |
| Paints visual elements on the foreground of the descendants of the item in the Outliner. | |
| virtual bool | OnOutlinerItemClick (const QPoint &position, const QStyleOptionViewItem &option, const QModelIndex &index) const |
| virtual bool | OnOutlinerItemDoubleClick (const QModelIndex &index) const |
| virtual void | OnOutlinerItemExpand (const QModelIndex &index) const |
| Triggered when an entity's children are expanded in the Outliner. | |
| virtual void | OnOutlinerItemCollapse (const QModelIndex &index) const |
| Triggered when an entity's children are collapsed in the Outliner. | |
Additional Inherited Members | |
| Protected Member Functions inherited from AzToolsFramework::PrefabUiHandler | |
| const QPixmap & | GetOverrideImageForEntity (AZ::EntityId entityId) const |
| void | PaintDescendantBorder (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index, const QModelIndex &descendantIndex, const QColor borderColor) const |
| Static Protected Member Functions inherited from AzToolsFramework::PrefabUiHandler | |
| static bool | IsLastVisibleChild (const QModelIndex &parent, const QModelIndex &child) |
| static QModelIndex | GetLastVisibleChild (const QModelIndex &parent) |
| Static Protected Member Functions inherited from AzToolsFramework::EditorEntityUiHandlerBase | |
| static AZ::EntityId | GetEntityIdFromIndex (const QModelIndex &index) |
| Protected Attributes inherited from AzToolsFramework::PrefabUiHandler | |
| ContainerEntityInterface * | m_containerEntityInterface = nullptr |
| Prefab::PrefabFocusPublicInterface * | m_prefabFocusPublicInterface = nullptr |
| Prefab::PrefabPublicInterface * | m_prefabPublicInterface = nullptr |
| Prefab::PrefabOverridePublicInterface * | m_prefabOverridePublicInterface = nullptr |
| QColor | m_backgroundColor = QColor("#444444") |
| QColor | m_backgroundHoverColor = QColor("#5A5A5A") |
| QColor | m_backgroundSelectedColor = QColor("#656565") |
| QColor | m_prefabCapsuleColor = QColor("#1E252F") |
| QColor | m_prefabCapsuleDisabledColor = QColor("#35383C") |
| QColor | m_prefabCapsuleEditColor = QColor("#4A90E2") |
| QString | m_prefabIconPath = QString(":/Entity/prefab.svg") |
| QString | m_prefabEditIconPath = QString(":/Entity/prefab_edit.svg") |
| QString | m_prefabEditOpenIconPath = QString(":/Entity/prefab_edit_open.svg") |
| QString | m_prefabEditCloseIconPath = QString(":/Entity/prefab_edit_close.svg") |
| QString | m_editEntityOverrideImagePath = QString(":/Entity/entity_modified_as_override.svg") |
| QString | m_addEntityOverrideImagePath = QString(":/Entity/entity_added_as_override.svg") |
| QPixmap | m_editEntityOverrideImage |
| QPixmap | m_addEntityOverrideImage |
| Static Protected Attributes inherited from AzToolsFramework::PrefabUiHandler | |
| static AzFramework::EntityContextId | s_editorEntityContextId |
| static const QPoint | s_overrideImageOffset = QPoint(13, 12) |
| static const QSize | s_overrideImageSize = QSize(7, 7) |
Detailed Description
Implements the Editor UI for Procedural Prefabs.
Member Function Documentation
◆ GenerateItemTooltip()
|
overridevirtual |
Returns the item tooltip text to display in the Outliner.
Reimplemented from AzToolsFramework::PrefabUiHandler.
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/UI/Prefab/Procedural/ProceduralPrefabUiHandler.h
