OEHighlightByBallAndStick

class OEHighlightByBallAndStick : public OEHighlightBase

The OEHighlightByBallAndStick class allows the customization of the ball and stick highlighting style that is associated with the OEHighlightStyle::BallAndStick constant. See example in Figure: Example of highlighting using the ‘ball and stick’ style.

../../_images/OEHighlightStyle_BallAndStick.png — **Example of highlighting using the ‘ball and stick’ style**

The OEHighlightByBallAndStick 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
stick width scale	`GetStickWidthScale`	`SetStickWidthScale`	floating point number

See also

Constructors

OEHighlightByBallAndStick(const OESystem::OEColor &c,
                          double stickWidthScale=3.0, double ballRadiusScale=3.0,
                          bool monochrome=true)

Creates an OEHighlightByBallAndStick object with the specified parameters.

color: The color used for highlighting. See also OEHighlightByBallAndStick::SetColor method.
stickWidthScale: The multiplier that can be used to increase or decrease the stick width of the highlighted bond(s). See also OEHighlightByBallAndStick::SetStickWidthScale method.
ballRadiusScale: The multiplier that can be used to increase or decrease the ball radius of the highlighted atom(s). See also OEHighlightByBallAndStick::SetBallRadiusScale method.
monochrome: Defines whether or not to change the color of the atom label of the highlighted atom(s). See also OEHighlightByBallAndStick::SetAtomLabelMonochrome method.

OEHighlightByBallAndStick(const OEHighlightByBallAndStick &rhs)

Copy constructor.

operator=

OEHighlightByBallAndStick &operator=(const OEHighlightByBallAndStick &rhs)

Assignment operator.

CreateCopy

OEHighlightBase *CreateCopy() const

Deep copy constructor that returns a copy of the object. The memory for the returned OEHighlightByBallAndStick 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

OEHighlightByBallAndStick::SetAtomLabelMonochrome method

GetBallRadiusScale

double GetBallRadiusScale() const

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

See also

OEHighlightByBallAndStick::SetBallRadiusScale method

GetColor

const OESystem::OEColor &GetColor() const

See also

OEHighlightByBallAndStick::SetColor method
OEColor class

GetStickWidthScale

double GetStickWidthScale() const

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

See also

OEHighlightByBallAndStick::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)

OEHighlightByBallAndStick highlight(OEPinkTint);
highlight.SetAtomLabelMonochrome(false);

../../_images/OEHighlightByBallAndStick_SetAtomLabelMonochrome.png — **Example of using the SetAtomLabelMonochrome method**

See also

OEHighlightByBallAndStick::GetAtomLabelMonochrome method

SetBallRadiusScale

void SetBallRadiusScale(double ballRadiusScale)

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

Example (Figure: Example of using the SetBallRadiusScale method)

OEHighlightByBallAndStick highlight(OEPinkTint);
highlight.SetBallRadiusScale(4.0);

../../_images/OEHighlightByBallAndStick_SetBallRadiusScale.png — **Example of using the SetBallRadiusScale method**

See also

OEHighlightByBallAndStick::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(OEPinkTint);

../../_images/OEHighlightByBallAndStick_SetColor.png — **Example of using the SetColor method**

See also

OEHighlightByBallAndStick::GetColor method
OEColor class

SetStickWidthScale

void SetStickWidthScale(double stickWidthScale)

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

Example (Figure: Example of using the SetStickWidthScale method)

OEHighlightByBallAndStick highlight(OEPinkTint);
highlight.SetStickWidthScale(5.0);

../../_images/OEHighlightByBallAndStick_SetStickWidthScale.png — **Example of using the SetStickWidthScale method**

See also

OEHighlightByBallAndStick::GetStickWidthScale method