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(const OESystem::OEColor &color, double lineWidthScale=1.5,
                   bool atomExternalHighlight = false)

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(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.

See also

• OEHighlightByColor::SetAtomExternalHighlight method

GetColor

const OESystem::OEColor &GetColor() const

Returns the color of the highlighting.

See also

• OEHighlightByColor::GetColor method

• OEColor class

GetLineWidthScale

double GetLineWidthScale() const

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

See also

• OEHighlightByColor::SetLineWidthScale method

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(OELightOrange);
highlight.SetAtomExternalHighlight(true);

Example of using the SetAtomExternalHighlight method

See also

• OEHighlightByColor::GetAtomExternalHighlight method

SetColor

void SetColor(const OESystem::OEColor &color)

Sets the color of the highlighting.

Example (Figure: Example of using the SetColor method)

highlight.SetColor(OEDarkRed);

Example of using the SetColor method

See also

• OEHighlightByColor::GetColor method

• OEColor class

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(OEDarkRed);
highlight.SetLineWidthScale(3.0);

Example of using the SetLineWidthScale method

See also

• OEHighlightByColor::GetLineWidthScale method