Methods

{
  "name": "InspectorDock",
  "namespace": "Ui",
  "module": "sofa.qt.dockwidgets.InspectorDock.cpp",
  "include": "sofa/qt/dockwidgets/InspectorDock.h",
  "doc": "",
  "inherits": [
    "InspectorDock"
  ],
  "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": "setCurrentSelection",
      "return_type": "void",
      "params": [
        {
          "name": "base",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The **InspectorDock** is a user interface component within the SOFA framework, specifically designed for visualization and interaction purposes. It resides in the `Ui` namespace and is implemented in the `sofa.qt.dockwidgets.InspectorDock.cpp` module. This component extends the functionalities of Qt's dock widgets to provide an interactive dock widget that allows users to inspect and modify various properties and settings of SOFA simulation components.\n\nThe **InspectorDock** primarily interacts with other UI elements within the SOFA framework, such as selection mechanisms and property editors. It provides a central hub where users can interactively set or view the current selected items in the simulation scene.\n\nThe `setCurrentSelection` method is used to update the currently selected item in the inspector dock, reflecting changes in user selections within the UI. This method ensures that the dock displays relevant information and controls for the selected object, enabling fine-grained control over the simulation's components.\n\nOverall, **InspectorDock** serves as a critical interface element in SOFA, enhancing usability by providing an intuitive way to interact with and modify simulation parameters.",
  "maths": "The **InspectorDock** is a user interface (UI) component within the SOFA framework, which does not directly contribute to any mathematical or physical equations in the context of finite element method (FEM) simulations. Instead, it serves as an interactive dock widget that enables users to inspect and modify properties and settings of various simulation components within the SOFA scene graph. This component is primarily concerned with visualization and interaction rather than numerical computation or mechanics formulation.\n\n**Role in the FEM Pipeline:**\nThe **InspectorDock** does not participate directly in any part of the global FEM pipeline, such as assembly, time integration, nonlinear solve, linear solve, constraint handling, or mapping. It is an auxiliary tool that provides a user-friendly interface for interacting with the simulation environment and its components.\n\n**Numerical Methods / Discretization Choices:**\nThe **InspectorDock** does not encode any specific numerical methods or discretization choices as it is not involved in the computational aspects of FEM simulations. Its primary function is to facilitate interaction with the simulation through a graphical interface, allowing users to manipulate and visualize the state of various simulation elements.\n\n**Fit into Variational / Lagrangian Mechanics Framework:**\nThe **InspectorDock** does not fit into the variational or Lagrangian mechanics framework as it is purely an interactive UI component. It does not implement any governing equations, constitutive laws, kinematic laws, constraints, or mappings that are part of the FEM simulation process.\n\nIn summary, the **InspectorDock** plays a role in enhancing user interaction and visualization within SOFA but has no direct mathematical or physical content related to FEM simulations.",
  "abstract": "InspectorDock provides an interactive dock widget for inspecting and modifying properties of simulation components in the SOFA framework.",
  "sheet": "# InspectorDock\n\n**Overview:**\nInspectorDock is a user interface component that extends Qt's dock widgets to provide an interactive dock for inspecting and modifying properties of various simulation components within the SOFA scene graph. It serves as a central hub for interaction with selected items in the simulation environment.\n\n**Dependencies and Connections:**\nInspectorDock interacts primarily with other UI elements such as selection mechanisms and property editors within the SOFA framework. It updates its content based on user selections, reflecting changes through methods like `setCurrentSelection` to ensure relevant information is displayed for the currently selected object."
}