{
  "name": "GLPickHandler",
  "main": {
    "name": "GLPickHandler",
    "namespace": "sofa::qt",
    "module": "sofa.qt.GLPickHandler.cpp",
    "include": "sofa/qt/GLPickHandler.h",
    "doc": "",
    "inherits": [
      "PickHandler"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "allocateSelectionBuffer",
        "return_type": "void",
        "params": [
          {
            "name": "width",
            "type": "int"
          },
          {
            "name": "height",
            "type": "int"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "destroySelectionBuffer",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "findCollisionUsingColourCoding",
        "return_type": "gui::common::BodyPicked",
        "params": [
          {
            "name": "origin",
            "type": "const type::Vec3 &"
          },
          {
            "name": "direction",
            "type": "const type::Vec3 &"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `GLPickHandler` is part of the SOFA framework, specifically within the `sofa::qt` namespace. It inherits from the `PickHandler` class and is designed to handle picking operations in OpenGL contexts. The primary role of this component is to facilitate selection mechanisms using color coding for identifying objects under the cursor or along a specific ray in the 3D scene.\n\nIt interacts with other SOFA components through its methods, including `allocateSelectionBuffer`, which prepares a buffer for storing selections based on given dimensions (`width` and `height`), and `destroySelectionBuffer`, which cleans up this buffer. The method `findCollisionUsingColourCoding` is used to detect collisions using color coding techniques by providing an origin and direction vector.\n\nPractical usage involves setting up the selection buffer with appropriate dimensions, performing picking operations through color coding, and managing the buffer lifecycle efficiently."
  },
  "maths": {
    "maths": "The `GLPickHandler` is a utility component within the SOFA framework designed to handle picking operations in an OpenGL context. It does not contribute directly to the mathematical or physical aspects of FEM simulations, as its primary function is to facilitate user interactions with the graphical representation of the simulation.\n\n### Governing Equations and Operators:\n- **None**: The `GLPickHandler` does not implement any governing equations related to mass matrix $M$, stiffness matrix $K$, internal force $f_{\text{int}}$, residual $R$, etc. Its role is purely graphical and interactive, focusing on the identification of objects in a 3D scene.\n\n### Constitutive or Kinematic Laws Involved:\n- **None**: The component does not involve any constitutive laws (strain measures, stress tensors, hyperelastic potentials) or kinematic laws relevant to continuum mechanics or FEM formulations. Its operations are based on color coding and ray-tracing techniques for picking objects in the scene.\n\n### Role in the Global FEM Pipeline:\n- **None**: This component does not directly participate in any stages of the global FEM pipeline, such as assembly, time integration, nonlinear solve, linear solve, constraint handling, or mapping. Its role is external to the core simulation mechanics and focuses on user interaction through graphical means.\n\n### Numerical Methods or Discretization Choices:\n- **None**: The `GLPickHandler` does not encode any numerical methods or discretization choices pertinent to FEM simulations. It relies on OpenGL techniques for picking objects, such as color coding and ray-tracing, which are purely graphical operations.\n\n### Integration into the Broader Variational / Lagrangian Mechanics Framework:\n- **None**: The `GLPickHandler` is not integrated into the variational or Lagrangian mechanics framework of SOFA. It serves as a tool for user interaction with the simulation's visual output, providing functionalities to select and identify objects within the scene.\n\nIn summary, the `GLPickHandler` is a graphical utility component that does not contribute mathematical or physical content directly related to FEM simulations."
  },
  "summary": {
    "abstract": "The `GLPickHandler` facilitates picking operations in OpenGL contexts by allocating selection buffers and identifying objects using color coding techniques.",
    "sheet": "# GLPickHandler\n\n## Overview\n\nThe `GLPickHandler` is part of the SOFA framework, specifically within the `sofa::qt` namespace. It inherits from the `PickHandler` class and is designed to handle picking operations in OpenGL contexts. The primary role of this component is to facilitate selection mechanisms using color coding for identifying objects under the cursor or along a specific ray in the 3D scene.\n\n## Practical Notes\n\nThe `GLPickHandler` provides methods such as `allocateSelectionBuffer`, which prepares a buffer for storing selections based on given dimensions (`width` and `height`), and `destroySelectionBuffer`, which cleans up this buffer. The method `findCollisionUsingColourCoding` is used to detect collisions using color coding techniques by providing an origin and direction vector.\n\nPractical usage involves setting up the selection buffer with appropriate dimensions, performing picking operations through color coding, and managing the buffer lifecycle efficiently."
  }
}