OEShapeQueryDisplayOptions

class OEShapeQueryDisplayOptions : public OEDepict::OE2DMolDisplayOptions

This class represents OEShapeQueryDisplayOptions that encapsulates properties that determine how the reference molecule of a shape overlap is depicted by the OERenderShapeQuery function.

See also

• OEShapeQueryDisplay class

• OERenderShapeQuery function

Code Example

• Visualizing Shape and Color Overlap OpenEye Python Cookbook recipe

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

OEShapeQueryDisplayOptions()

Default constructor.

OEShapeQueryDisplayOptions(const OEShapeQueryDisplayOptions &rhs)

Copy constructors.

operator=

OEShapeQueryDisplayOptions &operator=(const OEShapeQueryDisplayOptions &rhs)

Assignment operator.

ClearSurfaceArcFxn

void ClearSurfaceArcFxn()

Removes the surface drawing functor that is drawn to represent the 2D molecule surface of the reference molecule.

See also

• OEShapeQueryDisplayOptions.GetSurfaceArcFxn

• OEShapeQueryDisplayOptions.SetSurfaceArcFxn

GetClearBackground

bool GetClearBackground() const

Returns whether or not the image is cleared (by calling OEImageBase.Clear method) prior to the rendering of the shape query.

See also

• OEShapeQueryDisplayOptions.SetClearBackground

GetColorAtomStyle

unsigned int GetColorAtomStyle() const

Returns the style that is used to define how color atoms are depicted by the OERenderShapeQuery function. The return value is taken from the OEColorAtomStyle namespace.

See also

• OEShapeQueryDisplayOptions.SetColorAtomStyle

• OEColorAtomStyle namespace

GetDepictOrientation

unsigned int GetDepictOrientation() const

Returns the preferred orientation of 2D layout if the shape query. The return value is taken from the OEDepictOrientation namespace.

See also

• OEShapeQueryDisplayOptions.SetDepictOrientation method

GetSurfaceArcFxn

const OESurfaceArcFxnBase *GetSurfaceArcFxn() const

Returns the surface drawing functor that is drawn to represent the 2D molecule surface of the reference molecule.

See also

• OEShapeQueryDisplayOptions.ClearSurfaceArcFxn

• OEShapeQueryDisplayOptions.SetSurfaceArcFxn

SetClearBackground

void SetClearBackground(bool clear)

Sets whether or not the image is cleared (by calling OEImageBase.Clear method) prior to the rendering of the shape query.

See also

• OEShapeQueryDisplayOptions.GetClearBackground

SetColorAtomStyle

void SetColorAtomStyle(unsigned int style)

Sets the style that defines how color atoms are depicted by the OERenderShapeQuery function.

style

This value has to be from the OEColorAtomStyle namespace.

See also

• OEShapeQueryDisplayOptions.GetColorAtomStyle

• OEColorAtomStyle namespace

SetDepictOrientation

void SetDepictOrientation(unsigned int orientation)

Sets the preferred orientation of 2D layout of the shape query.

orientation

This value has to be from the OEDepictOrientation namespace.

Note

Changing the orientation of the layout of the shape query consequently effects the orientation of the shape and color overlaps mapped to the given shape query.

See also

• OEShapeQueryDisplayOptions.GetDepictOrientation method

• OEDepictOrientation namespace

SetSurfaceArcFxn

void SetSurfaceArcFxn(const OESurfaceArcFxnBase &arcfxn)

Sets the surface drawing functor that is drawn to represent the 2D molecule surface of the reference molecule when calling the OERenderShapeQuery function.

See also

• OEShapeQueryDisplayOptions.ClearSurfaceArcFxn

• OEShapeQueryDisplayOptions.GetSurfaceArcFxn