draw_objects

ansys.motorcad.core.geometry_drawing.draw_objects(objects, label_regions=False, full_geometry=False, draw_points=None, save=None, dpi=None, legend=None, axes=True, toggle_regions=None, title=None, optimise=False, expose_region_drawing=False, draw_internal=False, display=True)

Draw geometry objects on a plot.

Parameters:

objectslist of Coordinate or Entity or Region

Geometry objects to draw

label_regionsbool

Whether labels should be drawn. Default is False

full_geometrybool

Whether duplications of regions should be drawn

draw_pointsbool

Whether to draw end and midpoints of entities. Default is False, except for sole entities.

savestr

Path to save file to. Default is None.

dpiint

Resolution of figure (used primarily when exporting images as pngs)

legendbool

Whether interactable legend should be drawn

axesbool

Whether axes should be drawn

toggle_regionslist of str

Used for GeometryTrees: provided regions will be drawn if not already, and not if already drawn.

titlestr

Title of figure

optimisebool

Whether geometry tree drawing should be optimized or not. Default is False. Incompatible with toggle_regions, as prevents regions that are not by default displayed from being calculated.

expose_region_drawingbool

Whether _RegionDrawing object should be returned (which allows access to the axes and

figure). Default is False.

draw_internalbool

Whether to draw interactive region drawing when running internally. Has no effect if saving

to file. Default is False.

displaybool

Whether to draw interactive plot. Useful to set as false when planning on further modifications to the figure before drawing.