Pyqtgraph’s Artists¶

Artists for the pyqtgraph backend.

Classes:

`Line3D`(x, y, z, **kwargs)	Artist to plot 3D lines.
`PgArtistBase`(*gl_items)	Base class for artists used in pyqtgraph scene.
`Point3D`(x, y, z, **kwargs)	Artist to plot 3D lines.
`Vector3D`(origin, vector[, as_mesh])	Artist to plot 3D vectors.

class symmeplot.pyqtgraph.artists.Line3D(x: Sequence[float], y: Sequence[float], z: Sequence[float], **kwargs: object)¶

Bases: PgArtistBase

Artist to plot 3D lines.

Attributes:

`gl_items`	The pyqtgraph item.
`visible`	If the artist is visible.

Methods:

`plot`(view)	Add the artist to the view.
`update_data`(x, y, z)	Update the data of the artist.

property gl_items: tuple[<module 'pyqtgraph.opengl.GLGraphicsItem' from '/home/runner/work/symmeplot/symmeplot/.venv/lib/python3.12/site-packages/pyqtgraph/opengl/GLGraphicsItem.py'>, ...]¶: The pyqtgraph item.

plot(view: GLViewWidget) → None¶: Add the artist to the view.

update_data(x: Sequence[float], y: Sequence[float], z: Sequence[float]) → None¶: Update the data of the artist.

property visible: bool¶: If the artist is visible.

class symmeplot.pyqtgraph.artists.PgArtistBase(*gl_items: <module 'pyqtgraph.opengl.GLGraphicsItem' from '/home/runner/work/symmeplot/symmeplot/.venv/lib/python3.12/site-packages/pyqtgraph/opengl/GLGraphicsItem.py'>)¶

Bases: ArtistBase

Base class for artists used in pyqtgraph scene.

Attributes:

`gl_items`	The pyqtgraph item.
`visible`	If the artist is visible.

Methods:

`plot`(view)	Add the artist to the view.
`update_data`(*args)	Update the data of the artist.

property gl_items: tuple[<module 'pyqtgraph.opengl.GLGraphicsItem' from '/home/runner/work/symmeplot/symmeplot/.venv/lib/python3.12/site-packages/pyqtgraph/opengl/GLGraphicsItem.py'>, ...]¶: The pyqtgraph item.

plot(view: GLViewWidget) → None¶: Add the artist to the view.

abstract update_data(*args: object) → None¶: Update the data of the artist.

property visible: bool¶: If the artist is visible.

class symmeplot.pyqtgraph.artists.Point3D(x: float, y: float, z: float, **kwargs: object)¶

Bases: PgArtistBase

Artist to plot 3D lines.

Attributes:

`gl_items`	The pyqtgraph item.
`visible`	If the artist is visible.

Methods:

`plot`(view)	Add the artist to the view.
`update_data`(x, y, z)	Update the data of the artist.

property gl_items: tuple[<module 'pyqtgraph.opengl.GLGraphicsItem' from '/home/runner/work/symmeplot/symmeplot/.venv/lib/python3.12/site-packages/pyqtgraph/opengl/GLGraphicsItem.py'>, ...]¶: The pyqtgraph item.

plot(view: GLViewWidget) → None¶: Add the artist to the view.

update_data(x: float, y: float, z: float) → None¶: Update the data of the artist.

property visible: bool¶: If the artist is visible.

class symmeplot.pyqtgraph.artists.Vector3D(origin: Sequence[float], vector: Sequence[float], as_mesh: bool = False, **kwargs: object)¶

Bases: PgArtistBase

Artist to plot 3D vectors.

Parameters:

origin (Sequence[float]) – The origin of the vector.
vector (Sequence[float]) – The vector to plot.
as_mesh (bool, optional) – If True, the vector is plotted as a mesh, by default False.
vector_radius (float, optional) – The radius of the vector if plotted as mesh, by default defined as classattribute.
head_width (float, optional) – The width of the head of the vector if plotted as mesh, by default defined as classattribute.
head_length (float, optional) – The length of the head of the vector if plotted as mesh, by default defined as classattribute.
mesh_resolution (int, optional) – The number of points in the circle if plotted as mesh, by default defined as classattribute.

Attributes:

`gl_items`	The pyqtgraph item.
`visible`	If the artist is visible.

Methods:

`plot`(view)	Add the artist to the view.
`update_data`(origin, vector)	Update the data of the artist.

property gl_items: tuple[<module 'pyqtgraph.opengl.GLGraphicsItem' from '/home/runner/work/symmeplot/symmeplot/.venv/lib/python3.12/site-packages/pyqtgraph/opengl/GLGraphicsItem.py'>, ...]¶: The pyqtgraph item.

plot(view: GLViewWidget) → None¶: Add the artist to the view.

update_data(origin: Sequence[float], vector: Sequence[float]) → None¶: Update the data of the artist.

property visible: bool¶: If the artist is visible.