class MAGES::SceneGraph::Editor::ActionWizardFactory¶

Overview¶

The base class for all action wizard factories. More…

class ActionWizardFactory: public VisualElement
{
public:
    // properties

    int StepCount;
    string Title;
    string ActionName;
    SceneGraphView View;
    Button InternalNextButton;

    // methods

    string GetStepName(int index);
    void Initialize();
    VisualElement CreateStepUI(int index);
    IActionImplementor Finish();
    virtual void ClearAction();
    virtual void UndoStep(int index);
    virtual void OnDestroy();
};

// direct descendants

class InsertActionWizard;
class QuestionActionWizard;
class RemoveActionWizard;
class UseActionWizard;

Detailed Documentation¶

The base class for all action wizard factories.

Properties¶

int StepCount

Gets the amount of steps in the wizard.

string Title

Gets the title of the wizard.

string ActionName

Gets or sets the name of the action.

SceneGraphView View

Gets or sets the scene graph view.

Button InternalNextButton

Sets the next button.

Methods¶

string GetStepName(int index)

Gets the name of the step at the given index.

Parameters:

index	The step index.

Returns:

The name of the step.

void Initialize()

Initializes the wizard.

VisualElement CreateStepUI(int index)

Creates the UI for the step at the given index.

Parameters:

index	The index.

Returns:

The generated visual element.

IActionImplementor Finish()

Finalizes the wizard.

Returns:

The action data.

virtual void ClearAction()

Clears the action.

virtual void UndoStep(int index)

Undoes the step at the given index.

Parameters:

index	The Index.

virtual void OnDestroy()

Called when the wizard is destroyed.