Skip to content

Commit

Permalink
DOCS: export_field_plot and export_model_obj documentation improvement (
Browse files Browse the repository at this point in the history
lorenzovecchietti authored Nov 15, 2024
1 parent c592dac commit 2d1e606
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions src/ansys/aedt/core/visualization/post/post_common_3d.py
Original file line number Diff line number Diff line change
@@ -927,6 +927,9 @@ def export_field_file(
def export_field_plot(self, plot_name, output_dir, file_name="", file_format="aedtplt"):
"""Export a field plot.
.. note:
This method works only when the plot is active when it is run.
Parameters
----------
plot_name : str
@@ -2205,9 +2208,9 @@ def export_model_obj(self, assignment=None, export_path=None, export_as_single_o
Parameters
----------
assignment : list, optional
List of objects to export. Export every model object except 3D ones and
vacuum and air objects.
assignment : list of str, optional
List of strings with names of objects to export. Default is ``None`` in which
case export every model object except 3D ones and vacuum and air objects.
export_path : str, optional
Full path of the exported OBJ file.
export_as_single_objects : bool, optional
@@ -2219,7 +2222,7 @@ def export_model_obj(self, assignment=None, export_path=None, export_as_single_o
Returns
-------
list
List of paths for OBJ files.
Paths for OBJ files.
"""
if assignment and not isinstance(assignment, (list, tuple)):
assignment = [assignment]
@@ -2241,7 +2244,7 @@ def export_model_obj(self, assignment=None, export_path=None, export_as_single_o
and self._app.modeler[i].material_name.lower() != "air"
)
]
if export_as_single_objects:
if not export_as_single_objects:
files_exported = []
for el in assignment:
fname = os.path.join(export_path, f"{el}.obj")

0 comments on commit 2d1e606

Please sign in to comment.