EPSExporter
The `EPSExporter` is a component in the SOFA framework under the `vrender` namespace, inheriting from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScript) format for visualization purposes. It provides methods for spewing or writing specific geometric primitives such as points, segments, and polygons to a QTextStream output stream. These methods are protected and virtual, allowing subclasses to override them to customize the exporting behavior according to their needs. Additionally, it includes methods `writeHeader` and `writeFooter` to manage EPS file headers and footers respectively, ensuring proper formatting of the exported data.
- abstract
- The `EPSExporter` exports simulation data into EPS format by writing geometric primitives such as points, segments, and polygons to a QTextStream output stream.
- sheet
- # EPSExporter **Overview** The `EPSExporter` is a component in the SOFA framework under the `vrender` namespace that inherits from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScript) format for visualization purposes. **Parameters and Data** This component does not expose any significant Data fields or parameters. **Dependencies and Connections** The `EPSExporter` typically requires a QTextStream output stream to write the EPS file. It fits into the scene graph as part of the visualization pipeline, handling the export of geometric primitives for post-processing or documentation purposes.
- description
- The `EPSExporter` is a component in the SOFA framework under the `vrender` namespace, inheriting from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScript) format for visualization purposes. It provides methods for spewing or writing specific geometric primitives such as points, segments, and polygons to a QTextStream output stream. These methods are protected and virtual, allowing subclasses to override them to customize the exporting behavior according to their needs. Additionally, it includes methods `writeHeader` and `writeFooter` to manage EPS file headers and footers respectively, ensuring proper formatting of the exported data.
- maths
- The `EPSExporter` is a component in the SOFA framework under the `vrender` namespace, which inherits from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScript) format for visualization purposes. This component does not directly contribute to any governing equations or operators related to finite element analysis (FEM). Instead, it provides methods for writing geometric primitives such as points, segments, and polygons to a QTextStream output stream in EPS format. The `EPSExporter` is responsible for the following tasks: 1. **Writing Geometric Primitives:** - The method `spewPoint(const Point *, QTextStream &)` writes a point to the output stream. - The method `spewSegment(const Segment *, QTextStream &)` writes a segment (line) to the output stream. - The method `spewPolygone(const Polygone *, QTextStream &)` writes a polygon to the output stream. 2. **Managing EPS File Structure:* - The method `writeHeader(QTextStream &)` writes the necessary header information for an EPS file, ensuring proper formatting and initialization of the exported data. - The method `writeFooter(QTextStream &)` appends the required footer to close the EPS file properly. These methods are protected and virtual, allowing subclasses to override them to customize the exporting behavior according to their specific requirements. Since this component is purely for visualization purposes, it does not involve any constitutive or kinematic laws, numerical discretization choices, or roles in the global FEM pipeline such as assembly, time integration, nonlinear solve, linear solve, constraint handling, or mappings.
{
"name": "EPSExporter",
"main": {
"name": "EPSExporter",
"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 `EPSExporter` is a component in the SOFA framework under the `vrender` namespace, inheriting from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScript) format for visualization purposes. It provides methods for spewing or writing specific geometric primitives such as points, segments, and polygons to a QTextStream output stream. These methods are protected and virtual, allowing subclasses to override them to customize the exporting behavior according to their needs. Additionally, it includes methods `writeHeader` and `writeFooter` to manage EPS file headers and footers respectively, ensuring proper formatting of the exported data."
},
"maths": {
"maths": "The `EPSExporter` is a component in the SOFA framework under the `vrender` namespace, which inherits from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScript) format for visualization purposes. This component does not directly contribute to any governing equations or operators related to finite element analysis (FEM). Instead, it provides methods for writing geometric primitives such as points, segments, and polygons to a QTextStream output stream in EPS format. The `EPSExporter` is responsible for the following tasks:\n\n1. **Writing Geometric Primitives:**\n - The method `spewPoint(const Point *, QTextStream &)` writes a point to the output stream.\n - The method `spewSegment(const Segment *, QTextStream &)` writes a segment (line) to the output stream.\n - The method `spewPolygone(const Polygone *, QTextStream &)` writes a polygon to the output stream.\n\n2. **Managing EPS File Structure:*\n - The method `writeHeader(QTextStream &)` writes the necessary header information for an EPS file, ensuring proper formatting and initialization of the exported data.\n - The method `writeFooter(QTextStream &)` appends the required footer to close the EPS file properly.\n\nThese methods are protected and virtual, allowing subclasses to override them to customize the exporting behavior according to their specific requirements. Since this component is purely for visualization purposes, it does not involve any constitutive or kinematic laws, numerical discretization choices, or roles in the global FEM pipeline such as assembly, time integration, nonlinear solve, linear solve, constraint handling, or mappings."
},
"summary": {
"abstract": "The `EPSExporter` exports simulation data into EPS format by writing geometric primitives such as points, segments, and polygons to a QTextStream output stream.",
"sheet": "# EPSExporter\n\n**Overview**\n\nThe `EPSExporter` is a component in the SOFA framework under the `vrender` namespace that inherits from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScript) format for visualization purposes.\n\n**Parameters and Data**\n\nThis component does not expose any significant Data fields or parameters.\n\n**Dependencies and Connections**\n\nThe `EPSExporter` typically requires a QTextStream output stream to write the EPS file. It fits into the scene graph as part of the visualization pipeline, handling the export of geometric primitives for post-processing or documentation purposes."
}
}