draw_arrows

biotite.interface.pymol.draw_arrows(start, end, radius=0.1, head_radius=0.2, head_length=0.5, color=(0.5, 0.5, 0.5), head_color=None, name=None, pymol_instance=None, delete=True)

Draw three-dimensional arrows using Compiled Graphics Objects (CGOs).

Parameters:

start, endarray-like, shape=(n,3)

The start and end position of each arrow.

radius, head_radiusfloat or array-like, shape=(n,), optional

The radius of the tail and head for each arrow. Uniform for all arrows, if a single value is given.

head_lengthfloat or array-like, shape=(n,), optional

The length of each arrow head. Uniform for all arrows, if a single value is given.

color, head_colorarray-like, shape=(3,) or shape=(n,3), optional

The color of the tail and head for each arrow, given as RGB values in the range (0, 1). Uniform for all arrows, if a single value is given. If no head_color is given, the arrows are single-colored.

namestr, optional

The name of the newly created CGO object. If omitted, a unique name is generated.

pymol_instancemodule or SingletonPyMOL or PyMOL, optional

If PyMOL is used in library mode, the PyMOL or SingletonPyMOL object is given here. If otherwise PyMOL is used in GUI mode, the pymol module is given. By default the currently active PyMOL instance is used. If no PyMOL instance is currently running, PyMOL is started in library mode.

deletebool, optional

If set to true, the underlying PyMOL object will be removed from the PyMOL session, when the returned PyMOLObject is garbage collected.

Returns:

pymol_objectPyMOLObject

The created PyMOLObject representing the drawn CGOs.