#include <ViewportUiRequestBus.h>
Public Member Functions | |
virtual const ClusterId | CreateCluster (Alignment align)=0 |
Creates and registers a cluster with the Viewport UI system. | |
virtual const SwitcherId | CreateSwitcher (Alignment align)=0 |
Creates and registers a switcher with the Viewport UI system. | |
virtual void | SetClusterActiveButton (ClusterId clusterId, ButtonId buttonId)=0 |
Sets the active button of the cluster. This is the button which will display as highlighted. | |
virtual void | SetClusterDisableButton (ClusterId clusterId, ButtonId buttonId, bool disabled)=0 |
Disables the Cluster Button. This button won't be clickable by the user. | |
virtual void | ClearClusterActiveButton (ClusterId clusterId)=0 |
Clears the active button of the cluster if one is active. The button will no longer display as highlighted. | |
virtual void | SetSwitcherActiveButton (SwitcherId switcherId, ButtonId buttonId)=0 |
Sets the active button of the switcher. This is the button which has a text label. | |
virtual void | SetSwitcherDisableButton (SwitcherId switcherId, ButtonId buttonId, bool disabled)=0 |
Disables the Switcher button of the switcher. This button won't be clickable by the user. | |
virtual void | SetClusterButtonLocked (ClusterId clusterId, ButtonId buttonId, bool isLocked)=0 |
Adds a locked overlay to the cluster button's icon. | |
virtual void | SetClusterButtonTooltip (ClusterId clusterId, ButtonId buttonId, const AZStd::string &tooltip)=0 |
Updates/sets the cluster button's tooltip to the passed string. | |
virtual void | SetSwitcherButtonTooltip (SwitcherId switcherId, ButtonId buttonId, const AZStd::string &tooltip)=0 |
Updates/sets the switcher button's tooltip to the passed string. | |
virtual const ButtonId | CreateClusterButton (const ClusterId clusterId, const AZStd::string &icon)=0 |
Registers a new button onto a cluster. | |
virtual const ButtonId | CreateSwitcherButton (SwitcherId switcherId, const AZStd::string &icon, const AZStd::string &name=AZStd::string())=0 |
Registers a new button onto a switcher. | |
virtual void | RegisterClusterEventHandler (ClusterId clusterId, AZ::Event< ButtonId >::Handler &handler)=0 |
Registers an event handler to handle events from the cluster. | |
virtual void | RegisterSwitcherEventHandler (SwitcherId switcherId, AZ::Event< ButtonId >::Handler &handler)=0 |
Registers an event handler to handle events from the cluster. | |
virtual void | RemoveCluster (ClusterId clusterId)=0 |
Removes a cluster from the Viewport UI system. | |
virtual void | RemoveSwitcher (SwitcherId switcherId)=0 |
Removes a switcher from the Viewport UI system. | |
virtual void | RemoveSwitcherButton (SwitcherId switcherId, ButtonId buttonId)=0 |
Removes a button from a switcher. | |
virtual void | SetClusterVisible (ClusterId clusterId, bool visible)=0 |
Sets the visibility of the cluster. | |
virtual void | SetSwitcherVisible (SwitcherId switcherId, bool visible)=0 |
Sets the visibility of the switcher. | |
virtual void | SetClusterGroupVisible (const AZStd::vector< ClusterId > &clusterGroup, bool visible)=0 |
Sets the visibility of multiple clusters. | |
virtual const TextFieldId | CreateTextField (const AZStd::string &labelText, const AZStd::string &textFieldDefaultText, TextFieldValidationType validationType)=0 |
Creates and registers a text field with the Viewport UI system. | |
virtual void | SetTextFieldText (TextFieldId textFieldId, const AZStd::string &text)=0 |
Set the text that will go inside the text field. | |
virtual void | RegisterTextFieldCallback (TextFieldId textFieldId, AZ::Event< AZStd::string >::Handler &handler)=0 |
Register an event handler to handle when the text field text changes. | |
virtual void | RemoveTextField (TextFieldId textFieldId)=0 |
Removes a text field from the Viewport UI system. | |
virtual void | SetTextFieldVisible (TextFieldId textFieldId, bool visible)=0 |
Sets the visibility of the text field. | |
virtual void | CreateViewportBorder (const AZStd::string &borderTitle, AZStd::optional< ViewportUiBackButtonCallback > backButtonCallback)=0 |
Create the highlight border with optional back button to exit the given editor mode. | |
virtual bool | GetViewportBorderVisible () const =0 |
Returns if the viewport border is visible. | |
virtual void | ChangeViewportBorderText (const AZStd::string &borderTitle)=0 |
Changes the text on the viewport border while in component mode. | |
virtual void | RemoveViewportBorder ()=0 |
Remove the viewport border. | |
virtual void | PressButton (ClusterId clusterId, ButtonId buttonId)=0 |
Invoke a button press on a cluster. | |
virtual void | PressButton (SwitcherId switcherId, ButtonId buttonId)=0 |
Invoke a button press on a switcher. | |
Viewport requests to interact with the Viewport UI. Viewport UI refers to the entire UI overlay (one per viewport). Each widget on the Viewport UI is referred to as an element.