Methods

{
  "name": "VisualModelOBJExporter",
  "namespace": "sofa::component::_visualmodelobjexporter_",
  "module": "Sofa.Component.IO.Mesh",
  "include": "sofa/component/io/mesh/VisualModelOBJExporter.h",
  "doc": "Export the scene under the Wavefront OBJ format.",
  "inherits": [
    "BaseSimulationExporter"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "write",
      "return_type": "bool",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "writeOBJ",
      "return_type": "bool",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `VisualModelOBJExporter` is a SOFA component in the `Sofa.Component.IO.Mesh` module that exports the visual model of a simulation scene into the Wavefront OBJ format. This exporter extends `BaseSimulationExporter`, which is part of SOFA's core infrastructure for exporting simulation data.\n\nIts primary role is to facilitate the export of 3D models, including mesh and material information, from SOFA simulations in an easily readable and widely supported file format (OBJ). The component includes methods such as `write` and `writeOBJ`, which handle the actual writing process. It generates both OBJ files for geometry and MTL files for materials.\n\nInteractions with other components include:\n- Inheriting from `BaseSimulationExporter`, it integrates into SOFA's exporter framework, allowing for consistent handling of simulation data export.\n- Utilizes the `ExportVisualModelOBJVisitor` to traverse the scene graph and collect visual model information.\n\nPractical usage involves setting up the component in a simulation setup where exporting visual models is necessary. It ensures that exported files adhere to the OBJ format specifications, making it suitable for interoperability with other 3D modeling tools and software.",
  "maths": "The `VisualModelOBJExporter` is an I/O component in the SOFA framework that handles the export of visual models from a simulation scene into the Wavefront OBJ format. This component does not directly contribute to any governing equations, constitutive laws, or kinematic formulations related to FEM. Instead, its primary role is to facilitate the conversion and saving of visual model data (meshes, materials) in a widely used 3D modeling file format.\n\n### Governing Equations or Operators\n- **No contribution:** The `VisualModelOBJExporter` does not implement or contribute to any governing equations, operators (such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\)), or other numerical simulation components.\n\n### Constitutive or Kinematic Laws Involved\n- **No contribution:** The component does not involve any constitutive laws, stress tensors, strain measures, hyperelastic potentials, damping models, constraint Jacobians, etc. It is solely focused on exporting visual model data to a file format.\n\n### Role in the Global FEM Pipeline\n- **Export Stage:** The `VisualModelOBJExporter` operates at the export stage of the simulation pipeline. After the simulation has been executed and the state of the system (e.g., deformations, material properties) is known, this component can be used to export the visual model data for further analysis or visualization purposes.\n\n### Numerical Methods or Discretization Choices Encoded\n- **No contribution:** The `VisualModelOBJExporter` does not implement any numerical methods or discretization choices related to FEM. It simply handles the file I/O operations required to write the visual model data in OBJ format.\n\n### Integration into Variational / Lagrangian Mechanics Framework\n- **Non-relevant:** Since the component is purely for exporting visual models, it does not fit into the variational or Lagrangian mechanics framework used for simulating deformable systems. Its role is external to the simulation core and serves post-processing purposes.\n\n### Conclusion\nThe `VisualModelOBJExporter` is an I/O utility that facilitates the export of visual model data from SOFA simulations in the Wavefront OBJ format. It has no involvement in the mathematical or physical aspects of FEM-based simulations.",
  "abstract": "The `VisualModelOBJExporter` exports visual model data from a SOFA simulation scene into the Wavefront OBJ format, facilitating interoperability with other 3D modeling tools.",
  "sheet": "# VisualModelOBJExporter\n\n## Overview\nThe `VisualModelOBJExporter` is an I/O component in the `Sofa.Component.IO.Mesh` module that exports visual model data from a SOFA simulation scene into the Wavefront OBJ format. It extends `BaseSimulationExporter`, integrating into SOFA's exporter framework for consistent handling of simulation data export.\n\n## Dependencies and Connections\nThis component inherits from `BaseSimulationExporter` and utilizes the `ExportVisualModelOBJVisitor` to traverse the scene graph and collect visual model information, ensuring that exported files adhere to OBJ format specifications."
}