Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: export_field_plot and export_model_obj documentation improvement #5432

Merged
merged 6 commits into from
Nov 15, 2024
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
Expand Up @@ -927,6 +927,9 @@
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
Expand Down Expand Up @@ -2205,9 +2208,9 @@

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
Expand All @@ -2219,7 +2222,7 @@
Returns
-------
list
List of paths for OBJ files.
Paths for OBJ files.
"""
if assignment and not isinstance(assignment, (list, tuple)):
assignment = [assignment]
Expand All @@ -2241,7 +2244,7 @@
and self._app.modeler[i].material_name.lower() != "air"
)
]
if export_as_single_objects:
if not export_as_single_objects:

Check warning on line 2247 in src/ansys/aedt/core/visualization/post/post_common_3d.py

View check run for this annotation

Codecov / codecov/patch

src/ansys/aedt/core/visualization/post/post_common_3d.py#L2247

Added line #L2247 was not covered by tests
files_exported = []
for el in assignment:
fname = os.path.join(export_path, f"{el}.obj")
Expand Down
Loading