{
  "name": "FIGExporter",
  "main": {
    "name": "FIGExporter",
    "namespace": "vrender",
    "module": "",
    "include": "",
    "doc": "",
    "inherits": [
      "Exporter"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "spewPoint",
        "return_type": "void",
        "params": [
          {
            "name": "",
            "type": "const Point *"
          },
          {
            "name": "out",
            "type": "QTextStream &"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "protected"
      },
      {
        "name": "spewSegment",
        "return_type": "void",
        "params": [
          {
            "name": "",
            "type": "const Segment *"
          },
          {
            "name": "out",
            "type": "QTextStream &"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "protected"
      },
      {
        "name": "spewPolygone",
        "return_type": "void",
        "params": [
          {
            "name": "",
            "type": "const Polygone *"
          },
          {
            "name": "out",
            "type": "QTextStream &"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "protected"
      },
      {
        "name": "writeHeader",
        "return_type": "void",
        "params": [
          {
            "name": "out",
            "type": "QTextStream &"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "protected"
      },
      {
        "name": "writeFooter",
        "return_type": "void",
        "params": [
          {
            "name": "out",
            "type": "QTextStream &"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "protected"
      }
    ]
  },
  "desc": {
    "description": "The `FIGExporter` is a component within the SOFA framework's vrender namespace designed to export simulation data into FIG format, a vector graphics file format used for storing and displaying scientific figures. It inherits from the `Exporter` class, indicating its role in exporting simulation elements. The `FIGExporter` provides methods to spew (output) various geometric primitives such as points, segments, and polygons into the FIG file stream (`QTextStream`). Additionally, it includes methods for writing headers and footers necessary for the proper structure of a FIG file. These methods are protected and virtual, suggesting that they can be overridden in derived classes to customize the export process."
  },
  "maths": {
    "maths": "The `FIGExporter` is primarily an I/O component within the SOFA framework's vrender namespace, designed to export simulation data into the FIG format. This vector graphics file format is used for storing and displaying scientific figures. The primary role of `FIGExporter` is not directly related to any mathematical or physical modeling components typically involved in computational mechanics, such as mass matrix \\( M \\), stiffness matrix \\( K \\), internal force \\( f_{\text{int}} \\), residual \\( R \\), constitutive laws, strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, or other key elements of the Finite Element Method (FEM) pipeline. Instead, `FIGExporter` focuses on outputting geometric primitives such as points, segments, and polygons into a FIG file stream (`QTextStream`). It provides methods to handle the structure and content of the FIG format by writing headers and footers necessary for proper file formatting. These methods are virtual and protected, indicating they can be overridden in derived classes for customization."
  },
  "summary": {
    "abstract": "The `FIGExporter` exports simulation data into the FIG format, handling geometric primitives such as points, segments, and polygons. It writes headers and footers necessary for proper file formatting.",
    "sheet": "\n# FIGExporter\n\n**Overview**\nThe `FIGExporter` is a component within the SOFA framework's vrender namespace designed to export simulation data into the FIG format, a vector graphics file format used for storing and displaying scientific figures. It inherits from the `Exporter` class, indicating its role in exporting geometric primitives such as points, segments, and polygons into the FIG file stream (`QTextStream`). The component provides methods for writing headers and footers necessary for proper formatting of the FIG file.\n\n**Parameters and Data**\nThe `FIGExporter` does not expose any significant Data fields. All its functionality is encapsulated within its virtual methods for exporting geometric primitives and writing headers/footers."
  }
}