class MAGES::SceneGraph::Editor::MAGESPanelScenegraphPage

Overview

A page to be used along with the scenegraph editor. More…

class MAGESPanelScenegraphPage: public MAGES::Editor::BaseMAGESPanelPage
{
public:
    // classes

    class TitleContent;

    // properties

    override int Order;
    override SideNavigationBarPlacement NavigationBarPlacement;
    override bool ShowBundleSelectionUI;
    override bool RequiresBundleSelection;
    override VisualElement Title;

    // methods

    virtual override void Initialize(MAGESPanel panel);
    virtual override bool TrySelect(Bundle selectedBundle);
    virtual override VisualElement CreateGUI(Bundle selectedBundle);
    virtual override void OnSelectedBundleChanged(Bundle newSelection);
    virtual override void Destroy();
};

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

A page to be used along with the scenegraph editor.

This page hosts tools like the WizardMainPanel to guide the user in creating faster and easier scenegraph actions.

Methods

virtual override void Initialize(MAGESPanel panel)

Called when the MAGES Panel is opened.

Parameters:

panel

The panel that initialized this page.

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 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.

virtual override void Destroy()

Called when the panel is destroyed.