Back

QSofaListView

sofa::qt::QSofaListView
SofaSceneGraphWidget
Abstract (AI generated)

QSofaListView is a Qt-based widget providing a list view to visualize and manage nodes in the SOFA scene graph.

Metadata
module
sofa.qt.QSofaListView.cpp
namespace
sofa::qt
include
sofa/qt/QSofaListView.h
inherits
  • SofaSceneGraphWidget
description

The QSofaListView component is primarily a user interface widget designed for visualizing and managing nodes within the SOFA scene graph. It does not directly contribute to the governing equations or operators involved in finite element simulations such as mass matrix M, stiffness matrix K, internal force f_int, residual R, etc., nor does it involve constitutive laws or kinematic laws related to deformable solids. Instead, its role is focused on providing an interface for users to interact with and manipulate nodes within the SOFA simulation environment.

Mathematical Content:

  • Governing Equations/Operators: None. QSofaListView does not implement or contribute directly to any governing equations used in FEM simulations.
  • Constitutive Laws/Kinematic Laws: None. This component is purely a visualization and interaction tool, without involvement in material behavior or kinematics.

Role in the Global FEM Pipeline:

  • QSofaListView does not play a role in assembly, time integration, nonlinear solve, linear solve, constraint handling, mapping, etc., within the context of the finite element method. Its primary function is to provide a list view and manage user interactions with nodes in the SOFA scene graph.

Numerical Methods/Discretization Choices:

  • None applicable for this component. It does not involve any numerical methods or discretization choices directly related to FEM simulations.

Variational/Lagrangian Mechanics Framework Fit:

  • QSofaListView operates outside the core computational mechanics framework, serving as a front-end tool for managing and visualizing nodes in the SOFA scene graph. It facilitates user interaction but does not participate in variational formulations or Lagrangian mechanics.

In summary, QSofaListView is a GUI component designed to provide visual and interactive management of nodes within the SOFA simulation environment. Its functionalities are related to managing visualization and user interactions rather than contributing directly to the mathematical or physical aspects of FEM simulations.

Methods
const QMetaObject * metaObject () virtual
void * qt_metacast (const char * ) virtual
int qt_metacall (QMetaObject::Call , int , void ** ) virtual
QString tr (const char * s, const char * c, int n)
GraphListenerQListView * getListener ()
void setPropertyWidget (QDisplayPropertyWidget * propertyWid)
void addInPropertyWidget (QTreeWidgetItem * item, bool clear)
const int getCurrentSelectedBases ()
void Clear (sofa::simulation::Node * rootNode)
void update ()
void setRoot (sofa::simulation::Node * )
SofaListViewAttribute getAttribute ()
void contextMenuEvent (QContextMenuEvent * event) virtual
void expandPathFrom (const int & pathes)
void getExpandedNodes (int & )
void loadObject (int path, double dx, double dy, double dz, double rx, double ry, double rz, double scale)
void Export ()
void CloseAllDialogs ()
void UpdateOpenedDialogs ()
void ExpandRootNodeOnly ()
void Close ()
void Lock (bool )
void RequestSaving (sofa::simulation::Node * )
void RequestExportOBJ (sofa::simulation::Node * node, bool exportMTL)
void RequestActivation (sofa::simulation::Node * , bool )
void RequestSleeping (sofa::simulation::Node * , bool )
void RootNodeChanged (sofa::simulation::Node * newroot, const char * newpath)
void NodeRemoved ()
void Updated ()
void NodeAdded ()
void focusChanged (sofa::core::objectmodel::BaseObject * )
void focusChanged (sofa::core::objectmodel::BaseNode * )
void dataModified (QString )
void SaveNode ()
void exportOBJ ()
void collapseNode ()
void expandNode ()
void modifyUnlock (void * Id)
void RemoveNode ()
void Modify ()
void openInEditor ()
void openInstanciation ()
void openImplementation ()
void copyFilePathToClipBoard ()
void DeactivateNode ()
void ActivateNode ()
void PutNodeToSleep ()
void WakeUpNode ()
void updateMatchingObjectmodel (QTreeWidgetItem * item, int )
void updateMatchingObjectmodel (QTreeWidgetItem * item)
void RunSofaRightClicked (const QPoint & point)
void RunSofaDoubleClicked (QTreeWidgetItem * item, int index)
void nodeNameModification (simulation::Node * )
void focusObject ()
void focusNode ()
void expandPath (const int & path)
void getExpandedNodes (QTreeWidgetItem * item, int & )
void collapseNode (QTreeWidgetItem * item)
void expandNode (QTreeWidgetItem * item)
void transformObject (sofa::simulation::Node * node, double dx, double dy, double dz, double rx, double ry, double rz, double scale)
bool isNodeErasable (core::objectmodel::BaseNode * node)
int collectNodesToChange (core::objectmodel::BaseNode * node) 
{
  "name": "QSofaListView",
  "namespace": "sofa::qt",
  "module": "sofa.qt.QSofaListView.cpp",
  "include": "sofa/qt/QSofaListView.h",
  "doc": "",
  "inherits": [
    "SofaSceneGraphWidget"
  ],
  "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": "getListener",
      "return_type": "GraphListenerQListView *",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "setPropertyWidget",
      "return_type": "void",
      "params": [
        {
          "name": "propertyWid",
          "type": "QDisplayPropertyWidget *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "addInPropertyWidget",
      "return_type": "void",
      "params": [
        {
          "name": "item",
          "type": "QTreeWidgetItem *"
        },
        {
          "name": "clear",
          "type": "bool"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getCurrentSelectedBases",
      "return_type": "const int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "Clear",
      "return_type": "void",
      "params": [
        {
          "name": "rootNode",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "update",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "setRoot",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getAttribute",
      "return_type": "SofaListViewAttribute",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "contextMenuEvent",
      "return_type": "void",
      "params": [
        {
          "name": "event",
          "type": "QContextMenuEvent *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "expandPathFrom",
      "return_type": "void",
      "params": [
        {
          "name": "pathes",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getExpandedNodes",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "loadObject",
      "return_type": "void",
      "params": [
        {
          "name": "path",
          "type": "int"
        },
        {
          "name": "dx",
          "type": "double"
        },
        {
          "name": "dy",
          "type": "double"
        },
        {
          "name": "dz",
          "type": "double"
        },
        {
          "name": "rx",
          "type": "double"
        },
        {
          "name": "ry",
          "type": "double"
        },
        {
          "name": "rz",
          "type": "double"
        },
        {
          "name": "scale",
          "type": "double"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "Export",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "CloseAllDialogs",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "UpdateOpenedDialogs",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ExpandRootNodeOnly",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "Close",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "Lock",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "bool"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "RequestSaving",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "RequestExportOBJ",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        },
        {
          "name": "exportMTL",
          "type": "bool"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "RequestActivation",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "sofa::simulation::Node *"
        },
        {
          "name": "",
          "type": "bool"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "RequestSleeping",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "sofa::simulation::Node *"
        },
        {
          "name": "",
          "type": "bool"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "RootNodeChanged",
      "return_type": "void",
      "params": [
        {
          "name": "newroot",
          "type": "sofa::simulation::Node *"
        },
        {
          "name": "newpath",
          "type": "const char *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "NodeRemoved",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "Updated",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "NodeAdded",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "focusChanged",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "sofa::core::objectmodel::BaseObject *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "focusChanged",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "sofa::core::objectmodel::BaseNode *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "dataModified",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "QString"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "SaveNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "exportOBJ",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "collapseNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "expandNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "modifyUnlock",
      "return_type": "void",
      "params": [
        {
          "name": "Id",
          "type": "void *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "RemoveNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "Modify",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "openInEditor",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "openInstanciation",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "openImplementation",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "copyFilePathToClipBoard",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "DeactivateNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "ActivateNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "PutNodeToSleep",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "WakeUpNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "updateMatchingObjectmodel",
      "return_type": "void",
      "params": [
        {
          "name": "item",
          "type": "QTreeWidgetItem *"
        },
        {
          "name": "",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "updateMatchingObjectmodel",
      "return_type": "void",
      "params": [
        {
          "name": "item",
          "type": "QTreeWidgetItem *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "RunSofaRightClicked",
      "return_type": "void",
      "params": [
        {
          "name": "point",
          "type": "const QPoint &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "RunSofaDoubleClicked",
      "return_type": "void",
      "params": [
        {
          "name": "item",
          "type": "QTreeWidgetItem *"
        },
        {
          "name": "index",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "nodeNameModification",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "simulation::Node *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "focusObject",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "focusNode",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "expandPath",
      "return_type": "void",
      "params": [
        {
          "name": "path",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "getExpandedNodes",
      "return_type": "void",
      "params": [
        {
          "name": "item",
          "type": "QTreeWidgetItem *"
        },
        {
          "name": "",
          "type": "int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "collapseNode",
      "return_type": "void",
      "params": [
        {
          "name": "item",
          "type": "QTreeWidgetItem *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "expandNode",
      "return_type": "void",
      "params": [
        {
          "name": "item",
          "type": "QTreeWidgetItem *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "transformObject",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        },
        {
          "name": "dx",
          "type": "double"
        },
        {
          "name": "dy",
          "type": "double"
        },
        {
          "name": "dz",
          "type": "double"
        },
        {
          "name": "rx",
          "type": "double"
        },
        {
          "name": "ry",
          "type": "double"
        },
        {
          "name": "rz",
          "type": "double"
        },
        {
          "name": "scale",
          "type": "double"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "isNodeErasable",
      "return_type": "bool",
      "params": [
        {
          "name": "node",
          "type": "core::objectmodel::BaseNode *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "collectNodesToChange",
      "return_type": "int",
      "params": [
        {
          "name": "node",
          "type": "core::objectmodel::BaseNode *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "QSofaListView is a Qt-based widget in the SOFA framework, inheriting from SofaSceneGraphWidget. It provides a list view for visualizing and managing nodes within the SOFA scene graph. This component includes methods for updating the view, handling context menus, setting root nodes, expanding/collapsing nodes, loading objects with specific transformations, exporting OBJ files, and various other operations related to node manipulation and visualization. The widget facilitates interaction through protected methods for internal logic such as modifying node properties, changing object states (like activation or sleeping), and updating the view based on changes in the scene graph.\n\nQSofaListView interacts with other components by receiving nodes from the simulation module and displaying them visually. It also manages user interactions that can trigger actions like loading, saving, and modifying nodes within the scene.",
  "maths": "The `QSofaListView` component is primarily a user interface widget designed for visualizing and managing nodes within the SOFA scene graph. It does not directly contribute to the governing equations or operators involved in finite element simulations such as mass matrix M, stiffness matrix K, internal force f_int, residual R, etc., nor does it involve constitutive laws or kinematic laws related to deformable solids. Instead, its role is focused on providing an interface for users to interact with and manipulate nodes within the SOFA simulation environment.\n\n### Mathematical Content:\n- **Governing Equations/Operators**: None. `QSofaListView` does not implement or contribute directly to any governing equations used in FEM simulations.\n- **Constitutive Laws/Kinematic Laws**: None. This component is purely a visualization and interaction tool, without involvement in material behavior or kinematics.\n\n### Role in the Global FEM Pipeline:\n- `QSofaListView` does not play a role in assembly, time integration, nonlinear solve, linear solve, constraint handling, mapping, etc., within the context of the finite element method. Its primary function is to provide a list view and manage user interactions with nodes in the SOFA scene graph.\n\n### Numerical Methods/Discretization Choices:\n- None applicable for this component. It does not involve any numerical methods or discretization choices directly related to FEM simulations.\n\n### Variational/Lagrangian Mechanics Framework Fit:\n- `QSofaListView` operates outside the core computational mechanics framework, serving as a front-end tool for managing and visualizing nodes in the SOFA scene graph. It facilitates user interaction but does not participate in variational formulations or Lagrangian mechanics.\n\nIn summary, `QSofaListView` is a GUI component designed to provide visual and interactive management of nodes within the SOFA simulation environment. Its functionalities are related to managing visualization and user interactions rather than contributing directly to the mathematical or physical aspects of FEM simulations.",
  "abstract": "QSofaListView is a Qt-based widget providing a list view to visualize and manage nodes in the SOFA scene graph.",
  "sheet": "<h1>QSofaListView</h1>\n\n<h2>Overview</h2>\n<p>QSofaListView is a Qt-based widget that inherits from <code>SofaSceneGraphWidget</code>. It provides a list view for visualizing and managing nodes within the SOFA scene graph. This component includes methods for updating the view, handling context menus, setting root nodes, expanding/collapsing nodes, loading objects with specific transformations, exporting OBJ files, and various other operations related to node manipulation and visualization.</p>\n\n<h2>Parameters and Data</h2>\n<p>The <code>QSofaListView</code> component does not expose any significant data fields. Its functionality is primarily driven by methods for managing the scene graph nodes and user interactions.</p>"
}