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.

../../_images/OEHighlightStyle_Color.png

Example of highlighting using the ‘color’ style

Constructors

OEHighlightByColor(const OESystem::OEColor &color, double lineWidthScale=1.5)

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.
OEHighlightByColor(const OEHighlightByColor &rhs)

Copy constructor.

operator=

OEHighlightByColor &operator=(const OEHighlightByColor &rhs)

Assignment operator.

CreateCopy

OEHighlightBase *CreateCopy() const

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

bool GetAtomExternalHighlight() const

Returns whether external atom highlight is applied.

GetColor

const OESystem::OEColor &GetColor() const

Returns the color of the highlighting.

See also

GetLineWidthScale

double GetLineWidthScale() const

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

SetAtomExternalHighlight

void SetAtomExternalHighlight(bool set)

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

Example (Figure: Example of using the SetAtomExternalHighlight method)

OEHighlightByColor highlight = new OEHighlightByColor(oechem.getOELightOrange());
highlight.SetAtomExternalHighlight(true);
../../_images/OEHighlightByColor_SetAtomExternalHighlight.png

Example of using the SetAtomExternalHighlight method

SetColor

void SetColor(const OESystem::OEColor &color)

Sets the color of the highlighting.

Example (Figure: Example of using the SetColor method)

highlight.SetColor(oechem.getOEDarkRed());
../../_images/OEHighlightByColor_SetColor.png

Example of using the SetColor method

See also

SetLineWidthScale

void SetLineWidthScale(double lineWidthScale)

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)

OEHighlightByColor highlight = new OEHighlightByColor(oechem.getOEDarkRed());
highlight.SetLineWidthScale(3.0);
../../_images/OEHighlightByColor_SetLineWidthScale.png

Example of using the SetLineWidthScale method