sdynpy.core.sdynpy_geometry.GeometryPlotter

Signature¶

class sdynpy.core.sdynpy_geometry.GeometryPlotter(*args, **kwargs)

Class used to plot geometry

This class is essentially identical to PyVista’s BackgroundPlotter; however a small amount of additional functionality is added.

Name	Summary
`__init__`	Initialize the qt plotter.
`hide_origin_marker`
`save_rotation_animation`	Saves an animation of the rotating geometry to a file
`show_origin_marker`

def sdynpy.core.sdynpy_geometry.GeometryPlotter.__init__(self, *args, **kwargs)

Initialize the qt plotter.

def sdynpy.core.sdynpy_geometry.GeometryPlotter.hide_origin_marker(self)

def sdynpy.core.sdynpy_geometry.GeometryPlotter.save_rotation_animation(self, filename=None, frames=20, frame_rate=20, individual_images=False)

Saves an animation of the rotating geometry to a file

filename : str, optional Path to the file being saved. The default is None, which returns the images as an array rather than saves them to a file
frames : int, optional Number of frames in the animation. The default is 20.
frame_rate : float, optional Number of frames per second if the animation is saved to a GIF. The default is 20.
individual_images : bool, optional Boolean to specify whether the images are saved as individual PNG files or a single GIF. The default is False.

imgs : np.ndarray or None Returns array of images if filename is None, otherwise returns None

def sdynpy.core.sdynpy_geometry.GeometryPlotter.show_origin_marker(self, arrow_scale=0.05)