Data Fields

{
  "name": "VisualBoundingBox",
  "namespace": "sofa::component::visual",
  "module": "Sofa.Component.Visual",
  "include": "sofa/component/visual/VisualBoundingBox.h",
  "doc": "Display an Axis Aligned Bounding Box (AABB).",
  "inherits": [
    "VisualModel"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "d_color",
      "type": "sofa::type::RGBAColor",
      "xmlname": "color",
      "help": "Color of the lines of the box."
    },
    {
      "name": "d_thickness",
      "type": "float",
      "xmlname": "thickness",
      "help": "Thickness of the lines of the box."
    }
  ],
  "links": [],
  "methods": [],
  "description": "The `VisualBoundingBox` component is part of the SOFA framework and is designed to display an Axis Aligned Bounding Box (AABB) in visual simulations. It inherits from `core::visual::VisualModel`, indicating its role in the visualization aspect of a simulation scene.\n\nThis component has two main data fields:\n- **color**: The color of the lines of the box, defined as type `sofa::type::RGBAColor`. The default value is yellow.\n- **thickness**: The thickness of the lines of the box, defined as type `float` with a default value of 1.0f.\n\nThe component interacts with other SOFA components through its visual model interface and leverages the SOFA rendering tools to draw the bounding box. The method `doDrawVisual` is responsible for rendering the bounding box using the specified color and thickness settings.\n\nPractical usage involves specifying the desired color and thickness of the bounding box lines, which can be adjusted via the provided XML attributes in a scene configuration file.",
  "maths": "The `VisualBoundingBox` component in the SOFA framework is designed to display an Axis Aligned Bounding Box (AABB) for visualization purposes. It does not contribute to any mathematical or physical governing equations, constitutive laws, kinematic laws, or numerical methods used in Finite Element Method (FEM) simulations. Instead, it serves a purely visual role by drawing the bounding box with specified color and thickness settings.\n\n### Mathematical and Physical Description:\n\n- **Governing Equations / Operators**\n  - The `VisualBoundingBox` component does not implement or contribute to any governing equations such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc.\n\n- **Constitutive or Kinematic Laws**\n  - There are no constitutive or kinematic laws involved in the `VisualBoundingBox` component, as it does not deal with material behavior or deformation mechanics.\n\n- **Role in FEM Pipeline**\n  - The component is purely visual and does not participate in any part of the FEM pipeline such as assembly, time integration, nonlinear solve, linear solve, constraint handling, mapping, etc. It only draws a bounding box for visualization purposes during the simulation rendering phase.\n\n- **Numerical Methods or Discretization Choices**\n  - The component does not encode any numerical methods or discretization choices that are relevant to FEM simulations. It simply uses the SOFA drawing tools to render the bounding box with specified visual parameters.\n\n- **Variational / Lagrangian Mechanics Framework**\n  - The `VisualBoundingBox` is not part of the variational or Lagrangian mechanics framework, as it does not contribute to any physical simulation processes. It is used solely for visualization purposes and has no impact on the numerical solution of FEM simulations.\n\n### Summary:\n- **Mathematical Content**: None\n- **Physical Content**: None\n- **Purpose**: Visual representation of an Axis Aligned Bounding Box (AABB) in the simulation scene.",
  "abstract": "The `VisualBoundingBox` component displays an Axis Aligned Bounding Box (AABB) in visual simulations, allowing customization of line color and thickness.",
  "sheet": "\n# VisualBoundingBox\n\n## Overview\n\nThe `VisualBoundingBox` component is part of the SOFA framework's visualization capabilities. It inherits from `core::visual::VisualModel`, indicating its role in rendering an Axis Aligned Bounding Box (AABB) for visual simulations.\n\n## Parameters and Data\n\n- **color**: The color of the lines of the box, defined as type `sofa::type::RGBAColor`. The default value is yellow.\n- **thickness**: The thickness of the lines of the box, defined as type `float` with a default value of 1.0f."
}