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.

../../_images/OEHighlightStyle_Cogwheel.png

Example of highlighting using the color style¶

The OEHighlightByCogwheel class stores the following properties:

Property	Get method	Set method	Corresponding namespace / class / type
atom label	`GetAtomLabelMonochrome`	`SetAtomLabelMonochrome`	boolean
ball radius scale	`GetBallRadiusScale`	`SetBallRadiusScale`	floating point number
color	`GetColor`	`SetColor`	OEColor
inner contour	`GetInnerContour`	`SetInnerContour`	boolean
line width scale	`GetLineWidthScale`	`SetLineWidthScale`	floating point number
stick width scale	`GetStickWidthScale`	`SetStickWidthScale`	floating point number

See also

Constructors¶

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

Creates an OEHighlightByCogwheel object with the specified parameters.

color: The color used for highlighting. See also OEHighlightByCogwheel.SetColor method.
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.
ballRadiusScale: 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.

See also

OEHighlightByCogwheel.SetAtomLabelMonochrome method

GetBallRadiusScale¶

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

See also

OEHighlightByCogwheel.SetBallRadiusScale method

GetColor¶

const OESystem::OEColor &GetColor() const

Returns the color of the highlighting.

See also

OEHighlightByCogwheel.SetColor method
OEColor class

GetInnerContour¶

bool GetInnerContour() const

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

See also

OEHighlightByCogwheel.SetInnerContour method

GetLineWidthScale¶

double GetLineWidthScale() const

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

See also

OEHighlightByCogwheel.SetLineWidthScale method

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

See also

OEHighlightByCogwheel.SetStickWidthScale method

SetAtomLabelMonochrome¶

void SetAtomLabelMonochrome(bool monochrome)

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)

OEHighlightByCogwheel highlight = new OEHighlightByCogwheel(oechem.getOEDarkPurple());
highlight.SetAtomLabelMonochrome(false);

../../_images/OEHighlightByCogwheel_SetAtomLabelMonochrome.png

Example of using the SetAtomLabelMonochrome method¶

See also

OEHighlightByCogwheel.GetAtomLabelMonochrome method

SetBallRadiusScale¶

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

Example (Figure: Example of using the SetBallRadiusScale method)

OEHighlightByCogwheel highlight = new OEHighlightByCogwheel(oechem.getOEDarkPurple());
highlight.SetBallRadiusScale(5.0);

../../_images/OEHighlightByCogwheel_SetBallRadiusScale.png

Example of using the SetBallRadiusScale method¶

See also

OEHighlightByCogwheel.GetBallRadiusScale 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.getOEDarkPurple());

../../_images/OEHighlightByCogwheel_SetColor.png

Example of using the SetColor method¶

See also

OEHighlightByCogwheel.GetColor method
OEColor class

SetInnerContour¶

void SetInnerContour(bool innerContour)

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

Example (Figure: Example of using the SetInnerContour method)

OEHighlightByCogwheel highlight = new OEHighlightByCogwheel(oechem.getOEDarkPurple());
highlight.SetInnerContour(false);

../../_images/OEHighlightByCogwheel_SetInnerContour.png

Example of using the SetInnerContour method¶

See also

OEHighlightByCogwheel.GetInnerContour method

SetLineWidthScale¶

void SetLineWidthScale(double lineWidthScale)

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

Example (Figure: Example of using the SetLineWidthScale method)

OEHighlightByCogwheel highlight = new OEHighlightByCogwheel(oechem.getOEDarkPurple());
highlight.SetLineWidthScale(3.0); 

../../_images/OEHighlightByCogwheel_SetLineWidthScale.png

Example of using the SetLineWidthScale method¶

See also

OEHighlightByCogwheel.GetLineWidthScale 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).

Example (Figure: Example of using the SetStickWidthScale method)

OEHighlightByCogwheel highlight = new OEHighlightByCogwheel(oechem.getOEDarkPurple());
highlight.SetStickWidthScale(5.0);

../../_images/OEHighlightByCogwheel_SetStickWidthScale.png

Example of using the SetStickWidthScale method¶

See also

OEHighlightByCogwheel.GetStickWidthScale method