`draw_cgo`#

biotite.interface.pymol.draw_cgo(cgo_list, name=None, pymol_instance=None, delete=True)[source]#

Draw geometric shapes using Compiled Graphics Objects (CGOs).

Each CGO is represented by a list of floats, which can be obtained via the get_xxx_cgo() functions.

Parameters:

cgo_listlist of list of float: The CGOs to draw. It is recommended to use a get_xxx_cgo() function to obtain the elements for this list, if possible. Otherwise, shapes may be drawn incorrectly or omitted entirely, if a CGO is incorrectly formatted.
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.

draw_cgo#