schrodinger.maestro.markers.PairMarker

Class PairMarker

object --+ | _BaseMarker --+ | PairMarker

Class for marking two atoms. Useful for marking bonds and distances.

Instance Methods

__init__(self, atom1, atom2, marker_color=None, icon=Icons.NONE, text="", alt_color=None, highlight=False)
x.__init__(...) initializes x; see help(type(x)) for signature

_createMarker(self)
Create a marker using the criteria currently set in instance variables

Inherited from _BaseMarker: applySettings, getSettings, hide, setAltColor, setColor, setHighlight, setIcon, setText, setVisible, show, update

Inherited from _BaseMarker (private): _altColorToRgb, _colorToRgb, _getAltColor, _getEntryAtomNumbers, _getWorkspaceAtomNumbers

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

init(self, atom1, atom2, marker_color=None, icon=Icons.NONE, text="", alt_color=None, highlight=False)
(Constructor)

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

Parameters:

atom1 (schrodinger.structure._StructureAtom) - The first atom to mark
atom2 (schrodinger.structure._StructureAtom) - The second atom to mark
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.
icon (int) - The icon to draw next to the marker. Should be one the Icons.* constants. If not given, no icon will be drawn.
text (str) - The text to display next to the marker. If not given, no text will be displayed.
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.
highlight (bool) - Whether the marker should be highlighted. A highlighted marker is indicated with thicker lines and is colored using alt_color instead of color.

Overrides: object.__init__

Note: Either an icon or text may be displayed on a marker, but not both. If both are given, only the text will be shown.

_createMarker(self)

Create a marker using the criteria currently set in instance variables

Overrides: _BaseMarker._createMarker: (inherited documentation)

Class PairMarker

__init__(self, atom1, atom2, marker_color=None, icon=Icons.NONE, text="", alt_color=None, highlight=False) (Constructor)

_createMarker(self)

init(self, atom1, atom2, marker_color=None, icon=Icons.NONE, text="", alt_color=None, highlight=False)
(Constructor)