Data Fields

Methods

{
  "name": "PostProcessManager",
  "namespace": "sofa::gl::component::shader",
  "module": "Sofa.GL.Component.Shader",
  "include": "sofa/gl/component/shader/PostProcessManager.h",
  "doc": "Add a post process pass to the actual rendering.",
  "inherits": [
    "VisualManager"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "zNear",
      "type": "double",
      "xmlname": "zNear",
      "help": "Set zNear distance (for Depth Buffer)"
    },
    {
      "name": "zFar",
      "type": "double",
      "xmlname": "zFar",
      "help": "Set zFar distance (for Depth Buffer)"
    }
  ],
  "links": [],
  "methods": [
    {
      "name": "init",
      "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": "vparams",
          "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": "handleEvent",
      "return_type": "void",
      "params": [
        {
          "name": "event",
          "type": "sofa::core::objectmodel::Event *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The **PostProcessManager** is a component in the SOFA framework, specifically part of the `sofa::gl::component::shader` namespace within the `Sofa.GL.Component.Shader` module. Its primary role is to manage and add post-processing passes to the current rendering process, enhancing visual effects or applying specific image processing techniques.\n\n**Role and Purpose:**\nThe PostProcessManager extends the functionality of the VisualManager by providing methods for initializing and managing post-processing operations during the rendering pipeline. This allows for sophisticated image manipulations that can be applied after the scene is rendered but before it is displayed, enhancing realism or adding artistic effects.\n\n**Interactions with Other Components:**\nThe component interacts with other visual-related components through its virtual methods such as `init`, `reinit`, `doInitVisual`, `preDrawScene`, `drawScene`, and `postDrawScene`. These methods are called at different stages of the rendering pipeline, allowing for precise control over when post-processing effects are applied. The component also handles events via the `handleEvent` method, enabling it to respond dynamically to changes in the simulation environment.\n\n**Practical Usage Guidance:**\nThe PostProcessManager provides data fields like `zNear` and `zFar`, which define the near and far clipping planes for depth buffering operations, ensuring that only objects within these planes are rendered. These settings can be adjusted according to specific visualization requirements. To use this component effectively, it should be integrated into a scene where visual enhancement or manipulation is desired.",
  "maths": "The **PostProcessManager** is a visual component in the SOFA framework that manages post-processing effects on rendered scenes. It does not contribute to the governing equations or operators typical of FEM simulations, such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc. Instead, it focuses on enhancing visual realism and applying image processing techniques after a scene has been rendered but before the final display to the user.\n\n### Role in the Global FEM Pipeline\n\nThe PostProcessManager operates outside of the core FEM simulation pipeline, which includes modeling phase, discretization phase, assembly phase, time integration, nonlinear resolution, linear resolution, and state update. Specifically, it intervenes at the visual rendering stage after the scene has been computed by other components.\n\n### Governing Equations or Operators\n\nSince this component is primarily concerned with post-processing visual effects, it does not directly implement any of the governing equations or operators typically associated with FEM simulation. Instead, its operations are confined to the manipulation and enhancement of pixel values in rendered images. This includes techniques such as depth-of-field, motion blur, tone mapping, etc.\n\n### Constitutive or Kinematic Laws Involved\n\nThe PostProcessManager does not involve any constitutive or kinematic laws typical of FEM simulations (e.g., strain measures, stress tensors, hyperelastic potentials). Its primary role is to apply post-processing passes that can modify the visual appearance of the rendered scene without affecting the underlying physical simulation.\n\n### Numerical Methods or Discretization Choices\n\nThe component does not involve numerical methods or discretization choices related to FEM simulations. Instead, it relies on image processing techniques and shader programs to manipulate pixel values in a rendered frame. The `zNear` and `zFar` parameters define the near and far clipping planes for depth buffering operations, which are part of standard graphics rendering pipelines.\n\n### Fit into Variational / Lagrangian Mechanics Framework\n\nThe PostProcessManager does not fit into the variational or Lagrangian mechanics framework as it is not involved in any physical modeling or simulation. Its purpose is purely visual and post-rendering, enhancing the appearance of the final rendered image without affecting the underlying physics of the system being simulated.\n\n### Summary\n\nIn summary, the PostProcessManager component in SOFA focuses on enhancing the visual aspects of a rendered scene through post-processing techniques. It does not contribute to any mathematical or physical modeling operations typical of FEM simulations but instead operates at the visual rendering stage.",
  "abstract": "Manages post-processing passes to enhance visual effects in rendered scenes by applying image processing techniques after scene computation.",
  "sheet": "# PostProcessManager\n\n## Overview\nThe PostProcessManager is a component that extends the functionality of the VisualManager to manage and apply post-processing effects on rendered scenes. It operates at the visual rendering stage, enhancing realism or adding artistic effects without affecting the underlying physical simulation.\n\n## Parameters and Data\n- **zNear**: Set zNear distance (for Depth Buffer). Type: double.\n- **zFar**: Set zFar distance (for Depth Buffer). Type: double.\n\nThese parameters define the near and far clipping planes for depth buffering operations, ensuring that only objects within these planes are rendered.\n\n## Practical Notes\nThe PostProcessManager should be integrated into a scene where visual enhancement or manipulation is desired. Adjusting `zNear` and `zFar` can help tailor the rendering to specific visualization requirements."
}