OEHighlightMonomerDisplayOptions

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OEHighlightMonomerDisplayOptions : public OEDepict::OE2DMolDisplayOptions

The OEHighlightMonomerDisplayOptions class is used to customize molecule depiction when using OEHighlightMonomers function.

The following methods are publicly inherited from OE2DMolDisplayOptions:

`operator=`	`GetHydrogenStyle`	`SetBondLineAtomLabelGapScale`
`GetAromaticStyle`	`GetMargin`	`SetBondLineGapScale`
`GetAtomColor`	`GetScale`	`SetBondPropLabelFont`
`GetAtomColorStyle`	`GetSuperAtomLabelFont`	`SetBondPropLabelFontScale`
`GetAtomLabelFont`	`GetSuperAtomStyle`	`SetBondPropertyFunctor`
`GetAtomLabelFontScale`	`GetTitleFont`	`SetBondStereoStyle`
`GetAtomPropLabelFont`	`GetTitleFontScale`	`SetBondWidthScaling`
`GetAtomPropLabelFontScale`	`GetTitleHeight`	`SetDefaultBondPen`
`GetAtomPropertyFunctor`	`GetTitleLocation`	`SetDimensions`
`GetAtomStereoStyle`	`GetWidth`	`SetHeight`
`GetBackgroundColor`	`SetAromaticStyle`	`SetHydrogenStyle`
`GetBondColorStyle`	`SetAtomColor`	`SetMargin`
`GetBondLineAtomLabelGapScale`	`SetAtomColorStyle`	`SetMargins`
`GetBondLineGapScale`	`SetAtomLabelFont`	`SetScale`
`GetBondPropLabelFont`	`SetAtomLabelFontScale`	`SetSuperAtomLabelFont`
`GetBondPropLabelFontScale`	`SetAtomPropLabelFont`	`SetSuperAtomStyle`
`GetBondPropertyFunctor`	`SetAtomPropLabelFontScale`	`SetTitleFont`
`GetBondStereoStyle`	`SetAtomPropertyFunctor`	`SetTitleFontScale`
`GetBondWidthScaling`	`SetAtomStereoStyle`	`SetTitleHeight`
`GetDefaultBondPen`	`SetBackgroundColor`	`SetTitleLocation`
`GetHeight`	`SetBondColorStyle`	`SetWidth`

Constructors

OEHighlightMonomerDisplayOptions()

Default constructor.

OEHighlightMonomerDisplayOptions(double width, double height,
                                 double scale)

Constructor that sets the image dimensions and scale.

OEHighlightMonomerDisplayOptions(const OEHighlightMonomerDisplayOptions& rhs)

Copy constructor.

OEHighlightMonomerDisplayOptions &operator=(const OEHighlightMonomerDisplayOptions &rhs)

Assignment operator.

const OEMonomerColorBase& GetMonomerHighlightColorFunctor() const

Returns the functor that is used to determine the color used to highlight the monomers. By default, the OEMonomerColorDefault functor is used.

const OEMonomerColorBase& GetMonomerLabelColorFunctor() const

Returns the functor that is used to determine the color of the font use to draw the monomer code.

By default, the OEMonomerColorMonochrome functor is used to set all monomer code fonts to black.

void SetMonomerHighlightColorFunctor(const OEMonomerColorBase& func)

Sets the functor that is used to determine the color used to highlight the monomers.

void SetMonomerLabelColorFunctor(const OEMonomerColorBase& func)

Sets the functor that is used to determine the color of the font used to draw the monomer code.

bool GetHighlightUnspecifiedStereo() const

Returns whether monomers with unspecified stereo are highlighted.

void SetHighlightUnspecifiedStereo(bool highlight)

Sets whether monomers with unspecified stereo are highlighted.