GraphListenerQListView
<description>The `GraphListenerQListView` is part of the SOFA framework's Qt module and inherits from the `MutationListener` class, indicating its role in listening to changes in the simulation graph. This component serves as an interface that connects the SOFA scene graph with a Qt QTreeView widget, allowing users to visualize and interact with the hierarchy of nodes and objects within a simulation. ### Interactions with Other Components: - The `GraphListenerQListView` interacts with other components through callback methods inherited from `MutationListener`. These methods are invoked whenever there are changes in the scene graph (e.g., adding or removing nodes, objects, slaves). - Methods such as `onBeginAddChild`, `onBeginRemoveChild`, `onBeginAddObject`, and `onBeginRemoveObject` enable it to react to structural modifications within the simulation. ### Practical Usage Guidance: - **Data Fields:** The component does not have any specific data fields, indicating that its state is likely managed through the methods provided by the `MutationListener` interface. - **Methods:** - `createItem(parent)`: Creates a QTreeWidgetItem for the given parent in the Qt view. - `onBeginAddChild`, `onBeginRemoveChild`, etc.: Respond to changes in the scene graph (add/remove nodes or objects). - `sleepChanged(node)`: Handles sleep state changes of nodes. - `addDatas(parent)` and `removeDatas(parent)`: Manage data associated with a given object. - `findObject(item)` and `findData(item)`: Retrieve corresponding SOFA objects or data from the Qt view items. In summary, `GraphListenerQListView` bridges the gap between the SOFA scene graph and a user interface, enabling dynamic visualization of simulation hierarchies through Qt widgets.</description>
- abstract
- `GraphListenerQListView` connects the SOFA scene graph with a Qt QTreeView widget, enabling dynamic visualization and interaction with the hierarchy of nodes and objects within a simulation.
- sheet
- # GraphListenerQListView **Overview:** `GraphListenerQListView` is part of the SOFA framework's Qt module and inherits from `MutationListener`. It serves as an interface to visualize and interact with the hierarchy of nodes and objects within a simulation through a Qt QTreeView widget. This component reacts to changes in the scene graph (e.g., adding or removing nodes, objects) by updating the UI accordingly. **Parameters and Data:** The component does not have any specific data fields; its state is managed through methods provided by the `MutationListener` interface. **Dependencies and Connections:** This component typically requires a Qt QTreeView widget to display the scene graph hierarchy. It interacts with other components in the SOFA simulation through callback methods inherited from `MutationListener`, which are invoked whenever there are changes in the scene graph (e.g., adding or removing nodes, objects). **Practical Notes:** The component does not perform any numerical computations related to FEM or variational principles. Its primary function is to handle visualization and interaction aspects of the simulation hierarchy through a Qt-based user interface.
- description
- <description>The `GraphListenerQListView` is part of the SOFA framework's Qt module and inherits from the `MutationListener` class, indicating its role in listening to changes in the simulation graph. This component serves as an interface that connects the SOFA scene graph with a Qt QTreeView widget, allowing users to visualize and interact with the hierarchy of nodes and objects within a simulation. ### Interactions with Other Components: - The `GraphListenerQListView` interacts with other components through callback methods inherited from `MutationListener`. These methods are invoked whenever there are changes in the scene graph (e.g., adding or removing nodes, objects, slaves). - Methods such as `onBeginAddChild`, `onBeginRemoveChild`, `onBeginAddObject`, and `onBeginRemoveObject` enable it to react to structural modifications within the simulation. ### Practical Usage Guidance: - **Data Fields:** The component does not have any specific data fields, indicating that its state is likely managed through the methods provided by the `MutationListener` interface. - **Methods:** - `createItem(parent)`: Creates a QTreeWidgetItem for the given parent in the Qt view. - `onBeginAddChild`, `onBeginRemoveChild`, etc.: Respond to changes in the scene graph (add/remove nodes or objects). - `sleepChanged(node)`: Handles sleep state changes of nodes. - `addDatas(parent)` and `removeDatas(parent)`: Manage data associated with a given object. - `findObject(item)` and `findData(item)`: Retrieve corresponding SOFA objects or data from the Qt view items. In summary, `GraphListenerQListView` bridges the gap between the SOFA scene graph and a user interface, enabling dynamic visualization of simulation hierarchies through Qt widgets.</description>
- maths
- The `GraphListenerQListView` is part of the SOFA framework's Qt module and serves as an interface to visualize and interact with the hierarchy of nodes and objects within a simulation through a Qt QTreeView widget. This component inherits from the `MutationListener` class, indicating its role in listening for changes in the simulation graph (e.g., adding or removing nodes, objects, slaves). It does not have any specific data fields or mathematical content, as its primary function is to handle the visualization and interaction aspects of the scene graph rather than performing computations related to the finite element method or variational principles. ### Role in the Global FEM Pipeline: - **Assembly:** The component plays no role in assembling matrices or vectors for the FEM system. - **Time Integration:** It does not perform any time integration steps, as it is concerned with the graphical representation of the simulation rather than numerical computations. - **Nonlinear Solve:** No nonlinear solve is performed by this component. - **Linear Solve:** This component does not participate in solving linear systems related to FEM. - **Constraint Handling and Mapping:** It does not handle constraints or mappings between objects; instead, it responds to changes in the scene graph structure through callback methods such as `onBeginAddChild`, `onBeginRemoveChild`, etc. ### Numerical Methods and Discretization Choices: - The component does not implement any numerical methods or discretization choices. It purely handles the visualization aspects of the simulation hierarchy. ### Variational/Lagrangian Mechanics Framework: - This component does not fit into the variational or Lagrangian mechanics framework, as it is focused on providing a user interface for interacting with and visualizing the scene graph. In summary, `GraphListenerQListView` bridges the gap between the SOFA scene graph and a Qt-based user interface, enabling dynamic visualization of simulation hierarchies without any direct involvement in mathematical or physical computations.
{
"name": "GraphListenerQListView",
"main": {
"name": "GraphListenerQListView",
"namespace": "sofa::qt",
"module": "sofa.qt.GraphListenerQListView.cpp",
"include": "sofa/qt/GraphListenerQListView.h",
"doc": "",
"inherits": [
"MutationListener"
],
"templates": [],
"data_fields": [],
"links": [],
"methods": [
{
"name": "createItem",
"return_type": "QTreeWidgetItem *",
"params": [
{
"name": "parent",
"type": "QTreeWidgetItem *"
}
],
"is_virtual": false,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "onBeginAddChild",
"return_type": "void",
"params": [
{
"name": "parent",
"type": "Node *"
},
{
"name": "child",
"type": "Node *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "onBeginRemoveChild",
"return_type": "void",
"params": [
{
"name": "parent",
"type": "Node *"
},
{
"name": "child",
"type": "Node *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "onBeginAddObject",
"return_type": "void",
"params": [
{
"name": "parent",
"type": "Node *"
},
{
"name": "object",
"type": "core::objectmodel::BaseObject *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "onBeginRemoveObject",
"return_type": "void",
"params": [
{
"name": "",
"type": "Node *"
},
{
"name": "object",
"type": "core::objectmodel::BaseObject *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "onBeginAddSlave",
"return_type": "void",
"params": [
{
"name": "master",
"type": "core::objectmodel::BaseObject *"
},
{
"name": "slave",
"type": "core::objectmodel::BaseObject *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "onBeginRemoveSlave",
"return_type": "void",
"params": [
{
"name": "master",
"type": "core::objectmodel::BaseObject *"
},
{
"name": "slave",
"type": "core::objectmodel::BaseObject *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "sleepChanged",
"return_type": "void",
"params": [
{
"name": "node",
"type": "Node *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "addDatas",
"return_type": "void",
"params": [
{
"name": "parent",
"type": "core::objectmodel::BaseObject *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "removeDatas",
"return_type": "void",
"params": [
{
"name": "parent",
"type": "core::objectmodel::BaseObject *"
}
],
"is_virtual": true,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "findObject",
"return_type": "core::objectmodel::Base *",
"params": [
{
"name": "item",
"type": "const QTreeWidgetItem *"
}
],
"is_virtual": false,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
},
{
"name": "findData",
"return_type": "core::objectmodel::BaseData *",
"params": [
{
"name": "item",
"type": "const QTreeWidgetItem *"
}
],
"is_virtual": false,
"is_pure_virtual": false,
"is_static": false,
"access": "public"
}
]
},
"desc": {
"description": "<description>The `GraphListenerQListView` is part of the SOFA framework's Qt module and inherits from the `MutationListener` class, indicating its role in listening to changes in the simulation graph. This component serves as an interface that connects the SOFA scene graph with a Qt QTreeView widget, allowing users to visualize and interact with the hierarchy of nodes and objects within a simulation.\n\n### Interactions with Other Components:\n- The `GraphListenerQListView` interacts with other components through callback methods inherited from `MutationListener`. These methods are invoked whenever there are changes in the scene graph (e.g., adding or removing nodes, objects, slaves).\n- Methods such as `onBeginAddChild`, `onBeginRemoveChild`, `onBeginAddObject`, and `onBeginRemoveObject` enable it to react to structural modifications within the simulation.\n\n### Practical Usage Guidance:\n- **Data Fields:** The component does not have any specific data fields, indicating that its state is likely managed through the methods provided by the `MutationListener` interface.\n- **Methods:**\n - `createItem(parent)`: Creates a QTreeWidgetItem for the given parent in the Qt view.\n - `onBeginAddChild`, `onBeginRemoveChild`, etc.: Respond to changes in the scene graph (add/remove nodes or objects).\n - `sleepChanged(node)`: Handles sleep state changes of nodes.\n - `addDatas(parent)` and `removeDatas(parent)`: Manage data associated with a given object.\n - `findObject(item)` and `findData(item)`: Retrieve corresponding SOFA objects or data from the Qt view items.\n\nIn summary, `GraphListenerQListView` bridges the gap between the SOFA scene graph and a user interface, enabling dynamic visualization of simulation hierarchies through Qt widgets.</description>"
},
"maths": {
"maths": "The `GraphListenerQListView` is part of the SOFA framework's Qt module and serves as an interface to visualize and interact with the hierarchy of nodes and objects within a simulation through a Qt QTreeView widget. This component inherits from the `MutationListener` class, indicating its role in listening for changes in the simulation graph (e.g., adding or removing nodes, objects, slaves). It does not have any specific data fields or mathematical content, as its primary function is to handle the visualization and interaction aspects of the scene graph rather than performing computations related to the finite element method or variational principles.\n\n### Role in the Global FEM Pipeline:\n- **Assembly:** The component plays no role in assembling matrices or vectors for the FEM system.\n- **Time Integration:** It does not perform any time integration steps, as it is concerned with the graphical representation of the simulation rather than numerical computations.\n- **Nonlinear Solve:** No nonlinear solve is performed by this component.\n- **Linear Solve:** This component does not participate in solving linear systems related to FEM.\n- **Constraint Handling and Mapping:** It does not handle constraints or mappings between objects; instead, it responds to changes in the scene graph structure through callback methods such as `onBeginAddChild`, `onBeginRemoveChild`, etc.\n\n### Numerical Methods and Discretization Choices:\n- The component does not implement any numerical methods or discretization choices. It purely handles the visualization aspects of the simulation hierarchy.\n\n### Variational/Lagrangian Mechanics Framework:\n- This component does not fit into the variational or Lagrangian mechanics framework, as it is focused on providing a user interface for interacting with and visualizing the scene graph.\n\nIn summary, `GraphListenerQListView` bridges the gap between the SOFA scene graph and a Qt-based user interface, enabling dynamic visualization of simulation hierarchies without any direct involvement in mathematical or physical computations."
},
"summary": {
"abstract": "`GraphListenerQListView` connects the SOFA scene graph with a Qt QTreeView widget, enabling dynamic visualization and interaction with the hierarchy of nodes and objects within a simulation.",
"sheet": "# GraphListenerQListView\n\n**Overview:**\n`GraphListenerQListView` is part of the SOFA framework's Qt module and inherits from `MutationListener`. It serves as an interface to visualize and interact with the hierarchy of nodes and objects within a simulation through a Qt QTreeView widget. This component reacts to changes in the scene graph (e.g., adding or removing nodes, objects) by updating the UI accordingly.\n\n**Parameters and Data:**\nThe component does not have any specific data fields; its state is managed through methods provided by the `MutationListener` interface.\n\n**Dependencies and Connections:**\nThis component typically requires a Qt QTreeView widget to display the scene graph hierarchy. It interacts with other components in the SOFA simulation through callback methods inherited from `MutationListener`, which are invoked whenever there are changes in the scene graph (e.g., adding or removing nodes, objects).\n\n**Practical Notes:**\nThe component does not perform any numerical computations related to FEM or variational principles. Its primary function is to handle visualization and interaction aspects of the simulation hierarchy through a Qt-based user interface."
}
}