Data Fields

Methods

{
  "name": "SlicedVolumetricModel",
  "namespace": "sofa::gl::component::rendering3d",
  "module": "Sofa.GL.Component.Rendering3D",
  "include": "sofa/gl/component/rendering3d/SlicedVolumetricModel.h",
  "doc": "Sliced visualization for a volumetric model defined with hexahedra.",
  "inherits": [
    "VisualModel"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "alpha",
      "type": "float",
      "xmlname": "alpha",
      "help": "Opacity of the billboards. 1.0 is 100% opaque."
    },
    {
      "name": "color",
      "type": "sofa::type::RGBAColor",
      "xmlname": "color",
      "help": "Billboard color.(default=1.0,1.0,1.0,1.0)"
    },
    {
      "name": "_nbPlanes",
      "type": "int",
      "xmlname": "nbSlices",
      "help": "Number of billboards."
    }
  ],
  "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": "isTransparent",
      "return_type": "bool",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "drawTransparent",
      "return_type": "void",
      "params": [
        {
          "name": "vparams",
          "type": "const core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "findAndDrawTriangles",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "computePlaneSeparations",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "intersectionSegmentPlane",
      "return_type": "int",
      "params": [
        {
          "name": "s0",
          "type": "const Coord &"
        },
        {
          "name": "s1",
          "type": "const Coord &"
        },
        {
          "name": "segmentDirection",
          "type": "const Coord &"
        },
        {
          "name": "planeNormal",
          "type": "const Coord &"
        },
        {
          "name": "planeConstant",
          "type": "const Real &"
        },
        {
          "name": "m_fLineT",
          "type": "Real &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "The `SlicedVolumetricModel` is a rendering component in the SOFA framework, specifically designed for visualizing volumetric models defined with hexahedra (3D cubes). This model provides sliced visualization, enabling users to see internal structures within the volume. It inherits from `VisualModel`, indicating its role in enhancing the visual representation of 3D models.\n\nThe component includes several data fields:\n- `alpha`: Controls the opacity of the billboards used for slicing (1.0 is fully opaque).\n- `color`: Specifies the color of the billboards, with a default value of white and full opacity.\n- `_nbPlanes` (xmlname: `nbSlices`): Defines the number of slices or billboards to be rendered.\n\nIt interacts with other SOFA components through methods like `init`, `reinit`, `isTransparent`, and `drawTransparent`. These methods are part of the rendering lifecycle, ensuring that the sliced visualization is correctly initialized, reinitialized, and drawn in a way that respects transparency settings. The component also includes protected methods such as `findAndDrawTriangles` and `computePlaneSeparations`, which handle the internal computation for slicing and drawing the volumetric model.\n\nIn practical usage, this component can be added to scenes where detailed visual inspection of volumetric data is required, particularly in medical or scientific simulations.",
  "maths": "The `SlicedVolumetricModel` is a rendering component within the SOFA framework, designed specifically for visualizing volumetric models defined with hexahedral elements. This component facilitates sliced visualization, allowing users to inspect internal structures within a volumetric model by rendering it as a series of cross-sectional slices (billboards). Despite its role in enhancing visual representation, it does not directly contribute to the governing equations or operators typically associated with Finite Element Method (FEM) simulations. Instead, its primary function is to aid in the visualization and interpretation of the simulation results.\n\n### Mathematical Content:\n\n- **Opacity Control**: The component includes an `alpha` parameter that controls the opacity of the slices (billboards), where \\(\\alpha = 1.0\\) indicates full opacity.\n- **Color Specification**: Users can specify a color for the billboards via the `color` field, with the default value being fully opaque white (RGBA: 1.0, 1.0, 1.0, 1.0).\n- **Number of Slices**: The `_nbPlanes` parameter determines the number of slices or billboards rendered to visualize internal structures.\n\n### Numerical Methods and Discretization Choices:\n\nWhile the component itself does not involve any numerical methods directly related to FEM solvers, it employs computational geometry techniques to generate cross-sectional slices. Specifically, it uses a method for finding intersections between segments and planes, which is crucial for determining where to slice the volumetric model.\n\n### Role in Global FEM Pipeline:\n\n- **Rendering Lifecycle**: The `SlicedVolumetricModel` does not participate in the assembly of global matrices or vectors such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal forces \\(\textbf{f}_{int}\\), or nonlinear residual \\(R\\). Its primary function is to visualize these results post-simulation.\n- **Initialization and Reinitialization**: The `init` and `reinit` methods ensure the component's initialization and reinitialization, respectively. These steps are crucial for setting up the slicing parameters before rendering begins.\n\n### Constraints Handling and Mappings:\n\nThe component does not directly handle constraints or mappings in the context of FEM simulations. Its role is purely visual, ensuring that the slices accurately represent internal structures within the volumetric model based on user-defined parameters.\n\n### Conclusion:\n\nIn summary, the `SlicedVolumetricModel` serves as a visualization tool for inspecting volumetric data defined with hexahedral elements. It does not contribute to the underlying FEM simulation but enhances the interpretability of the simulation results through sliced visual representations.",
  "abstract": "The `SlicedVolumetricModel` provides sliced visualization for volumetric models defined with hexahedra, enhancing visual inspection of internal structures within the volume.",
  "sheet": "# SlicedVolumetricModel\n\n## Overview\n\nThe `SlicedVolumetricModel` is a rendering component in the SOFA framework designed to visualize volumetric models defined with hexahedra. It provides sliced visualization, enabling users to inspect internal structures within the volume. This component inherits from `VisualModel`, indicating its role in enhancing visual representation.\n\n## Parameters and Data\n\n- **alpha**: Controls the opacity of the billboards used for slicing (1.0 is fully opaque).\n- **color**: Specifies the color of the billboards, with a default value of white and full opacity (RGBA: 1.0, 1.0, 1.0, 1.0).\n- **_nbPlanes** (xmlname: `nbSlices`): Defines the number of slices or billboards to be rendered.\n\n## Practical Notes\n\nThe component is designed for visual inspection and does not contribute to the underlying FEM simulation. It ensures that the sliced visualization accurately represents internal structures based on user-defined parameters such as opacity, color, and the number of slices."
}