pytransform3d.plot_utils.Frame#
- class pytransform3d.plot_utils.Frame(A2B, label=None, s=1.0, **kwargs)[source]#
Bases:
Artist
A Matplotlib artist that displays a frame represented by its basis.
- Parameters:
- A2Barray-like, shape (4, 4)
Transform from frame A to frame B
- labelstr, optional (default: None)
Name of the frame
- sfloat, optional (default: 1)
Length of basis vectors
- draw_label_indicatorbool, optional (default: True)
Controls whether the line from the frame origin to frame label is drawn.
- Other arguments except ‘c’ and ‘color’ are passed on to Line3D.
Methods
__init__
(A2B[, label, s])add_frame
(axis)Add the frame to a 3D axis.
draw
(renderer, *args, **kwargs)Draw the artist.
set
(*[, agg_filter, alpha, animated, ...])Set multiple properties at once.
set_data
(A2B[, label])Set the transformation data.
Attributes
- set_data(A2B, label=None)[source]#
Set the transformation data.
- Parameters:
- A2Barray-like, shape (4, 4)
Transform from frame A to frame B
- labelstr, optional (default: None)
Name of the frame
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, data=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)#
Set multiple properties at once.
Supported properties are
- Properties:
agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha: scalar or None animated: bool clip_box: .Bbox clip_on: bool clip_path: Patch or (Path, Transform) or None data: array-like, shape (4, 4) figure: .Figure gid: str in_layout: bool label: object path_effects: .AbstractPathEffect picker: None or bool or float or callable rasterized: bool sketch_params: (scale: float, length: float, randomness: float) snap: bool or None transform: .Transform url: str visible: bool zorder: float