Defines a handler that can customize entity UI appearance and behavior in the Entity Outliner. More...
#include <EditorEntityUiHandlerBase.h>
Inherited by AzToolsFramework::LayerUiHandler, AzToolsFramework::LevelRootUiHandler, and AzToolsFramework::PrefabUiHandler.
Public Member Functions | |
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. | |
Static Protected Member Functions | |
static AZ::EntityId | GetEntityIdFromIndex (const QModelIndex &index) |
Defines a handler that can customize entity UI appearance and behavior in the Entity Outliner.
|
virtual |
Returns whether the element's name should be editable.
Reimplemented in AzToolsFramework::LevelRootUiHandler.
|
virtual |
Returns whether the element's lock and visibility state should be accessible in the Outliner.
Reimplemented in AzToolsFramework::LevelRootUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Returns the item icon pixmap to display in the Outliner.
Reimplemented in AzToolsFramework::LayerUiHandler, AzToolsFramework::LevelRootUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Returns the item info string that is appended to the item name in the Outliner.
Reimplemented in AzToolsFramework::LayerUiHandler, AzToolsFramework::LevelRootUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Returns the item tooltip text to display in the Outliner.
Reimplemented in AzToolsFramework::PrefabUiHandler, and AzToolsFramework::ProceduralPrefabUiHandler.
|
virtual |
Triggered when the entity is clicked in the Outliner.
Reimplemented in AzToolsFramework::LevelRootUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Triggered when an entity's children are collapsed in the Outliner.
Reimplemented in AzToolsFramework::PrefabUiHandler.
|
virtual |
Triggered when the entity is double-clicked in the Outliner.
Reimplemented in AzToolsFramework::LevelRootUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Paints the background of the descendants of the item in the Outliner.
Reimplemented in AzToolsFramework::LayerUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Paints the background of the descendant branches of the item in the Outliner.
Reimplemented in AzToolsFramework::LayerUiHandler.
|
virtual |
Paints visual elements on the foreground of the descendants of the item in the Outliner.
Reimplemented in AzToolsFramework::LayerUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Paints the background of the item in the Outliner.
Reimplemented in AzToolsFramework::LayerUiHandler, AzToolsFramework::LevelRootUiHandler, and AzToolsFramework::PrefabUiHandler.
|
virtual |
Paints visual elements on the foreground of the item in the Outliner.
Reimplemented in AzToolsFramework::PrefabUiHandler.