Methods

{
  "name": "SofaSceneGraphWidget",
  "namespace": "sofa::qt",
  "module": "sofa.qt.SofaSceneGraphWidget.cpp",
  "include": "sofa/qt/SofaSceneGraphWidget.h",
  "doc": "",
  "inherits": [],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "metaObject",
      "return_type": "const QMetaObject *",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "qt_metacast",
      "return_type": "void *",
      "params": [
        {
          "name": "",
          "type": "const char *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "qt_metacall",
      "return_type": "int",
      "params": [
        {
          "name": "",
          "type": "QMetaObject::Call"
        },
        {
          "name": "",
          "type": "int"
        },
        {
          "name": "",
          "type": "void **"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "tr",
      "return_type": "QString",
      "params": [
        {
          "name": "s",
          "type": "const char *"
        },
        {
          "name": "c",
          "type": "const char *"
        },
        {
          "name": "n",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "lock",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "unLock",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "isDirty",
      "return_type": "bool",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "isLocked",
      "return_type": "bool",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "setViewToDirty",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "dirtynessChanged",
      "return_type": "void",
      "params": [
        {
          "name": "isDirty",
          "type": "bool"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "lockingChanged",
      "return_type": "void",
      "params": [
        {
          "name": "isLocked",
          "type": "bool"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SofaSceneGraphWidget` is a Qt-based widget in the SOFA framework, part of the `sofa::qt` namespace. This component provides an interface for visualizing and interacting with scene graph structures within the SOFA ecosystem. It supports methods related to managing state such as locking and marking the widget as dirty, indicating changes that require updates. The widget communicates its dirtyness and locking states via signals (`dirtynessChanged`, `lockingChanged`), which can trigger necessary updates or actions in other parts of the application.\n\nThe component does not inherit from any specific class but implements standard Qt methods such as `metaObject`, `qt_metacast`, and `qt_metacall`. It also includes a static method `tr` for translating strings, consistent with Qt's internationalization support. The widget can be locked (`lock`) or unlocked (`unLock`) to prevent updates during specific operations, and its dirty state can be queried via the `isDirty` method.\n\nPractical usage involves embedding this widget into a larger application that leverages SOFA for simulation tasks, allowing users to visualize and interact with the scene graph in real-time. The locking mechanism is useful when performing batch updates or ensuring consistency during complex operations.",
  "maths": "The `SofaSceneGraphWidget` is a Qt-based widget that provides an interface for visualizing and interacting with the scene graph structures within the SOFA framework. It does not contribute to any mathematical or physical formulations related to finite element methods (FEM), constitutive laws, kinematic descriptions, or numerical discretizations used in simulations. Instead, it serves as a user interface component responsible for managing state and communicating updates through signals (`dirtynessChanged`, `lockingChanged`).\n\nThe widget supports operations such as locking (`lock`) and unlocking (`unLock`), which prevent updates during specific operations to ensure consistency. It also has methods to query the dirty state of the widget (`isDirty`) and to mark it as dirty (`setViewToDirty`), indicating that an update is necessary.\n\nIn summary, `SofaSceneGraphWidget` is a GUI component with no direct mathematical or physical content related to FEM simulations. Its role is primarily in providing visual interaction and state management within the SOFA ecosystem.",
  "abstract": "The `SofaSceneGraphWidget` provides an interface for visualizing and interacting with scene graph structures within the SOFA framework. It supports state management through locking and dirty status updates.",
  "sheet": "# SofaSceneGraphWidget\n\n**Overview**\n\nThe `SofaSceneGraphWidget` is a Qt-based widget that allows users to visualize and interact with scene graph structures in the SOFA framework. This component does not inherit from any specific class but implements standard Qt methods for state management.\n\n**Parameters and Data**\n\nThis component does not expose significant data fields; its functionality is primarily driven by method calls related to state management.\n\n**Practical Notes**\n\nThe widget supports locking (`lock`/`unLock`) operations to prevent updates during specific tasks, ensuring consistency. The `isDirty` and `setViewToDirty` methods manage the dirty status of the widget, indicating when an update is necessary. Signals such as `dirtynessChanged` and `lockingChanged` can be used to trigger actions in response to state changes."
}