Data Fields

Methods

{
  "name": "OrderIndependentTransparencyManager",
  "namespace": "sofa::gl::component::shader",
  "module": "Sofa.GL.Component.Shader",
  "include": "sofa/gl/component/shader/OrderIndependentTransparencyManager.h",
  "doc": "Order Independent Transparency Manager (to be used with OglOITShader).\n\nUtility to manage transparency (translucency) into an Opengl scene\n \\note Reference: http://jcgt.org/published/0002/02/09/paper.pdf",
  "inherits": [
    "VisualManager"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "depthScale",
      "type": "float",
      "xmlname": "depthScale",
      "help": "Depth scale"
    }
  ],
  "links": [],
  "methods": [
    {
      "name": "init",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "bwdInit",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "reinit",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doInitVisual",
      "return_type": "void",
      "params": [
        {
          "name": "vp",
          "type": "const core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "preDrawScene",
      "return_type": "void",
      "params": [
        {
          "name": "vp",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "drawScene",
      "return_type": "bool",
      "params": [
        {
          "name": "vp",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "postDrawScene",
      "return_type": "void",
      "params": [
        {
          "name": "vp",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "draw",
      "return_type": "void",
      "params": [
        {
          "name": "vparams",
          "type": "const 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": "bwdDraw",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "drawOpaques",
      "return_type": "void",
      "params": [
        {
          "name": "vp",
          "type": "core::visual::VisualParams *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "drawTransparents",
      "return_type": "void",
      "params": [
        {
          "name": "vp",
          "type": "core::visual::VisualParams *"
        },
        {
          "name": "oitShader",
          "type": "sofa::gl::GLSLShader *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "The **OrderIndependentTransparencyManager** is a component in the SOFA framework designed to manage transparency (translucency) within an OpenGL scene, particularly useful for visualizing semi-transparent objects without being dependent on the order of rendering. This component inherits from `VisualManager` and includes functionality to handle initialization, drawing scenes, and managing transparency effects through specialized methods like `drawTransparents`. It integrates with OGLOITShader (Order-Independent Transparency shader) for effective visualization.\n\n**Role in SOFA Ecosystem:**\nThe component plays a critical role in enhancing the visual realism of semi-transparent objects within simulations by ensuring proper handling of transparency regardless of rendering order. This is crucial for creating accurate and visually appealing representations, especially when dealing with complex scenes involving multiple translucent elements.\n\n**Interactions with Other Components:*\n- **VisualManager**: The base class providing the framework for managing visual aspects of SOFA components.\n- **OglOITShader**: Works in conjunction with `OrderIndependentTransparencyManager` to apply order-independent transparency effects during rendering. \n- **core::visual::VisualParams**: Used as parameters in several methods (`preDrawScene`, `drawScene`, etc.) for defining visual settings such as camera, lighting, and other rendering properties.\n\n**Practical Usage Guidance:**\nThe primary data field is `depthScale` (float), which scales the depth buffer value used during transparency calculations. This component should be integrated into scenes where accurate visualization of translucent objects is required. It provides methods for initializing (`init`, `bwdInit`, `reinit`), pre-drawing (`preDrawScene`), drawing (`drawScene`, `drawOpaques`, `drawTransparents`), and post-processing (`postDrawScene`) the scene, ensuring that transparency effects are correctly applied during each phase of rendering.\n\n**Data Fields:**\n- **depthScale**: Scales the depth buffer value used in transparency calculations.",
  "maths": "The **OrderIndependentTransparencyManager** is a component in the SOFA framework that primarily focuses on managing transparency effects within an OpenGL scene. It does not directly contribute to the core FEM simulation pipeline, as its role is more oriented towards visual representation rather than physical or mathematical modeling of deformable systems. However, it enhances the visual realism and accuracy of semi-transparent objects within simulations.\n\n### Mathematical and Physical Description\n\n#### Governing Equations or Operators\n- The component does not directly implement or contribute to governing equations such as mass matrix (\\(M\")), stiffness matrix (\\(K\")), internal force vector (\\(f_{int}\")), residual (\\(R\")), etc. These are typically handled by other components in the SOFA framework, such as those dealing with mechanical properties and dynamics.\n\n#### Constitutive or Kinematic Laws Involved\n- The component does not involve any constitutive laws (e.g., stress-strain relations) or kinematic laws (e.g., deformation measures). Instead, it focuses on visual aspects of rendering semi-transparent objects.\n\n#### Role in the Global FEM Pipeline\n- **Assembly**: This component is not involved in assembling global mass and stiffness matrices.\n- **Time Integration**: It does not participate directly in time integration schemes such as implicit Euler or Newmark methods.\n- **Nonlinear Solve**: The transparency management process does not involve nonlinear solution techniques like Newton-Raphson iterations.\n- **Linear Solve**: Similarly, it is not involved in linear solvers (e.g., Conjugate Gradient) for solving the linearized system of equations.\n- **Constraint Handling and Mapping**: This component does not handle constraints or mappings within the FEM framework. It focuses on visual aspects rather than mechanical constraints.\n\n#### Numerical Methods or Discretization Choices\n- The primary numerical method employed by this component is related to rendering techniques, specifically order-independent transparency (OIT). OIT ensures that transparent objects are rendered correctly regardless of their drawing order in the scene, which is crucial for visually accurate simulations involving semi-transparent materials.\n\n#### Integration into the Variational / Lagrangian Mechanics Framework\n- The **OrderIndependentTransparencyManager** does not integrate directly into the variational or Lagrangian mechanics framework. It operates at a higher level of abstraction, focusing on visual representation and ensuring that transparency effects are correctly applied during rendering phases (`preDrawScene`, `drawScene`, `postDrawScene`).\n\n### Summary\nThe **OrderIndependentTransparencyManager** is a specialized component designed for managing transparency in an OpenGL scene within the SOFA framework. Its primary role is to enhance visual realism, particularly for semi-transparent objects, without directly contributing to the mathematical or physical aspects of FEM simulations.",
  "abstract": "The OrderIndependentTransparencyManager manages transparency effects within an OpenGL scene, ensuring visually accurate rendering of semi-transparent objects without dependency on drawing order.",
  "sheet": "# OrderIndependentTransparencyManager\n\n## Overview\n\nThe **OrderIndependentTransparencyManager** is a component in the SOFA framework designed to manage transparency (translucency) within an OpenGL scene. It ensures that transparent objects are rendered correctly regardless of their drawing order, enhancing visual realism for semi-transparent materials.\n\nThis component inherits from `VisualManager` and integrates with other components like `OglOITShader` and `core::visual::VisualParams` to handle initialization, pre-drawing, drawing, and post-processing phases of the scene rendering process.\n\n## Parameters and Data\n\n- **depthScale**: Scales the depth buffer value used in transparency calculations. This parameter is a float type with no default specified.\n\n## Dependencies and Connections\n\nThe component typically requires integration with `OglOITShader` for applying order-independent transparency effects during rendering. It also interacts with `core::visual::VisualParams` to define visual settings such as camera, lighting, and other rendering properties."
}