class MAGES::Editor::MAGESPanelHubPage¶
Overview¶
The MAGES Panel Hub Page. More…
class MAGESPanelHubPage: public MAGES::Editor::BaseMAGESPanelPage { public: // classes class TitleContent; // properties override SideNavigationBarPlacement NavigationBarPlacement; override VisualElement Title; override int Order; // methods virtual override bool TrySelect(Bundle selectedBundle); virtual override void Initialize(MAGESPanel panel); virtual override VisualElement CreateGUI(Bundle selectedBundle); virtual override void OnSelectedBundleChanged(Bundle newSelection); };
Inherited Members¶
public:
// enums
enum SideNavigationBarPlacement;
// properties
bool Visible;
abstract VisualElement Title;
SideNavigationBarPlacement NavigationBarPlacement;
int Order;
bool ShowBundleSelectionUI;
bool RequiresBundleSelection;
// methods
virtual void Initialize(MAGESPanel panel);
virtual bool TrySelect(Bundle selectedBundle);
virtual VisualElement CreateGUI(Bundle selectedBundle);
virtual void Deselect();
virtual void Destroy();
virtual void OnSelectedBundleChanged(Bundle newSelection);
Detailed Documentation¶
The MAGES Panel Hub Page.
Methods¶
virtual override bool TrySelect(Bundle selectedBundle)
Called when the user clicks on this page’s button in the MAGES Panel side navigation.
Parameters:
selectedBundle |
The selected bundle in the panel. |
Returns:
true if the page can be selected.
virtual override void Initialize(MAGESPanel panel)
Called when the MAGES Panel is opened.
Parameters:
panel |
The panel that initialized this page. |
virtual override VisualElement CreateGUI(Bundle selectedBundle)
Called after being selected to show the page’s GUI.
Parameters:
selectedBundle |
The selected bundle in the panel. |
Returns:
The Page’s GUI.
virtual override void OnSelectedBundleChanged(Bundle newSelection)
Called when the user selects a new Bundle in the MAGES Panel.
Parameters:
newSelection |
The newly selected bundle. |