# rbdl/rbdl-toolkit architecture

> Architecture diagram of the GitHub repository rbdl/rbdl-toolkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rbdl/rbdl-toolkit
- Repository: https://github.com/rbdl/rbdl-toolkit

## Overview

##### Project type and purpose
- This is a desktop GUI application (“RBDL-Toolkit”) for visualizing rigid body dynamics data.
- Built on top of the RBDL physics library, uses Qt3D for 3D rendering, and is highly extensible via a plugin framework.
- Primary goal: load models (Lua or URDF), run or display dynamics, and allow custom analyses or visual augmentations via plugins.

##### High-level architectural layers
- Core Application Layer
- Model I/O & Dynamics Layer
- Rendering & UI Layer
- Plugin Framework Layer
- Data & Assets Layer
- External Dependencies Layer
- Build & Deployment Pipeline

a. Core Application
- ToolkitApp (entry point, src/main.cc)
- ToolkitSettings (configuration management)
- PluginManager (discovers/loads `plugins/*/*.so` or `.dll`)
- Timeline (animation controller)
- Qt UI dialogs (ModelSelectorDialog, SceneWidget, VectorEditor, etc.)
b. Model Loader & Dynamics
- LuaModelWrapper & URDFModelWrapper (conversion to internal format)
- CSV/Parser modules (csv_input_sanatiser, parser.hpp)
- RBDLWrapper (bridges to RBDL library for dynamics computation)
c. Rendering Engine
- Qt3D backend (SceneWidget, render_util)
- Mesh loader (reads from `meshes/`)
d. Plugin Framework
- toolkit_interfaces.h (defines extension points)
- metadata.json (plugin descriptors)
- Several plugins under `plugins/` (AnimationPlugin, ForceTorquePlugin, RenderPlugin, etc.)
e. Data & Assets
- Mesh files (`meshes/`)
- Sample inputs (`examples/`)
f. External Dependencies
- RBDL (found via cmake/FindEigen3.cmake, FindIFW.cmake)
- Qt (Widgets, Qt3D, Core)
- Eigen (math)
- Installer Frameworks (for packaging)
g. Build & Deployment
- CMake scripts (CMakeLists.txt, cmake/)
- CI configs (.github/workflows/cmake_cpp.yml, Jenkinsfile)
- Packaging scripts (`extra/`): mk_appimage.sh, mk_dmg.sh, snapcraft.yaml, etc.

- User → Core App UI → PluginManager
- PluginManager ↔ Plugins (dynamic discovery & API calls)
- Core App → Model Loader → RBDLWrapper → RBDL Engine
- RBDL Engine → Dynamics results → SceneGraph
- SceneGraph → Qt3D Renderer → Screen
- Plugins can inject new nodes into SceneGraph or pop up UI dialogs
- Data store (meshes/ examples/) → Model Loader & Renderer
- Settings ↔ ToolkitSettings (persistent config)

##### Architectural patterns & principles
- Plugin Architecture: loose coupling via well-defined C++ interfaces + JSON metadata
- MVC/MVVM elements: separation between data (model loader & RBDL), view (Qt UI + Qt3D), and control (Timeline, Plugin callbacks)
- Modular build: each plugin and core app is a separate CMake target

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Actor
    User(["User"]):::external

    %% Core Application Layer
    subgraph "Core Application Layer"
        ToolkitApp["ToolkitApp"]:::core
        ToolkitSettings["ToolkitSettings"]:::core
        Timeline["Timeline"]:::core
        ModelSelectorDialog["ModelSelectorDialog"]:::core
        SceneWidget["SceneWidget"]:::core
        VectorEditor["VectorEditor"]:::core
        VariantDelegate["VariantDelegate"]:::core
        PluginManager["PluginManager"]:::core
    end

    %% Model I/O & Dynamics Layer
    subgraph "Model I/O & Dynamics Layer"
        LuaLoader["LuaModelWrapper"]:::core
        URDFLoader["URDFModelWrapper"]:::core
        CSVSanitizer["csv_input_sanatiser"]:::core
        ParserUtil["parser.hpp"]:::core
        RBDLWrapper["RBDLWrapper"]:::core
    end

    %% Rendering & UI Layer
    subgraph "Rendering & UI Layer"
        RenderUtil["render_util"]:::core
        Screen(["Screen"]):::external
    end

    %% Plugin Framework Layer
    subgraph "Plugin Framework Layer"
        Interfaces["toolkit_interfaces.h"]:::plugin
        Metadata["metadata.json"]:::plugin
        PkgCMake["plugins/CMakeLists.txt"]:::plugin
        subgraph "Plugins"
            AnimationPlugin["AnimationPlugin"]:::plugin
            CameraPlugin["CameraOperatorPlugin"]:::plugin
            ForcePlugin["ForceTorquePlugin"]:::plugin
            IKPlugin["InverseKinematicsPlugin"]:::plugin
            MarkerPlugin["MotionMarkerPlugin"]:::plugin
            RenderPlugin["RenderPlugin"]:::plugin
            VisualExtras["VisualExtrasPlugin"]:::plugin
        end
    end

    %% Data & Assets Layer
    subgraph "Data & Assets Layer"
        Meshes["meshes/"]:::data
        Examples["examples/"]:::data
    end

    %% External Dependencies Layer
    subgraph "External Dependencies Layer"
        EigenFind["FindEigen3.cmake"]:::external
        IFWFind["FindIFW.cmake"]:::external
        QtDep["Qt (Widgets, Qt3D, Core)"]:::external
        RBDLDep["RBDL"]:::external
        EigenDep["Eigen"]:::external
    end

    %% Build & Deployment Pipeline
    subgraph "Build & Deployment Pipeline"
        TopCMake["CMakeLists.txt"]:::build
        CMakeModules["cmake/"]:::build
        CIConfigs["CI configs"]:::build
        Packaging["extra/"]:::build
        Snap["snapcraft.yaml"]:::build
    end

    %% Relationships
    User --> ToolkitApp
    ToolkitApp -->|uses| ToolkitSettings
    ToolkitApp -->|controls| Timeline
    ToolkitApp -->|opens UI| ModelSelectorDialog
    ToolkitApp -->|renders| SceneWidget
    ToolkitApp -->|opens UI| VectorEditor
    ToolkitApp -->|uses| VariantDelegate
    ToolkitApp --> PluginManager

    ToolkitSettings -->|persists| ToolkitSettings
    PluginManager --> Interfaces
    PluginManager --> Metadata
    PluginManager <--> AnimationPlugin
    PluginManager <--> CameraPlugin
    PluginManager <--> ForcePlugin
    PluginManager <--> IKPlugin
    PluginManager <--> MarkerPlugin
    PluginManager <--> RenderPlugin
    PluginManager <--> VisualExtras

    ToolkitApp --> LuaLoader
    ToolkitApp --> URDFLoader
    LuaLoader --> RBDLWrapper
    URDFLoader --> RBDLWrapper
    CSVSanitizer --> RBDLWrapper
    ParserUtil --> RBDLWrapper
    RBDLWrapper --> RBDLDep
    RBDLWrapper --> SceneWidget

    SceneWidget --> RenderUtil
    RenderUtil --> QtDep
    RenderUtil --> Screen

    Meshes --> LuaLoader
    Meshes --> URDFLoader
    Meshes --> RenderUtil
    Examples --> LuaLoader
    Examples --> URDFLoader

    TopCMake --> CMakeModules
    CMakeModules --> EigenFind
    CMakeModules --> IFWFind
    TopCMake --> CIConfigs
    TopCMake --> Packaging
    TopCMake --> Snap

    %% Click Events
    click ToolkitApp "https://github.com/rbdl/rbdl-toolkit/blob/master/src/main.cc"
    click ToolkitSettings "https://github.com/rbdl/rbdl-toolkit/blob/master/src/ToolkitSettings.cc"
    click ToolkitSettings "https://github.com/rbdl/rbdl-toolkit/blob/master/include/ToolkitSettings.h"
    click Timeline "https://github.com/rbdl/rbdl-toolkit/blob/master/src/Timeline.cc"
    click Timeline "https://github.com/rbdl/rbdl-toolkit/blob/master/include/Timeline.h"
    click Timeline "https://github.com/rbdl/rbdl-toolkit/blob/master/ui/Timeline.ui"
    click ModelSelectorDialog "https://github.com/rbdl/rbdl-toolkit/blob/master/src/ModelSelectorDialog.cc"
    click ModelSelectorDialog "https://github.com/rbdl/rbdl-toolkit/blob/master/include/ModelSelectorDialog.h"
    click ModelSelectorDialog "https://github.com/rbdl/rbdl-toolkit/blob/master/ui/ModelSelector.ui"
    click SceneWidget "https://github.com/rbdl/rbdl-toolkit/blob/master/src/SceneWidget.cc"
    click SceneWidget "https://github.com/rbdl/rbdl-toolkit/blob/master/include/SceneWidget.h"
    click SceneWidget "https://github.com/rbdl/rbdl-toolkit/blob/master/ui/SceneGroupList.ui"
    click VectorEditor "https://github.com/rbdl/rbdl-toolkit/blob/master/include/VectorEditor.h"
    click VectorEditor "https://github.com/rbdl/rbdl-toolkit/blob/master/ui/VectorEditor.ui"
    click VariantDelegate "https://github.com/rbdl/rbdl-toolkit/blob/master/include/VariantDelegate.h"
    click VariantDelegate "https://github.com/rbdl/rbdl-toolkit/blob/master/src/variantdelegate.cc"
    click Interfaces "https://github.com/rbdl/rbdl-toolkit/blob/master/include/toolkit_interfaces.h"
    click Metadata "https://github.com/rbdl/rbdl-toolkit/blob/master/plugins/*/metadata.json"
    click PkgCMake "https://github.com/rbdl/rbdl-toolkit/blob/master/plugins/CMakeLists.txt"
    click AnimationPlugin "https://github.com/rbdl/rbdl-toolkit/tree/master/plugins/AnimationPlugin"
    click CameraPlugin "https://github.com/rbdl/rbdl-toolkit/tree/master/plugins/CameraOperatorPlugin"
    click ForcePlugin "https://github.com/rbdl/rbdl-toolkit/tree/master/plugins/ForceTorquePlugin"
    click IKPlugin "https://github.com/rbdl/rbdl-toolkit/tree/master/plugins/InverseKinematicsPlugin"
    click MarkerPlugin "https://github.com/rbdl/rbdl-toolkit/tree/master/plugins/MotionMarkerPlugin"
    click RenderPlugin "https://github.com/rbdl/rbdl-toolkit/tree/master/plugins/RenderPlugin"
    click VisualExtras "https://github.com/rbdl/rbdl-toolkit/tree/master/plugins/VisualExtrasPlugin"
    click LuaLoader "https://github.com/rbdl/rbdl-toolkit/blob/master/src/luamodel_wrapper.cc"
    click LuaLoader "https://github.com/rbdl/rbdl-toolkit/blob/master/include/luamodel_wrapper.h"
    click URDFLoader "https://github.com/rbdl/rbdl-toolkit/blob/master/src/urdfmodel_wrapper.cc"
    click URDFLoader "https://github.com/rbdl/rbdl-toolkit/blob/master/include/urdfmodel_wrapper.h"
    click CSVSanitizer "https://github.com/rbdl/rbdl-toolkit/blob/master/include/csv_input_sanatiser.hpp"
    click ParserUtil "https://github.com/rbdl/rbdl-toolkit/blob/master/include/parser.hpp"
    click RBDLWrapper "https://github.com/rbdl/rbdl-toolkit/blob/master/src/rbdl_wrapper.cc"
    click RBDLWrapper "https://github.com/rbdl/rbdl-toolkit/blob/master/include/rbdl_wrapper.h"
    click RenderUtil "https://github.com/rbdl/rbdl-toolkit/blob/master/src/render_util.cc"
    click RenderUtil "https://github.com/rbdl/rbdl-toolkit/blob/master/include/render_util.h"
    click Meshes "https://github.com/rbdl/rbdl-toolkit/tree/master/meshes/"
    click Examples "https://github.com/rbdl/rbdl-toolkit/tree/master/examples/"
    click EigenFind "https://github.com/rbdl/rbdl-toolkit/blob/master/cmake/FindEigen3.cmake"
    click IFWFind "https://github.com/rbdl/rbdl-toolkit/blob/master/cmake/FindIFW.cmake"
    click TopCMake "https://github.com/rbdl/rbdl-toolkit/blob/master/CMakeLists.txt"
    click CMakeModules "https://github.com/rbdl/rbdl-toolkit/tree/master/cmake/"
    click CIConfigs "https://github.com/rbdl/rbdl-toolkit/blob/master/.github/workflows/cmake_cpp.yml"
    click CIConfigs "https://github.com/rbdl/rbdl-toolkit/tree/master/Jenkinsfile"
    click Packaging "https://github.com/rbdl/rbdl-toolkit/tree/master/extra/"
    click Snap "https://github.com/rbdl/rbdl-toolkit/blob/master/snap/snapcraft.yaml"

    %% Styles
    classDef core fill:#D0E8FF,stroke:#0366d6,stroke-width:2px
    classDef plugin fill:#DFF2BF,stroke:#4F8A10,stroke-width:2px
    classDef data fill:#FFF2CC,stroke:#BF9000,stroke-width:2px
    classDef external fill:#E3E3E3,stroke:#666666,stroke-width:2px
    classDef build fill:#E8D0FF,stroke:#6B24A3,stroke-width:2px
```
