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::ViewportUi::ViewportUiManager Class Reference

Inherits ViewportUiRequestBus::Handler.

Inherited by UnitTest::ViewportUiManagerTestable.

Public Member Functions

const ClusterId CreateCluster (Alignment align) override
 
const SwitcherId CreateSwitcher (Alignment align) override
 
void SetClusterActiveButton (ClusterId clusterId, ButtonId buttonId) override
 
void SetClusterDisableButton (ClusterId clusterId, ButtonId buttonId, bool disabled) override
 
void ClearClusterActiveButton (ClusterId clusterId) override
 
void SetSwitcherActiveButton (SwitcherId switcherId, ButtonId buttonId) override
 
void SetSwitcherDisableButton (SwitcherId switcherId, ButtonId buttonId, bool disabled) override
 
void SetClusterButtonLocked (ClusterId clusterId, ButtonId buttonId, bool isLocked) override
 
void SetClusterButtonTooltip (ClusterId clusterId, ButtonId buttonId, const AZStd::string &tooltip) override
 
void SetSwitcherButtonTooltip (SwitcherId switcherId, ButtonId buttonId, const AZStd::string &tooltip) override
 
const ButtonId CreateClusterButton (ClusterId clusterId, const AZStd::string &icon) override
 
const ButtonId CreateSwitcherButton (SwitcherId switcherId, const AZStd::string &icon, const AZStd::string &name=AZStd::string()) override
 
void RegisterClusterEventHandler (ClusterId clusterId, AZ::Event< ButtonId >::Handler &handler) override
 
void RegisterSwitcherEventHandler (SwitcherId switcherId, AZ::Event< ButtonId >::Handler &handler) override
 
void RemoveCluster (ClusterId clusterId) override
 
void RemoveSwitcher (SwitcherId switcherId) override
 
void RemoveSwitcherButton (SwitcherId switcherId, ButtonId buttonId) override
 
void SetClusterVisible (ClusterId clusterId, bool visible) override
 
void SetSwitcherVisible (SwitcherId switcherId, bool visible) override
 
void SetClusterGroupVisible (const AZStd::vector< ClusterId > &clusterGroup, bool visible) override
 
const TextFieldId CreateTextField (const AZStd::string &labelText, const AZStd::string &textFieldDefaultText, TextFieldValidationType validationType) override
 
void SetTextFieldText (TextFieldId textFieldId, const AZStd::string &text) override
 
void RegisterTextFieldCallback (TextFieldId textFieldId, AZ::Event< AZStd::string >::Handler &handler) override
 
void RemoveTextField (TextFieldId textFieldId) override
 
void SetTextFieldVisible (TextFieldId textFieldId, bool visible) override
 
void CreateViewportBorder (const AZStd::string &borderTitle, AZStd::optional< ViewportUiBackButtonCallback > backButtonCallback) override
 
void ChangeViewportBorderText (const AZStd::string &borderTitle) override
 
void RemoveViewportBorder () override
 
bool GetViewportBorderVisible () const override
 
void PressButton (ClusterId clusterId, ButtonId buttonId) override
 
void PressButton (SwitcherId switcherId, ButtonId buttonId) override
 
void ConnectViewportUiBus (const int viewportId)
 Connects to the correct viewportId bus address.
 
void DisconnectViewportUiBus ()
 Disconnects from the viewport request bus.
 
void InitializeViewportUi (QWidget *parent, QWidget *renderOverlay)
 Initializes the Viewport UI by attaching it to the given parent and render overlay.
 
void Update ()
 Updates all registered elements to display up to date.
 

Protected Attributes

AZStd::unordered_map< ClusterId, AZStd::shared_ptr< Internal::ButtonGroup > > m_clusterButtonGroups
 A map of all registered Clusters.
 
AZStd::unordered_map< SwitcherId, AZStd::shared_ptr< Internal::ButtonGroup > > m_switcherButtonGroups
 A map of all registered Switchers.
 
AZStd::unordered_map< TextFieldId, AZStd::shared_ptr< Internal::TextField > > m_textFields
 A map of all registered TextFields.
 
AZStd::unique_ptr< Internal::ViewportUiDisplay > m_viewportUi
 The lower level graphical API for Viewport UI.
 

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