OEHighlightByCogwheel¶

class OEHighlightByCogwheel : public OEHighlightBase


The OEHighlightByCogwheel class allows the customization of the cogwheel highlighting style that is associated with the OEHighlightStyle_Cogwheel constant. See example in Figure: Example of highlighting using the ‘cogwheel’ style.

Example of highlighting using the color style

Constructors¶

OEHighlightByCogwheel(const OESystem::OEColor &color, double lineWidthScale=1.5,
bool innerContour=true, bool monochrome=true)


Creates an OEHighlightByCogwheel object with the specified parameters.

color
lineWidthScale
The multiplier that can be used to increase or decrease the line width of the ‘cogwheel’. See also OEHighlightByCogwheel.SetLineWidthScale method.
stickWidthScale
The multiplier that can be used to increase or decrease the stick width of the ‘cogwheel’ of the highlighted bond(s). See also OEHighlightByCogwheel.SetStickWidthScale method.
The multiplier that can be used to increase or decrease the ball radius of the ‘cogwheel’ of the highlighted atom(s). See also OEHighlightByCogwheel.SetBallRadiusScale method.
innerContour
Defines whether the inner contour of the ‘cogwheel’ is drawn or committed. See also OEHighlightByCogwheel.SetInnerContour method.
monochrome
Defines whether or not to change the color of the atom label of the highlighted atom(s). See also OEHighlightByCogwheel.SetAtomLabelMonochrome method.
OEHighlightByCogwheel(const OEHighlightByCogwheel &rhs)


Copy constructor.

operator=¶

OEHighlightByCogwheel &operator=(const OEHighlightByCogwheel &rhs)


Assignment operator.

CreateCopy¶

OEHighlightBase *CreateCopy() const


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

GetAtomLabelMonochrome¶

bool GetAtomLabelMonochrome() const


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

double GetBallRadiusScale() const


Returns the multiplier that can be used to increase or decrease the ball radius of the ‘cogwheel’ of the highlighted atom(s).

GetColor¶

const OESystem::OEColor &GetColor() const


Returns the color of the highlighting.

GetInnerContour¶

bool GetInnerContour() const


Returns whether the inner contour of the ‘cogwheel’ is drawn or committed.

GetLineWidthScale¶

double GetLineWidthScale() const


Returns the multiplier that can be used to increase or decrease the line width of the ‘cogwheel’

GetStickWidthScale¶

double GetStickWidthScale() const


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

SetAtomLabelMonochrome¶

void SetAtomLabelMonochrome(bool monochrome)


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

highlight = OEHighlightByCogwheel(OEDarkPurple)
highlight.SetAtomLabelMonochrome(False)


Example of using the SetAtomLabelMonochrome method

void SetBallRadiusScale(double ballRadiusScale)


Sets the multiplier that can be used to increase or decrease the ball radius of the ‘cogwheel’ of the highlighted atom(s).

highlight = OEHighlightByCogwheel(OEDarkPurple)


Example of using the SetBallRadiusScale method

SetColor¶

void SetColor(const OESystem::OEColor &color)


Sets the color of the highlighting.

highlight.SetColor(OEDarkPurple)


Example of using the SetColor method

SetInnerContour¶

void SetInnerContour(bool innerContour)


Sets whether the inner contour of the ‘cogwheel’ is drawn or omitted.

highlight = OEHighlightByCogwheel(OEDarkPurple)
highlight.SetInnerContour(False)


Example of using the SetInnerContour method

SetLineWidthScale¶

void SetLineWidthScale(double lineWidthScale)


Sets the multiplier that can be used to increase or decrease the line width of the ‘cogwheel’

highlight = OEHighlightByCogwheel(OEDarkPurple)
highlight.SetLineWidthScale(3.0)


Example of using the SetLineWidthScale method

SetStickWidthScale¶

void SetStickWidthScale(double stickWidthScale)


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

highlight = OEHighlightByCogwheel(OEDarkPurple)
highlight.SetStickWidthScale(5.0)


Example of using the SetStickWidthScale method