Methods

{
  "name": "MeshOBJ",
  "namespace": "sofa::helper::io",
  "module": "Sofa.framework.Helper",
  "include": "sofa/helper/io/MeshOBJ.h",
  "doc": "",
  "inherits": [
    "Mesh"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "init",
      "return_type": "void",
      "params": [
        {
          "name": "filename",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "readOBJ",
      "return_type": "void",
      "params": [
        {
          "name": "file",
          "type": "int &"
        },
        {
          "name": "filename",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "readMTL",
      "return_type": "void",
      "params": [
        {
          "name": "filename",
          "type": "const char *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "<p>The `MeshOBJ` component in the SOFA framework is responsible for loading and parsing OBJ files, which are used to represent 3D geometry data. It inherits from the `Mesh` class and provides functionality to read vertices, normals, texture coordinates, and material properties defined within OBJ and MTL (material library) files.</p>\n\n<p>The `MeshOBJ` component interacts with other SOFA components by providing parsed mesh data that can be used in various simulation scenarios. The parsed data includes vertex positions, normals, and texture coordinates, which are essential for visualization and collision detection. Additionally, it reads material properties from MTL files, which can be utilized by rendering systems or physics engines to apply appropriate visual and mechanical behaviors.</p>\n\n<p>Practical usage involves initializing the component with an OBJ file path via its `init` method. The `readOBJ` method handles parsing the OBJ file content into internal data structures, while `readMTL` parses associated material library files. Both methods operate on protected access levels to encapsulate the file reading logic.</p>\n\n<p>No specific data fields are defined in the metadata for this component, indicating that its state is managed internally through member functions and inherited attributes from the base class.</p>",
  "maths": "The `MeshOBJ` component in the SOFA framework is primarily responsible for loading and parsing OBJ files, which are used to represent 3D geometry data. It does not directly contribute to any governing equations or operators such as mass matrix $M$, stiffness matrix $K$, internal force $\boldsymbol{f}_{int}$, or residual $\boldsymbol{R}$. Instead, its role is to provide the necessary geometric and material information that can be used by other components in the FEM pipeline. Here are some key aspects of `MeshOBJ`'s functionality within this broader context:\n\n### Constitutive Laws and Kinematic Information\n- **Vertices**: The component reads vertex positions $(x, y, z)$ from the OBJ file.\n- **Normals**: Surface normals $(\boldsymbol{n}_i = [n_x, n_y, n_z])$ are parsed for each vertex or face to aid in lighting calculations during rendering and surface contact detection.\n- **Texture Coordinates**: Texture coordinates $(u, v)$ are read for mapping images onto the mesh surfaces, which is useful for visualization purposes but does not directly impact physical simulation.\n\n### Role in FEM Pipeline\n1. **Mesh Generation**: `MeshOBJ` provides a means to generate a mesh from an OBJ file by reading vertex positions and connectivity information (facets). This mesh data can be used downstream by other SOFA components such as `MechanicalObject`, `TetrahedralSetGeometryAlgorithms`, etc., for constructing the discretized domain.\n2. **Material Properties**: The component reads material properties from associated MTL files, which include diffuse color ($\boldsymbol{K_d}$), specular color ($\boldsymbol{K_s}$), ambient color ($\boldsymbol{K_a}$), shininess ($N_s$), and transparency ($d$). While these properties are primarily for rendering purposes, they can also influence how materials behave visually in a simulation.\n\n### Numerical Methods or Discretization Choices\n- **File Parsing**: The component uses standard C++ file handling techniques to read OBJ files. It supports the interpretation of vertex positions, normals, and texture coordinates as well as material properties from MTL files.\n- **Data Structures**: Internally, `MeshOBJ` stores parsed data in appropriate container types (e.g., vectors for vertices, normals, and materials). This allows for easy access to this information by other SOFA components that might use it for visualization or simulation purposes.\n\n### Integration into Variational Mechanics Framework\n- **Initialization of Geometric Data**: `MeshOBJ`'s primary role is to initialize the geometric data (vertices, normals, etc.) and material properties. This initialized data can then be used by other SOFA components that contribute to solving the variational problem formulated in FEM.\n\n### Summary\nThe `MeshOBJ` component is a utility for loading 3D mesh data and associated materials from OBJ and MTL files. It does not directly implement or solve governing equations but instead provides essential geometric and material information that can be used by other components within the SOFA framework to perform FEM simulations.",
  "abstract": "`MeshOBJ` loads and parses OBJ files to provide geometric and material information for use in SOFA simulations.",
  "sheet": "# MeshOBJ\n\n**Overview**\n\nThe `MeshOBJ` component is responsible for loading and parsing OBJ files, which represent 3D geometry data. It provides essential vertex positions, normals, texture coordinates, and material properties from associated MTL files to other components in the SOFA framework.\n\n**Dependencies and Connections**\n\n`MeshOBJ` interacts with other SOFA components by providing parsed mesh data that can be used for visualization, collision detection, or as input for mechanical simulations. It inherits from the `Mesh` class and is typically used alongside components such as `MechanicalObject`, `TetrahedralSetGeometryAlgorithms`, and rendering systems."
}