Package schrodinger :: Package maestro :: Module markers :: Class AtomMarker

[frames] | no frames]

Class AtomMarker

 object --+    
          |    
_BaseMarker --+
              |
             AtomMarker

Class for marking a single atom.

Instance Methods

__init__(self, atom, marker_color=None, icon=Icons.NONE, 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

setText(self, text)
Change the marker text

Inherited from _BaseMarker: applySettings, getSettings, hide, setAltColor, setColor, setHighlight, setIcon, 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__

Class Methods

Inherited from _BaseMarker: defaultSettings

Class Variables

SETTINGS_VARS = _BaseMarker.SETTINGS_VARS-{"text"}

Properties

Inherited from object: __class__

Method Details

init(self, atom, marker_color=None, icon=Icons.NONE, alt_color=None, highlight=False)
(Constructor)

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

Parameters:

atom (schrodinger.structure._StructureAtom) - The 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.
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__

_createMarker(self)

Create a marker using the criteria currently set in instance variables

Overrides: _BaseMarker._createMarker: (inherited documentation)

setText(self, text)

Change the marker text

Parameters:

text - The text to display next to the marker. If not given, no text will be displayed.

Overrides: _BaseMarker.setText

(inherited documentation)