Methods

{
  "name": "Shader",
  "namespace": "sofa::core::visual",
  "module": "Sofa.framework.Core",
  "include": "sofa/core/visual/Shader.h",
  "doc": "A basic interface to define a Shader for different system (OpenGL, DirectX, ...).",
  "inherits": [
    "BaseObject"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "toShader",
      "return_type": "const Shader *",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "start",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "stop",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "isActive",
      "return_type": "bool",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "insertInNode",
      "return_type": "bool",
      "params": [
        {
          "name": "node",
          "type": "objectmodel::BaseNode *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "removeInNode",
      "return_type": "bool",
      "params": [
        {
          "name": "node",
          "type": "objectmodel::BaseNode *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `Shader` class in SOFA is an abstract interface for defining and managing shaders, which are used for rendering purposes in different systems such as OpenGL or DirectX. This component inherits from the `BaseObject`, allowing it to integrate into the SOFA scene graph architecture. It provides methods to start and stop shader operations (`start()`, `stop()`), check if a shader is active (`isActive()`), and manage its association with nodes via `insertInNode()` and `removeInNode()`. The `Shader` class allows for flexible integration of different rendering techniques within the simulation framework, making it an essential component for visual representations. Practical usage involves subclassing this abstract class to implement specific shader functionalities according to the required graphics system.",
  "maths": "The `Shader` class in the SOFA framework is an abstract interface designed for defining and managing shaders used in different graphics systems, such as OpenGL or DirectX. The primary role of a shader is to control various aspects of rendering during simulation visualization, rather than contributing directly to the physics-based modeling and numerical computation phases of the FEM pipeline. Therefore, it does not implement or contribute to any governing equations, constitutive laws, or kinematic formulations typical in the FEM context.\n\n### Role in the Global FEM Pipeline:\n- **Rendering**: The `Shader` component is primarily responsible for rendering visual effects and does not directly participate in the assembly of global matrices (e.g., mass matrix \\(M\\), stiffness matrix \\(K\\)), internal forces, nonlinear residual, or linear solve phases. It operates outside the core computational mechanics loop.\n- **Integration into Scene Graph**: The `Shader` class integrates with the SOFA scene graph by allowing insertion and removal from nodes through methods like `insertInNode()` and `removeInNode()`. These operations facilitate dynamic management of shader states within the simulation environment, enabling real-time visual adjustments or rendering optimizations.\n\n### Numerical Methods and Discretization Choices:\n- **None**: The `Shader` class does not directly encode any numerical methods or discretization choices related to FEM. Instead, it supports visualization through various graphics operations that are external to the core simulation logic.\n\n### Variational / Lagrangian Mechanics Framework:\n- **No Contribution**: The `Shader` component does not contribute to the variational formulation of mechanics problems nor the Lagrangian mechanics framework used in FEM simulations. It is solely focused on rendering and visualization aspects, providing a bridge for integrating different graphics systems within the SOFA simulation environment.\n\n### Summary:\nThe `Shader` class in SOFA is an abstract interface that enables the definition and management of shaders for various graphics systems. While it plays a crucial role in visual representation, it does not directly involve any mathematical or physical formulations related to FEM simulations.",
  "abstract": "Shader defines an abstract interface for managing shaders used in different graphics systems such as OpenGL or DirectX, enabling flexible integration of rendering techniques within SOFA simulations.",
  "sheet": "# Shader\n\n**Overview**\n\nThe `Shader` class is an abstract interface designed to define and manage shaders for various graphics systems (e.g., OpenGL, DirectX). It integrates into the SOFA scene graph via methods like `insertInNode()` and `removeInNode()`, allowing dynamic management of shader states within the simulation environment.\n\n**Parameters and Data**\n\nThe `Shader` class does not expose any significant data fields. Its functionality is primarily defined through its virtual methods, which include:\n- `start()`: Starts shader operations.\n- `stop()`: Stops shader operations.\n- `isActive()`: Checks if the shader is active.\n- `insertInNode(node)`: Inserts the shader into a specified node.\n- `removeInNode(node)`: Removes the shader from a specified node."
}