OEGetNearbyAtom

OENearestAtom OEGetNearbyAtom(const OE2DMolDisplay &disp, const OE2DPoint &point,
                              double radiusscale=1.0)

Returns an OENearestAtom object that stores a pointer of the atom which is depicted nearest to a given 2D display coordinates. By default, only atoms that are no further than half bond away from the given point will be considered.

disp

The OE2DMolDisplay object of which atoms are being considered. Only atoms of which atom display is visible are examined (OEAtomDisplayBase::IsVisible)

point

Specifies the 2D display coordinates.

radiusscale

The multiplier that can be used to increase or to decrease the radius around the given point to be considered. This value has to be in a range of \([0.25, 2.0]\).

Note

If there is no atom close to the given display coordinates, then the OENearestAtom::IsValid method returns false.

See also