OEHighlightOverlayByBallAndStick

class  OEHighlightOverlayByBallAndStick : public OEHighlightOverlayBase

The OEHighlightOverlayByBallAndStick class allows the customization of the ball and stick highlighting style that is associated with the OEHighlightOverlayStyle_BallAndStick constant. This style enables the highlighting of overlapping patterns. See example in Figure: Example of overlay highlighting using the ‘ball and stick’ style.

../../_images/OEHighlightOverlayStyle_BallAndStick.png — **Example of overlay highlighting using the ‘ball and stick’ style**

See also

OEAddHighlightOverlay function.
OEHighlightOverlayStyle namespace
Highlighting Overlapped Patterns section

Note

It is recommended to select colors with high contrast when highlighting overlapped patterns with the OEHighlightOverlayByBallAndStick class.

See also

OEGetContrastColors function

The following methods are publicly inherited from OEHighlightOverlayBase:

GetColors

SetColors

Constructors

OEHighlightOverlayByBallAndStick(colors: OEColorIter,
                                 stickWidthScale: float = 3.0,
                                 ballRadiusScale: float = 3.0,
                                 monochrome: bool = True) -> OEHighlightOverlayByBallAndStick

Creates an OEHighlightOverlayByBallAndStick object with the specified parameters

colors: The colors used for highlighting. See also OEHighlightOverlayBase.SetColors method.
stickWidthScale: The multiplier that can be used to increase or decrease the stick width of the highlighted bond(s). See also OEHighlightOverlayByBallAndStick.SetStickWidthScale method.
ballRadiusScale: The multiplier that can be used to increase or decrease the ball radius of the highlighted atoms(s). See also OEHighlightOverlayByBallAndStick.SetBallRadiusScale method.
monochrome: Defines whether or not to change the color of the atom label of the highlighted atom(s). See also OEHighlightOverlayByBallAndStick.SetAtomLabelMonochrome method.

OEHighlightOverlayByBallAndStick(rhs: OEHighlightOverlayByBallAndStick) -> OEHighlightOverlayByBallAndStick

Copy constructor.

GetAtomLabelMonochrome

GetAtomLabelMonochrome() -> bool

Returns whether or not the color of the atom label of the highlighted atom(s) is changed.

See also

OEHighlightOverlayByBallAndStick.SetAtomLabelMonochrome method

GetBallRadiusScale

GetBallRadiusScale() -> float

Returns the multiplier that can be used to increase or decrease the ball radius of the highlighted atoms(s).

See also

OEHighlightOverlayByBallAndStick.SetBallRadiusScale method

GetStickWidthScale

GetStickWidthScale() -> float

Returns the multiplier that can be used to increase or decrease the stick width of the highlighted bond(s).

See also

OEHighlightOverlayByBallAndStick.SetStickWidthScale method

SetAtomLabelMonochrome

SetAtomLabelMonochrome(monochrome: bool) -> None

Sets whether or not to change the color of the atom label of the highlighted atom(s).

Example (Figure: Example of using the SetAtomLabelMonochrome method)

highlight = oedepict.OEHighlightOverlayByBallAndStick(oechem.OEGetVividColors())
highlight.SetAtomLabelMonochrome(False)

../../_images/OEHighlightOverlayByBallAndStick_SetAtomLabelMonochrome.png — **Example of using the SetAtomLabelMonochrome method**

See also

OEHighlightOverlayByBallAndStick.GetAtomLabelMonochrome method

SetBallRadiusScale

SetBallRadiusScale(ballRadiusScale: float) -> None

Sets the multiplier that can be used to increase or decrease the ball radius of the highlighted atoms(s).

Example (Figure: Example of using the SetBallRadiusScale method)

highlight = oedepict.OEHighlightOverlayByBallAndStick(oechem.OEGetVividColors())
highlight.SetBallRadiusScale(4.0)

../../_images/OEHighlightOverlayByBallAndStick_SetBallRadiusScale.png — **Example of using the SetBallRadiusScale method**

See also

OEHighlightOverlayByBallAndStick.GetBallRadiusScale method

SetStickWidthScale

SetStickWidthScale(stickWidthScale: float) -> None

Sets the multiplier that can be used to increase or decrease the stick width of the highlighted bond(s).

Example (Figure: Example of using the SetStickWidthScale method)

highlight = oedepict.OEHighlightOverlayByBallAndStick(oechem.OEGetVividColors())
highlight.SetStickWidthScale(5.0)

../../_images/OEHighlightOverlayByBallAndStick_SetStickWidthScale.png — **Example of using the SetStickWidthScale method**

See also

OEHighlightOverlayByBallAndStick.GetStickWidthScale method