add_object

ModelPlotter.add_object(cad_path: str, cad_color: str = 'dodgerblue', opacity: float = 1, units: str = 'mm') → bool

Add a mesh file to the scenario.

The mesh file can be an object or any of the PyVista supported files.

Parameters:

cad_pathstr

Full path to the file.

cad_colorstr or tuple

Can be a string with color name or a tuple with (r,g,b) values. The default value is "dodgerblue".

opacityfloat

Value between 0 to 1 of opacity. The default value is 1.

unitsstr

Model units. The default value is "mm".

Returns:

bool

Examples

>>> from ansys.aedt.core.visualization.plot.pyvista import ModelPlotter
>>> obj = ModelPlotter()
>>> obj.add_object(cad_path="example.stl")