/* layla/ligand_editor_canvas/tools.hpp * * Copyright 2023 by Global Phasing Ltd. * Author: Jakub Smulski * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or (at * your option) any later version. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA * 02110-1301, USA */ #ifndef COOT_LIGAND_EDITOR_CANVAS_TOOLS_HPP #define COOT_LIGAND_EDITOR_CANVAS_TOOLS_HPP #include "model.hpp" #include namespace coot::ligand_editor_canvas { namespace impl { /// This is a forward declaration of a structure defined at /// "core.hpp" struct WidgetCoreData; /// This is a forward declaration of a structure defined at /// "core.hpp" struct CootLigandEditorCanvasPriv; } class TransformManager { public: enum class Mode { Rotation, Translation }; private: struct RotationState { double last_absolute_angle; std::pair original_rotation_pos; std::pair current_rotation_pos; double get_current_absolute_angle(bool snap_to_angle) const; double get_current_angle_diff(bool snap_to_angle) const; }; struct TranslationState { std::pair prev_move_pos; std::pair current_move_pos; std::pair get_current_offset() const; }; class IdleState { // empty }; std::variant state; std::optional canvas_mol_idx; public: TransformManager() noexcept; bool is_active() const noexcept; void begin_transform(int x, int y, Mode mode) noexcept; void update_current_cursor_pos(int x, int y, bool snap) noexcept; void end_transform() noexcept; void set_canvas_molecule_index(unsigned int) noexcept; void apply_current_transform_state(impl::WidgetCoreData* widget_data, bool snapt_to_angle, bool about_to_end) const; }; class Tool { public: struct ClickContext { impl::WidgetCoreData& widget_data; bool control_pressed; bool alt_pressed; ClickContext(impl::WidgetCoreData& widget_data); }; struct MoleculeClickContext : public ClickContext { unsigned int mol_idx; std::shared_ptr& rdkit_mol; CanvasMolecule& canvas_mol; MoleculeClickContext(ClickContext super, unsigned int mol_idx, std::shared_ptr& rdkit_mol, CanvasMolecule& canvas_mol); }; /// Called when the tools is set in the ActiveTool virtual void on_load(impl::WidgetCoreData& widget_data); /// Called always, whenever there's been a click event. /// Called before other click methods get called. virtual void on_click(ClickContext& ctx, int x, int y); /// Called when the click coordinates do not correspond to anything on canvas virtual void on_blank_space_click(ClickContext& ctx, int x, int y); /// Called if the click lands on a molecule. /// Returns true if `on_bond_click()` or `on_atom_click()` (respectively to what's been clicked) /// should be called next (and then lastly `after_molecule_click()`) virtual bool on_molecule_click(MoleculeClickContext& ctx); virtual void on_bond_click(MoleculeClickContext& ctx, CanvasMolecule::Bond&); virtual void on_atom_click(MoleculeClickContext& ctx, CanvasMolecule::Atom&); /// Generic on-mouse-release event handler. /// No dedicated molecule/atom/bond handlers seem to be needed now. virtual void on_release(ClickContext& ctx, int x, int y); virtual void after_molecule_click(MoleculeClickContext& ctx); /// Called always, whenever there's been a right-click event. /// Called before other click methods get called. virtual void on_right_click(ClickContext& ctx, int x, int y); /// Called when the right-click coordinates do not correspond to anything on canvas virtual void on_blank_space_right_click(ClickContext& ctx, int x, int y); /// Called if the right-click lands on a molecule. /// Returns true if `on_bond_right_click()` or `on_atom_right_click()` (respectively to what's been clicked) /// should be called next (and then lastly `after_molecule_right_click()`) virtual bool on_molecule_right_click(MoleculeClickContext& ctx); virtual void on_bond_right_click(MoleculeClickContext& ctx, CanvasMolecule::Bond&); virtual void on_atom_right_click(MoleculeClickContext& ctx, CanvasMolecule::Atom&); virtual void after_molecule_right_click(MoleculeClickContext& ctx); /// Called always, whenever there's been a hover event. /// Called before other click methods get called. /// Returns if the hover event should be processed at all virtual bool on_hover(ClickContext& ctx, int x, int y); /// Called when the click coordinates do not correspond to anything on canvas virtual void on_blank_space_hover(ClickContext& ctx, int x, int y); /// Called if the hover lands on a molecule. /// Returns true if `on_bond_hover()` or `on_atom_hover()` (respectively to what's been hovered on) /// should be called next (and then lastly `after_molecule_hover()`) virtual bool on_molecule_hover(MoleculeClickContext& ctx); virtual void on_bond_hover(MoleculeClickContext& ctx, CanvasMolecule::Bond&); virtual void on_atom_hover(MoleculeClickContext& ctx, CanvasMolecule::Atom&); virtual void after_molecule_hover(MoleculeClickContext& ctx); /// Used to print tool-specific error messages should any handler throw an exception virtual std::string get_exception_message_prefix() const noexcept; /// Wraps `RDKit::MolOps::sanitizeMol()`. /// Used for checking validity and reversing kekulization. /// Does nothing when nonsensical molecules are allowed. static void sanitize_molecule(impl::WidgetCoreData&, RDKit::RWMol&); virtual ~Tool(); }; class BondModifier : public Tool { public: enum class BondModifierMode { Single, Double, Triple }; private: BondModifierMode mode; std::optional> molecule_idx_and_first_atom_of_new_bond; bool is_in_drag; public: BondModifier(BondModifierMode) noexcept; CanvasMolecule::BondType get_target_bond_type() const noexcept; bool is_creating_bond() const noexcept; void begin_creating_bond(unsigned int molecule_idx, unsigned int atom_idx) noexcept; void finish_creating_bond() noexcept; std::optional> get_molecule_idx_and_first_atom_of_new_bond() const noexcept; virtual bool on_molecule_click(MoleculeClickContext& ctx) override; virtual void on_bond_click(MoleculeClickContext& ctx, CanvasMolecule::Bond& bond) override; virtual void on_atom_click(MoleculeClickContext& ctx, CanvasMolecule::Atom& atom) override; virtual std::string get_exception_message_prefix() const noexcept override; virtual void on_release(ClickContext& ctx, int x, int y) override; }; class ElementInsertion : public Tool { public: enum class Element { C, N, O, S, P, H, F, Cl, Br, I }; private: std::variant element; public: ElementInsertion(const char* symbol); ElementInsertion(Element el) noexcept; unsigned int get_atomic_number() const noexcept; virtual bool on_molecule_click(MoleculeClickContext& ctx) override; virtual void on_bond_click(MoleculeClickContext& ctx, CanvasMolecule::Bond& bond) override; virtual void on_atom_click(MoleculeClickContext& ctx, CanvasMolecule::Atom& atom) override; virtual void after_molecule_click(MoleculeClickContext& ctx) override; virtual std::string get_exception_message_prefix() const noexcept override; }; class StructureInsertion : public Tool { public: enum class Structure: unsigned int { CycloPropaneRing, CycloButaneRing, CycloPentaneRing, CycloHexaneRing, BenzeneRing, CycloHeptaneRing, CycloOctaneRing }; private: Structure structure; static unsigned int append_carbon(RDKit::RWMol*, unsigned int target_idx, RDKit::Bond::BondType bond_type = RDKit::Bond::SINGLE); static unsigned int append_carbon_chain(RDKit::RWMol*, unsigned int chain_start_idx, std::size_t atom_count); void append_structure_to_atom(RDKit::RWMol*, unsigned int atom_idx, bool spiro) const; public: StructureInsertion(Structure) noexcept; Structure get_structure() const noexcept; virtual bool on_molecule_click(MoleculeClickContext& ctx) override; virtual void on_bond_click(MoleculeClickContext& ctx, CanvasMolecule::Bond& bond) override; virtual void on_atom_click(MoleculeClickContext& ctx, CanvasMolecule::Atom& atom) override; virtual void after_molecule_click(MoleculeClickContext& ctx) override; virtual void on_blank_space_click(ClickContext& ctx, int x, int y) override; virtual std::string get_exception_message_prefix() const noexcept override; }; class ChargeModifier : public Tool { public: virtual void on_atom_click(MoleculeClickContext& ctx, CanvasMolecule::Atom& atom) override; virtual void on_atom_right_click(MoleculeClickContext& ctx, CanvasMolecule::Atom& atom) override; virtual std::string get_exception_message_prefix() const noexcept override; }; class DeleteTool : public Tool { public: // Represents either atom idx or a pair of atom indices forming a bond typedef std::variant> AtomOrBond; typedef std::vector ListOfAtomsOrBonds; private: static bool chain_contains_majority_of_atoms(const ListOfAtomsOrBonds& chain, const RDKit::ROMol* mol); static ListOfAtomsOrBonds trace_chain_impl(const RDKit::ROMol* mol, std::set& processed_atoms, RDKit::Atom const* rdatom); /// Returns a vector of atoms IDs to be removed (if relevant) static ListOfAtomsOrBonds trace_rchain(const MoleculeClickContext& ctx, const CanvasMolecule::Bond& bond); /// Returns a vector of atoms IDs to be removed (if relevant) static ListOfAtomsOrBonds trace_rchain(const MoleculeClickContext& ctx, const CanvasMolecule::Atom& atom); void remove_rchain(const MoleculeClickContext& ctx, const ListOfAtomsOrBonds& chain); void highlight_rchain(const MoleculeClickContext& ctx, const ListOfAtomsOrBonds& chain); public: virtual bool on_molecule_click(MoleculeClickContext& ctx) override; virtual void on_bond_click(MoleculeClickContext& ctx, CanvasMolecule::Bond& bond) override; virtual void on_atom_click(MoleculeClickContext& ctx, CanvasMolecule::Atom& atom) override; virtual void after_molecule_click(MoleculeClickContext& ctx) override; virtual bool on_hover(ClickContext& ctx, int x, int y) override; virtual bool on_molecule_hover(MoleculeClickContext& ctx) override; virtual void on_bond_hover(MoleculeClickContext& ctx, CanvasMolecule::Bond& bond) override; virtual void on_atom_hover(MoleculeClickContext& ctx, CanvasMolecule::Atom& atom) override; virtual std::string get_exception_message_prefix() const noexcept override; }; /// Responsible for beginning transforms in the ActiveTool's TransformManager class TransformTool : public Tool { TransformManager::Mode mode; // Non-owning pointer TransformManager* transform_manager; public: TransformTool(TransformManager::Mode) noexcept; void set_transform_manager(TransformManager*) noexcept; virtual void on_click(ClickContext& ctx, int x, int y) override; virtual bool on_molecule_click(MoleculeClickContext& ctx) override; }; class GeometryModifier : public Tool { public: virtual void on_bond_click(MoleculeClickContext& ctx, CanvasMolecule::Bond& bond) override; virtual std::string get_exception_message_prefix() const noexcept override; }; class FormatTool : public Tool { public: virtual void on_load(impl::WidgetCoreData& widget_data) override; virtual bool on_molecule_click(MoleculeClickContext& ctx) override; virtual std::string get_exception_message_prefix() const noexcept override; }; class FlipTool : public Tool { FlipMode mode; public: FlipTool(FlipMode) noexcept; virtual void on_load(impl::WidgetCoreData& widget_data) override; virtual bool on_molecule_click(MoleculeClickContext& ctx) override; virtual std::string get_exception_message_prefix() const noexcept override; }; class RemoveHydrogensTool : public Tool { public: virtual void on_load(impl::WidgetCoreData& widget_data) override; virtual bool on_molecule_click(MoleculeClickContext& ctx) override; virtual std::string get_exception_message_prefix() const noexcept override; }; class ActiveTool { /// Non-owning pointer impl::WidgetCoreData* widget_data; std::unique_ptr tool; TransformManager transform_manager; public: ActiveTool() noexcept; ActiveTool(ElementInsertion insertion) noexcept; ActiveTool(BondModifier modifier) noexcept; ActiveTool(DeleteTool) noexcept; ActiveTool(ChargeModifier) noexcept; ActiveTool(TransformTool) noexcept; ActiveTool(StructureInsertion insertion) noexcept; ActiveTool(GeometryModifier modifier) noexcept; ActiveTool(FormatTool) noexcept; ActiveTool(FlipTool) noexcept; ActiveTool(RemoveHydrogensTool) noexcept; /// Calles initialization code on the currently chosen tool (if there's any) void on_load(); /// Handles mouse click event for the currently chosen tool void on_click(bool alt_pressed, bool ctrl_pressed, int x, int y, bool right_click); /// Handles mouse-release event for the currently chosen tool void on_release(bool alt_pressed, bool ctrl_pressed, int x, int y, bool right_click); /// Handles mouse hover event for the currently chosen tool void on_hover(bool alt_pressed, bool ctrl_pressed, int x, int y); /// Returns true if a new bond is currently being create via click'n'drag bool is_creating_bond() const noexcept; /// Returns a pair of indices - index of the molecule followed by the index of the first atom /// of the newly created bond (if any) std::optional> get_molecule_idx_and_first_atom_of_new_bond() const noexcept; /// Updates the current mouse coordinates /// allowing to compute adequate viewport rotation / translation void update_transform_cursor_pos(int x, int y, bool snap_to_angle) noexcept; /// Ends move or rotation void end_transform(bool snap_to_angle); /// Begins rotation or translation void begin_transform(int x, int y, TransformManager::Mode); /// Returns if the user is currently dragging their mouse /// to shift the viewport / rotate the molecule. bool is_in_transform() const noexcept; /// Only meant to be invoked from within CootLigandEditorCanvas implementation /// /// Sets the pointer to access widget's data. void set_core_widget_data(impl::CootLigandEditorCanvasPriv* owning_widget) noexcept; }; } #endif // COOT_LIGAND_EDITOR_CANVAS_TOOLS_HPP