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

Overview¶

The base class for all action wizard factories. More…

class ActionWizardFactory: public VisualElement
{
public:
    // properties

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

    // methods

    virtual abstract string GetStepName(int index) = 0;
    virtual abstract void Initialize() = 0;
    virtual abstract VisualElement CreateStepUI(int index) = 0;
    virtual abstract IActionImplementor Finish() = 0;
    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¶

abstract int StepCount

Gets the amount of steps in the wizard.

abstract 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¶

virtual abstract string GetStepName(int index) = 0

Gets the name of the step at the given index.

Parameters:

index	The step index.

Returns:

The name of the step.

virtual abstract void Initialize() = 0

Initializes the wizard.

virtual abstract VisualElement CreateStepUI(int index) = 0

Creates the UI for the step at the given index.

Parameters:

index	The index.

Returns:

The generated visual element.

virtual abstract IActionImplementor Finish() = 0

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.