OEHighlightByColor

class OEHighlightByColor : public OEHighlightBase

The OEHighlightByColor class allows the customization of the color highlighting style that is associated with the OEHighlightStyle_Color constant. See example in Figure: Example of highlighting using the ‘color’ style.

Example of highlighting using the ‘color’ style

The OEHighlightByColor class stores the following properties:

Property	Get method	Set method	Corresponding namespace / class / type
external highlight	GetAtomExternalHighlight	SetAtomExternalHighlight	boolean
color	GetColor	SetColor	OEColor
line width scale	GetLineWidthScale	SetLineWidthScale	floating point

See also

• OEAddHighlighting function

• OEHighlightStyle namespace

• OEHighlightByBallAndStick class

• OEHighlightByCogwheel class

• OEHighlightByLasso class

• OEHighlightByStick class

• Highlighting chapter

Constructors

OEHighlightByColor(color: OEColor, lineWidthScale: float = 1.5,
                   atomExternalHighlight: bool = False) -> OEHighlightByColor

Creates an OEHighlightByColor object with the specified parameters.

color

The color used for highlighting. See also OEHighlightByColor.SetColor method.

lineWidthScale

The multiplier that can be used to increase or decrease the line width of highlighted bond(s). See also OEHighlightByColor.SetLineWidthScale method.

atomExternalHighlight

Sets whether atom highlights are extended to bonds not being highlighted. See also OEHighlightByColor.SetAtomExternalHighlight method.

OEHighlightByColor(rhs: OEHighlightByColor) -> OEHighlightByColor

Copy constructor.

CreateCopy

CreateCopy() -> OEHighlightByColor

Deep copy constructor that returns a copy of the object. The memory for the returned OEHighlightByColor object is dynamically allocated and owned by the caller.

GetAtomExternalHighlight

GetAtomExternalHighlight() -> bool

Returns whether external atom highlight is applied.

See also

• OEHighlightByColor.SetAtomExternalHighlight method

GetColor

GetColor() -> OEColor

Returns the color of the highlighting.

See also

• OEHighlightByColor.GetColor method

• OEColor class

GetLineWidthScale

GetLineWidthScale() -> float

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

See also

• OEHighlightByColor.SetLineWidthScale method

SetAtomExternalHighlight

SetAtomExternalHighlight(atomexternal: bool) -> None

Sets whether atom highlights are extended to bonds not being highlighted.

Example (Figure: Example of using the SetAtomExternalHighlight method)

highlight = oedepict.OEHighlightByColor(oechem.OELightOrange)
highlight.SetAtomExternalHighlight(True)

Example of using the SetAtomExternalHighlight method

See also

• OEHighlightByColor.GetAtomExternalHighlight method

SetColor

SetColor(color: OEColor) -> None

Sets the color of the highlighting.

Example (Figure: Example of using the SetColor method)

highlight.SetColor(oechem.OEDarkRed)

Example of using the SetColor method

See also

• OEHighlightByColor.GetColor method

• OEColor class

SetLineWidthScale

SetLineWidthScale(lineWidthScale: float) -> None

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

Example (Figure: Example of using the SetLineWidthScale method)

highlight = oedepict.OEHighlightByColor(oechem.OEDarkRed)
highlight.SetLineWidthScale(3.0)

Example of using the SetLineWidthScale method

See also

• OEHighlightByColor.GetLineWidthScale method