Methods

{
  "name": "OglShaderVisualModel",
  "namespace": "sofa::gl::component::shader",
  "module": "Sofa.GL.Component.Shader",
  "include": "sofa/gl/component/shader/OglShaderVisualModel.h",
  "doc": "Visual model for OpenGL display using a custom shader.",
  "inherits": [
    "OglModel"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "init",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doUpdateVisual",
      "return_type": "void",
      "params": [
        {
          "name": "vparams",
          "type": "const core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "bwdDraw",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "fwdDraw",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "handleTopologyChange",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "computeRestPositions",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "computeRestNormals",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `OglShaderVisualModel` is a visual model component in the SOFA framework designed for OpenGL display using custom shaders. It inherits from the `OglModel` class and serves to render graphical representations of simulation objects with customizable visual effects.\n\n### Role and Purpose:\nThe primary role of `OglShaderVisualModel` is to enable sophisticated visual rendering by allowing users to define their own shaders, which are small programs that run on a computer's graphics processing unit (GPU). This enhances the realism and interactivity of simulations, particularly in medical visualization scenarios.\n\n### Interactions with Other Components:\nThe component interacts primarily through its virtual methods such as `doUpdateVisual`, `bwdDraw`, and `fwdDraw`. These methods receive visual parameters from the SOFA core (`core::visual::VisualParams`) to update and render visual representations. Additionally, it handles topology changes via `handleTopologyChange` to ensure that the visual model remains consistent with any modifications in the underlying mechanical or geometric models.\n\n### Practical Usage Guidance:\nThe component does not have explicit data fields but relies on methods for initialization (`init`), updating visuals (`doUpdateVisual`), and drawing forwards/backwards (`fwdDraw`, `bwdDraw`). Users need to define custom shaders to leverage the full capabilities of this visual model. The methods `computeRestPositions` and `computeRestNormals` are available for calculating default positions and normals, respectively.\n\nOverall, `OglShaderVisualModel` facilitates advanced visualization techniques by integrating customizable OpenGL shaders into the SOFA simulation framework.",
  "maths": "The `OglShaderVisualModel` component in the SOFA framework is primarily concerned with graphical rendering rather than mathematical or physical simulation. It does not directly contribute to governing equations, constitutive laws, or numerical methods used for FEM simulations. Instead, it serves as a visual model that leverages OpenGL shaders to enhance the realism and interactivity of simulated objects.\n\n### Mathematical and Physical Description:\n\n#### Governing Equations and Operators\n- **Mass Matrix (M)**: Not applicable.\n- **Stiffness Matrix (K)**: Not applicable.\n- **Internal Force (\f$f_{\text{int}}\f$)**: Not applicable.\n- **Residual (\f$R\f$)**: Not applicable.\n\n#### Constitutive or Kinematic Laws\n- The `OglShaderVisualModel` does not implement any constitutive or kinematic laws related to the mechanical behavior of deformable bodies. It is purely a visual component that can be used to visualize the results of simulations.\n\n#### Role in FEM Pipeline\nThe `OglShaderVisualModel` plays no role in the core FEM pipeline stages such as assembly, time integration, nonlinear solve, linear solve, constraint handling, or mapping. Its primary function is to render the visual representation of simulation objects using custom OpenGL shaders.\n\n#### Numerical Methods and Discretization Choices\n- The component does not encode any numerical methods related to FEM discretization or solution techniques. Instead, it focuses on rendering graphical elements with customizable visual effects via shaders.\n\n#### Variational / Lagrangian Mechanics Framework\nThe `OglShaderVisualModel` is an auxiliary component that facilitates the visualization of simulation results and does not fit into the broader variational or Lagrangian mechanics framework used for simulating deformable systems. It merely serves as a tool to enhance the visual representation of the simulated objects.\n\n### Summary\nIn summary, `OglShaderVisualModel` is designed for advanced graphical rendering using custom OpenGL shaders and does not have any direct mathematical or physical content related to FEM simulations.",
  "abstract": "The `OglShaderVisualModel` component enables advanced graphical rendering using custom OpenGL shaders, enhancing the realism and interactivity of simulation visualizations.",
  "sheet": "# OglShaderVisualModel\n\n## Overview\n\nThe `OglShaderVisualModel` is a visual model component in the SOFA framework designed for OpenGL display using custom shaders. It inherits from the `OglModel` class and serves to render graphical representations of simulation objects with customizable visual effects.\n\n## Dependencies and Connections\n\nThis component interacts primarily through its virtual methods such as `doUpdateVisual`, `bwdDraw`, and `fwdDraw`. These methods receive visual parameters from the SOFA core (`core::visual::VisualParams`) to update and render visual representations. Additionally, it handles topology changes via `handleTopologyChange` to ensure that the visual model remains consistent with any modifications in the underlying mechanical or geometric models."
}