Methods

{
  "name": "OglOITShader",
  "namespace": "sofa::gl::component::shader",
  "module": "Sofa.GL.Component.Shader",
  "include": "sofa/gl/component/shader/OglOITShader.h",
  "doc": "Shader implementating Order Independent Transparency.",
  "inherits": [
    "OglShader"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "accumulationShader",
      "return_type": "sofa::gl::GLSLShader *",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `OglOITShader` is a shader component in the SOFA framework, specifically designed to implement Order Independent Transparency (OIT). This technique ensures correct rendering of transparent objects regardless of their drawing order. It inherits from the `OglShader` class and is part of the Sofa.GL.Component.Shader module. The primary method, `accumulationShader`, returns a pointer to an OpenGL Shader Language (GLSL) shader object used in the accumulation step of OIT rendering. This component plays a crucial role in enhancing visual fidelity by correctly compositing transparent elements within the SOFA simulation environment.",
  "maths": "The `OglOITShader` is a shader component in the SOFA framework designed to implement Order Independent Transparency (OIT). This technique ensures correct rendering of transparent objects regardless of their drawing order, enhancing visual fidelity by correctly compositing transparent elements within the simulation environment. However, this component does not contribute directly to the mathematical or physical aspects of the FEM pipeline such as mass matrix M, stiffness matrix K, internal force f_int, residual R, constitutive laws, kinematic laws, nonlinear dynamics, constraint handling, mappings, or numerical methods and discretization choices.\n\nThe primary method `accumulationShader` returns a pointer to an OpenGL Shader Language (GLSL) shader object used in the accumulation step of OIT rendering. This component operates at the graphical level rather than within the variational/Lagrangian mechanics framework that governs the physical simulation pipeline.",
  "abstract": "The `OglOITShader` implements Order Independent Transparency, ensuring correct rendering of transparent objects regardless of their drawing order within the SOFA simulation environment.",
  "sheet": "# OglOITShader\n\n**Overview**\n\nThe `OglOITShader` is a shader component in the SOFA framework designed to implement Order Independent Transparency (OIT). This technique ensures correct rendering of transparent objects regardless of their drawing order, enhancing visual fidelity by correctly compositing transparent elements within the simulation environment. It inherits from the `OglShader` class and operates at the graphical level.\n\n**Dependencies and Connections**\n\nThis component does not have specific dependencies on other SOFA components for its core functionality. However, it is typically used in conjunction with rendering pipelines that require correct compositing of transparent objects.\n\n**Practical Notes**\n\nThe `accumulationShader` method returns a pointer to an OpenGL Shader Language (GLSL) shader object used in the accumulation step of OIT rendering. This component enhances visual fidelity but does not affect the physical simulation pipeline."
}