Instanciation des machines à états

Les machines à états créées dynamiquement et celles compilées se comportent de la même manière, possèdent les mêmes propriétés, états, modèle de données, etc. Elles ne diffèrent que par leur mode d’instanciation. Pour en créer une dynamiquement en C++ à partir d’un fichier SCXML, vous pouvez utiliser :

auto *stateMachine = QScxmlStateMachine::fromFile("MyStatemachine.scxml");

Ou, en QML :

import QtScxml

Item {
    property StateMachine stateMachine: scxmlLoader.stateMachine

    StateMachineLoader {
        id: scxmlLoader
        source: "statemachine.scxml"
    }
}

Une machine à états compilée peut être instanciée de la même manière que n'importe quel objet C++ :

auto *stateMachine = new MyStatemachine;

Ou bien :

MyStatemachine stateMachine;

Pour utiliser une machine à états compilée dans QML, vous pouvez l'enregistrer en tant que type QML :

struct MyStateMachineRegistration {
    Q_GADGET
    QML_NAMED_ELEMENT(MyStateMachine)
    QML_FOREIGN(MyStateMachine)
    QML_ADDED_IN_VERSION(1, 0)
};

Vous pouvez ensuite l'instancier dans QML, comme ceci :

import MyStateMachine 1.0

MyStateMachine {
    id: stateMachine
}

Pour compiler une machine à états, les lignes suivantes doivent être ajoutées au fichier de build du projet :

Si vous utilisez CMake :

find_package(Qt6 REQUIRED COMPONENTS Scxml)
target_link_libraries(mytarget PRIVATE Qt6::Scxml)

qt_add_statecharts(mytarget
    MyStatemachine.scxml
)

Lorsque vous utilisez qmake :

QT += scxml

STATECHARTS = MyStatemachine.scxml

Cela indiquera à qmake d'exécuter qscxmlc, qui génère les fichiers MyStatemachine.h et MyStatemachine.cpp, puis les ajoute aux en-têtes et aux sources du projet. Par défaut, les fichiers générés sont enregistrés dans le répertoire de compilation. La variable qmake QSCXMLC_DIR ou cmake OUTPUT_DIRECTORY peut être définie pour spécifier un autre répertoire. La variable qmake QSCXMLC_NAMESPACE ou cmake NAMESPACE peut être définie pour placer le code de la machine à états dans un espace de noms C++.

Après avoir instancié une machine à états, vous pouvez vous connecter à la propriété active de n’importe quel état comme suit. Par exemple, si la machine à états d’un feu de signalisation comporte un état indiquant que le feu est rouge (qui porte l’identifiant pratique « red » dans le fichier scxml), vous pouvez écrire :

stateMachine->connectToState("red", [](bool active) {
    qDebug() << (active ? "entered" : "exited") << "the red state";
});

Et en QML :

Light {
    id: greenLight
    color: "green"
    visible: stateMachine.green
}

Si vous souhaitez être averti lorsqu'une machine à états émet un événement, vous pouvez vous connecter au signal correspondant. Par exemple, pour une machine à états de lecteur multimédia qui indique que la lecture s'est arrêtée en émettant un événement, vous pouvez écrire :

stateMachine->connectToEvent("playbackStopped", [](const QScxmlEvent&){
    qDebug() << "Stopped!";
});

Et en QML :

import QtScxml

EventConnection {
    stateMachine: stateMachine
    events: ["playbackStopped"]
    onOccurred: console.log("Stopped!")
}

L'envoi d'événements à une machine à états est tout aussi simple :

stateMachine->submitEvent("tap", QVariantMap({
    { "artist", "Fatboy Slim" },
    { "title", "The Rockafeller Skank" }
}));

Cela générera un événement « tap » dont le contenu de la carte sera disponible dans _event.data au sein de la machine à états. En QML :

stateMachine.submitEvent("tap", {
    "artist": "Fatboy Slim"
    "title": "The Rockafeller Skank"
})