Methods

{
  "name": "VisualModelPolicy",
  "namespace": "sofa::qt::viewer",
  "module": "sofa.qt.viewer.VisualModelPolicy.cpp",
  "include": "sofa/qt/viewer/VisualModelPolicy.h",
  "doc": "",
  "inherits": [],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "load",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "unload",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `VisualModelPolicy` is an abstract class in the SOFA framework's Qt viewer module (`sofa.qt.viewer`). It defines policies for visual model loading and unloading, crucial for rendering components within the simulation environment. The `load` and `unload` methods are pure virtual functions that must be implemented by any derived classes to handle specific visualization tasks. This component interacts with other SOFA components through these abstract methods, ensuring consistent behavior for different types of visual models in the Qt viewer.",
  "maths": "The `VisualModelPolicy` is an abstract class in the SOFA framework's Qt viewer module (`sofa.qt.viewer`). It does not directly contribute to the governing equations or operators used in finite element analysis (FEM) simulations. Instead, it defines policies for visual model loading and unloading, which are essential for rendering components within the simulation environment. The primary role of this component is to ensure consistent behavior for different types of visual models in the Qt viewer through its abstract methods `load` and `unload`. These methods are pure virtual functions that must be implemented by any derived classes to handle specific visualization tasks. As a result, `VisualModelPolicy` does not involve constitutive or kinematic laws, nor does it directly impact the global FEM pipeline stages such as assembly, time integration, nonlinear solve, linear solve, constraint handling, or mappings. The component's functionality is purely related to the rendering and visualization aspects of SOFA simulations.",
  "abstract": "The `VisualModelPolicy` defines policies for visual model loading and unloading in the SOFA Qt viewer, ensuring consistent behavior for different types of visual models.",
  "sheet": "# VisualModelPolicy\n\n## Overview\nThe `VisualModelPolicy` is an abstract class within the SOFA framework's Qt viewer module (`sofa.qt.viewer`). It defines policies for visual model loading and unloading, which are essential for rendering components within the simulation environment. This component ensures consistent behavior for different types of visual models through its pure virtual methods `load` and `unload`, which must be implemented by derived classes.\n\n## Dependencies and Connections\nThe `VisualModelPolicy` interacts with other SOFA components through its abstract methods, ensuring that any visualization task adheres to a consistent policy. Derived classes are expected to implement these methods to handle specific visualization tasks within the Qt viewer.\n\n## Practical Notes\nDerived classes must provide concrete implementations of the `load` and `unload` methods to ensure proper integration with the SOFA simulation environment. Careful implementation is required to maintain consistency across different visual models."
}