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.
Public Member Functions | List of all members
AzToolsFramework::LevelRootUiHandler Class Reference

Inherits AzToolsFramework::EditorEntityUiHandlerBase.

Public Member Functions

 AZ_CLASS_ALLOCATOR (LevelRootUiHandler, AZ::SystemAllocator)
 
 AZ_RTTI (AzToolsFramework::LevelRootUiHandler, "{B1D3B270-CD29-4033-873A-D78E76AB24A4}", EditorEntityUiHandlerBase)
 
QIcon GenerateItemIcon (AZ::EntityId entityId) const override
 Returns the item icon pixmap to display in the Outliner.
 
QString GenerateItemInfoString (AZ::EntityId entityId) const override
 Returns the item info string that is appended to the item name 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.
 
bool CanRename (AZ::EntityId entityId) const override
 Returns whether the element's name should be editable.
 
void PaintItemBackground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Paints the background 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
 
- 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

- Static Protected Member Functions inherited from AzToolsFramework::EditorEntityUiHandlerBase
static AZ::EntityId GetEntityIdFromIndex (const QModelIndex &index)
 

Member Function Documentation

◆ CanRename()

bool AzToolsFramework::LevelRootUiHandler::CanRename ( AZ::EntityId  entityId) const
overridevirtual

Returns whether the element's name should be editable.

Reimplemented from AzToolsFramework::EditorEntityUiHandlerBase.

◆ CanToggleLockVisibility()

bool AzToolsFramework::LevelRootUiHandler::CanToggleLockVisibility ( AZ::EntityId  entityId) const
overridevirtual

Returns whether the element's lock and visibility state should be accessible in the Outliner.

Reimplemented from AzToolsFramework::EditorEntityUiHandlerBase.

◆ GenerateItemIcon()

QIcon AzToolsFramework::LevelRootUiHandler::GenerateItemIcon ( AZ::EntityId  entityId) const
overridevirtual

Returns the item icon pixmap to display in the Outliner.

Reimplemented from AzToolsFramework::EditorEntityUiHandlerBase.

◆ GenerateItemInfoString()

QString AzToolsFramework::LevelRootUiHandler::GenerateItemInfoString ( AZ::EntityId  entityId) const
overridevirtual

Returns the item info string that is appended to the item name in the Outliner.

Reimplemented from AzToolsFramework::EditorEntityUiHandlerBase.

◆ OnOutlinerItemClick()

bool AzToolsFramework::LevelRootUiHandler::OnOutlinerItemClick ( const QPoint &  position,
const QStyleOptionViewItem &  option,
const QModelIndex &  index 
) const
overridevirtual

Triggered when the entity is clicked in the Outliner.

Returns
True if the click has been handled and should not be propagated, false otherwise.

Reimplemented from AzToolsFramework::EditorEntityUiHandlerBase.

◆ OnOutlinerItemDoubleClick()

bool AzToolsFramework::LevelRootUiHandler::OnOutlinerItemDoubleClick ( const QModelIndex &  index) const
overridevirtual

Triggered when the entity is double-clicked in the Outliner.

Returns
True if the double-click has been handled and should not be propagated, false otherwise.

Reimplemented from AzToolsFramework::EditorEntityUiHandlerBase.

◆ PaintItemBackground()

void AzToolsFramework::LevelRootUiHandler::PaintItemBackground ( QPainter *  painter,
const QStyleOptionViewItem &  option,
const QModelIndex &  index 
) const
overridevirtual

Paints the background of the item in the Outliner.

Reimplemented from AzToolsFramework::EditorEntityUiHandlerBase.

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