schrodinger.maestro.markers.LineMarker

Class LineMarker

object --+ | _BaseMarker --+ | LineMarker

Class for marking two arbitrary points. Useful for marking lines between two graphics3d objects.

init(self, coord1, entry_id1, coord2, entry_id2, marker_color=None, alt_color=None, line_width=1)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:

coord1 (List of int) - The first coordinate to mark
coord1 (List of int) - The second coordinate to mark
entry_id1 (int) - Entry ID the first coordinate is associated with. This is to simplify when the line marker should be shown and hidden.
entry_id2 (int) - Entry ID the second coordinate is associated with.
marker_color (tuple, str, int, or schrodinger.structutils.color) - The color of the marker. May be an RGB tuple, color name, color index, or schrodinger.structutils.color instance. If not given, white will be used.
alt_color (tuple, str, int, or schrodinger.structutils.color) - The alternate marker color. This color is always used for text, and is used for the marker and icon when highlight is True. If not given, color will be used.
line_width (int) - Width of the line

Overrides: object.__init__

_createMarker(self)

Create the line marker according to given options.

Overrides: _BaseMarker._createMarker

update(self)

See parent class documentation.

Update the marker in response to the workspace contents changing. If either one of the entries the marker vertices belong to is no longer included in workspace, the marker will be deleted.

Overrides: _BaseMarker.update

Class LineMarker

__init__(self, coord1, entry_id1, coord2, entry_id2, marker_color=None, alt_color=None, line_width=1) (Constructor)

_createMarker(self)

update(self)

init(self, coord1, entry_id1, coord2, entry_id2, marker_color=None, alt_color=None, line_width=1)
(Constructor)