Methods

{
  "name": "UpdateBoundingBoxVisitor",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/UpdateBoundingBoxVisitor.h",
  "doc": "",
  "inherits": [
    "Visitor"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "processNodeTopDown",
      "return_type": "Result",
      "params": [
        {
          "name": "node",
          "type": "simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "processNodeBottomUp",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `UpdateBoundingBoxVisitor` is a component in the SOFA framework that inherits from the `Visitor` class and is responsible for updating bounding boxes within the simulation nodes. Its primary role is to compute and update the bounding box for each node by aggregating bounding boxes from its child objects and other sub-nodes. This visitor operates both top-down and bottom-up, ensuring comprehensive updates of bounding boxes throughout the scene graph hierarchy.\n\n**Interactions with Other Components:**\nThe `UpdateBoundingBoxVisitor` interacts with various components within SOFA's simulation framework through its API methods:\n- **processNodeTopDown**: Iterates over all objects in a node to compute and include their bounding boxes into the node's bounding box. This method is executed top-down, starting from higher-level nodes.\n- **processNodeBottomUp**: Aggregates bounding boxes of child nodes into the current node’s bounding box. This method operates bottom-up, combining lower-level bounding boxes upward in the hierarchy.\n\n**Practical Usage Guidance:**\nThe `UpdateBoundingBoxVisitor` is typically used to ensure accurate and up-to-date bounding boxes for simulation nodes, which are essential for collision detection, visualization, and efficient spatial queries within the scene graph. The component does not expose any public data fields or links directly but relies on the internal state of SOFA's simulation nodes and objects.",
  "maths": "The `UpdateBoundingBoxVisitor` component in the SOFA framework does not directly implement or contribute to any governing equations, constitutive laws, kinematic laws, or numerical methods related to the Finite Element Method (FEM) simulation pipeline. Instead, it is a utility visitor that focuses on updating bounding boxes for nodes within the scene graph hierarchy. This process ensures accurate spatial representation and efficient collision detection in simulations.\n\n### Role in the Global FEM Pipeline\n- **Bounding Box Computation**: The `UpdateBoundingBoxVisitor` computes bounding boxes for each node by aggregating bounding boxes from its child objects and sub-nodes. It operates both top-down and bottom-up to ensure comprehensive updates of bounding boxes throughout the scene graph hierarchy.\n- **Spatial Queries**: Accurate bounding boxes are crucial for efficient spatial queries, such as collision detection and visualization. The component does not affect the physical or mechanical behavior of the simulation but ensures that these auxiliary tasks are performed accurately and efficiently.\n\n### Numerical Methods or Discretization Choices\nThe `UpdateBoundingBoxVisitor` does not encode any numerical methods specific to FEM simulations. Instead, it relies on the internal state of SOFA's simulation nodes and objects to compute bounding boxes. The component itself is not involved in spatial discretization (FEM), time integration, nonlinear solve, linear solve, constraint handling, or other core components of the FEM pipeline.\n\n### How the Component Fits into the Broader Variational / Lagrangian Mechanics Framework\nThe `UpdateBoundingBoxVisitor` does not directly fit into the variational or Lagrangian mechanics framework as it is a utility component focused on spatial representation rather than physical simulation. Its primary role is to ensure that bounding boxes are accurately computed and updated, which indirectly supports various aspects of the simulation such as collision detection and visualization.\n\n### Summary\nThe `UpdateBoundingBoxVisitor` does not contribute to the mathematical or mechanical components of FEM simulations but plays a crucial supportive role in maintaining accurate spatial information within the scene graph. This ensures that auxiliary tasks like collision detection and visualization operate efficiently.",
  "abstract": "The `UpdateBoundingBoxVisitor` computes and updates bounding boxes for simulation nodes by aggregating child object and sub-node bounding boxes in a top-down and bottom-up manner.",
  "sheet": "\n# UpdateBoundingBoxVisitor\n\n**Overview**\nThe `UpdateBoundingBoxVisitor` is a utility component that inherits from the `Visitor` class. Its primary role is to ensure accurate and up-to-date bounding boxes for simulation nodes within the scene graph hierarchy by aggregating bounding boxes from child objects and sub-nodes. This visitor operates both top-down (via `processNodeTopDown`) and bottom-up (via `processNodeBottomUp`). Accurate bounding boxes are essential for collision detection, visualization, and efficient spatial queries.\n"
}