Data Fields

Methods

{
  "name": "MergeVisualModels",
  "namespace": "sofa::gl::component::rendering3d",
  "module": "Sofa.GL.Component.Rendering3D",
  "include": "sofa/gl/component/rendering3d/MergeVisualModels.h",
  "doc": "Merge several visual models.\n\nThis class merges several visual models.",
  "inherits": [
    "OglModel"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "d_nbInput",
      "type": "unsigned int"
    }
  ],
  "links": [],
  "methods": [
    {
      "name": "update",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "parse",
      "return_type": "void",
      "params": [
        {
          "name": "arg",
          "type": "sofa::core::objectmodel::BaseObjectDescription *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "parseFields",
      "return_type": "void",
      "params": [
        {
          "name": "str",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "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"
    }
  ],
  "description": "The **MergeVisualModels** component in the SOFA framework is designed to merge several visual models into a single rendering representation. This class is part of the `Sofa.GL.Component.Rendering3D` module and inherits from `OglModel`. Its primary role is to consolidate multiple visual representations for better efficiency or simpler handling within the graphical user interface (GUI). It includes an unsigned integer data field, `d_nbInput`, which indicates the number of input visual models it merges. The component provides several methods like `parse` and `init` that are virtual and designed to be overridden by subclasses for custom behavior during parsing configuration files or initialization phases. Additionally, it offers a protected method `update` for internal state updates.",
  "maths": "The **MergeVisualModels** component in the SOFA framework is primarily concerned with graphical rendering and does not contribute directly to the mathematical or physical simulation pipeline described by the Finite Element Method (FEM). Instead, it serves a role in merging multiple visual models into a single representation for efficient rendering. The component consolidates several visual representations without altering the underlying physics-based computations.\n\nThe primary data field `d_nbInput` is an unsigned integer that indicates the number of input visual models to be merged by this component. This field is used to manage the aggregation process, ensuring that all specified models are appropriately combined into a unified visual representation.\n\nThere are no governing equations or operators (such as mass matrix M, stiffness matrix K, internal force \\( f_{int} \\), residual R) associated with this component since it does not participate in the numerical solution of FEM problems. The methods `parse`, `init`, and `reinit` handle configuration parsing and initialization but do not involve any physical or mechanical computations.\n\nIn summary, **MergeVisualModels** is a purely graphical utility that streamlines rendering processes without engaging with the variational mechanics framework or the numerical solution of FEM problems.",
  "abstract": "The MergeVisualModels component merges several visual models into a single rendering representation for efficient handling within the GUI.",
  "sheet": "# MergeVisualModels\n\n**Overview**\n\nMergeVisualModels is part of the `Sofa.GL.Component.Rendering3D` module and inherits from `OglModel`. It consolidates multiple visual representations to improve efficiency in graphical user interfaces.\n\n**Parameters and Data**\n\n- **d_nbInput**: An unsigned integer indicating the number of input visual models to be merged. This field is crucial for managing the aggregation process, ensuring all specified models are combined into a unified visual representation.\n\n**Dependencies and Connections**\n\nMergeVisualModels inherits from `OglModel` and typically requires multiple visual models as inputs to merge them into a single rendering representation."
}