sdynpy.core.sdynpy_geometry.ShapePlotter

• Module: sdynpy.core.sdynpy_geometry

• Source: GitHub

• Parent: sdynpy.core.sdynpy_geometry.GeometryPlotter

• Parent: pyvistaqt.plotting.BackgroundPlotter

• Parent: pyvistaqt.plotting.QtInteractor

• Parent: pyvistaqt.rwi.QVTKRenderWindowInteractor

• Parent: PyQt5.QtWidgets.QWidget

• Parent: PyQt5.QtCore.QObject

• Parent: sip.wrapper

• Parent: PyQt5.QtGui.QPaintDevice

• Parent: sip.simplewrapper

• Parent: pyvista.plotting.plotter.BasePlotter

• Parent: pyvista.core.utilities.misc._BoundsSizeMixin

• Parent: pyvista.plotting.picking.PickingHelper

• Parent: pyvista.plotting.picking.PickingMethods

• Parent: pyvista.plotting.picking.PickingInterface

• Parent: pyvista.plotting.widgets.WidgetHelper

Signature¶

class sdynpy.core.sdynpy_geometry.ShapePlotter(geometry, shapes, plot_kwargs, background_plotter_kwargs={'auto_update': 0.01}, undeformed_opacity=0.25, starting_scale=1.0, deformed_opacity=1.0, shape_name='Mode', show_damping=True)

Class used to plot animated shapes

Methods¶

__init__¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.__init__(self, geometry, shapes, plot_kwargs, background_plotter_kwargs={'auto_update': 0.01}, undeformed_opacity=0.25, starting_scale=1.0, deformed_opacity=1.0, shape_name='Mode', show_damping=True)

Create a Shape Plotter object to plot shapes

Parameters¶

• geometry : Geometry Geometry on which the shapes will be plotted

• shapes : ShapeArray Shapes to plot on the geometry

• plot_kwargs : dict Keyword arguments passed to the Geometry.plot function

• background_plotter_kwargs : dict, optional Keyword arguments passed to the BackgroundPlotter constructor. The default is {‘auto_update’:0.01}.

• undeformed_opacity : float, optional Opacity of the undeformed geometry. Set to zero for no undeformed geometry. The default is 0.25.

• starting_scale : float, optional Starting scale of the shapes on the plot. The default is 1.0.

• shape_name : str, optional Name that will be used in the plotter to describe the shape. The default is “Mode”

• show_damping : bool, optional Boolean that specifies whether the damping should be displayed in the comment.

add_menu_bar¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.add_menu_bar(self) -> None

Adds the menu bar to the BackgroundPlotter

add_toolbars¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.add_toolbars(self) -> None

Adds toolbars to the BackgroundPlotter

compute_displacements¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.compute_displacements(self, compute_scale=True) -> numpy.ndarray

Computes displacements to apply to the geometry

Parameters¶

• compute_scale : bool, optional Renormalize the displacement scaling. The default is True.

next_shape¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.next_shape(self) -> None

Increases the index of the shape being plotted

play_animation¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.play_animation(self)

Starts the animation playing

prev_shape¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.prev_shape(self) -> None

Decreases the index of the shape being plotted

reset_shape¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.reset_shape(self) -> None

Resets a shape if the value of the current shape is changed

save_animation¶

• Source: GitHub

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

Saves the current shape animation to a file

Parameters¶

• 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.

Returns¶

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

save_animation_all_shapes¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.save_animation_all_shapes(self, filename_base='Shape_{:}.gif', frames=20, frame_rate=20, individual_images=False)

Helper function to easily save animations for all shapes

Parameters¶

• filename_base : str, optional Filename that will be passed to the format function to produce the actual file name for each shape. The default is ‘Shape_{:}.gif’.

• 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.

save_animation_from_action¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.save_animation_from_action(self)

select_complex¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_complex(self) -> None

Adjusts how complex shapes are plotted

select_loop¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_loop(self) -> None

select_scaling_0p25¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_scaling_0p25(self)

Adjusts the current shape scaling by 0.25x

select_scaling_0p5¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_scaling_0p5(self)

Adjusts the current shape scaling by 0.5x

select_scaling_0p8¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_scaling_0p8(self)

Adjusts the current shape scaling by 0.8x

select_scaling_1¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_scaling_1(self)

Resets shape scaling to 1

select_scaling_1p25¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_scaling_1p25(self)

Adjusts the current shape scaling by 1.25x

select_scaling_2p0¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_scaling_2p0(self)

Adjusts the current shape scaling by 2x

select_scaling_4p0¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_scaling_4p0(self)

Adjusts the current shape scaling by 4x

select_shape¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_shape(self) -> None

select_speed_0p8¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_speed_0p8(self)

Adjusts the current animation speed by 0.8

select_speed_1¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_speed_1(self)

Resets animation speed to default quantities

select_speed_1p25¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.select_speed_1p25(self)

Adjusts the current animation speed by 1.25

show_comment¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.show_comment(self)

Shows or hides the shape comment

stop_animation¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.stop_animation(self)

Stops the animation from playing

toggle_undeformed¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.toggle_undeformed(self) -> None

update_shape¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.update_shape(self)

Updates the shape that is being plotted

update_shape_mode¶

• Source: GitHub

def sdynpy.core.sdynpy_geometry.ShapePlotter.update_shape_mode(self, phase=None)

Updates the mode that is being plotted

Parameters¶

• phase : float, optional Sets the current phase of the shape. The default is None, which computes the new phase based on the time elapsed.