AW_device_click.cxx

Go to the documentation of this file.

// =============================================================== //
//                                                                 //
//   File      : AW_device_click.cxx                               //
//   Purpose   : Detect which graphical element is "nearby"        //
//               a given mouse position                            //
//                                                                 //
//   Institute of Microbiology (Technical University Munich)       //
//   http://www.arb-home.de/                                       //
//                                                                 //
// =============================================================== //

#include "aw_common.hxx"
#include "aw_device_click.hxx"
#include <algorithm>

using namespace AW;

// ------------------------
//      AW_device_click

AW_device_click::AW_device_click(AW_common *common_)
        : AW_simple_device(common_)
{
    init_click(Origin, AWT_NO_CATCH, AW_ALL_DEVICES);
}

void AW_device_click::init_click(const AW::Position& click, int max_distance, AW_bitset filteri) {
    mouse  = click;
    filter = filteri;

    max_distance_line = max_distance;
    max_distance_text = max_distance;

    opt_line    = AW_clicked_line();
    opt_text    = AW_clicked_text();
    opt_box     = AW_clicked_box();
    opt_polygon = AW_clicked_polygon();
}

AW_DEVICE_TYPE AW_device_click::type() {
    return AW_DEVICE_CLICK;
}

bool AW_device_click::line_impl(int /*gc*/, const AW::LineVector& Line, AW_bitset filteri) {
    if (!(filteri & filter)) return false; // needed for motif only?

    LineVector transLine = transform(Line);
    LineVector clippedLine;
    bool       drawflag  = clip(transLine, clippedLine);
    if (drawflag) {
        double   nearest_rel_pos;
        Position nearest  = nearest_linepoint(mouse, clippedLine, nearest_rel_pos);
        double   distance = Distance(mouse, nearest);

        if (distance < max_distance_line) {
            max_distance_line = distance;
            opt_line.assign(Line, distance, nearest_rel_pos, click_cd);
        }
    }
    return drawflag;
}

bool AW_device_click::box_impl(int gc, AW::FillStyle filled, const AW::Rectangle& rect, AW_bitset filteri) {
    if (!(filteri & filter)) return false; // needed for motif only?

    int dist = -1;
    if (filled.is_empty()) {
        LocallyModify<AW_clicked_line> saveLine(opt_line, AW_clicked_line());
        LocallyModify<int>             saveDist(max_distance_line);

        if (!generic_box(gc, rect, filteri)) return false;
        if (!opt_line.does_exist()) return true; // no click near any borderline detected

        dist = opt_line.get_distance();
    }
    else {
        Rectangle transRect = transform(rect);
        if (!transRect.contains(mouse)) {
            return box_impl(gc, FillStyle::EMPTY, rect, filteri); // otherwise use min. dist to box frame
        }
        dist = 0; // if inside rect -> use zero distance
    }

    aw_assert(dist != -1);
    if (!opt_box.does_exist() || dist<opt_box.get_distance()) {
        opt_box.assign(rect, dist, 0.0, click_cd);
    }
    return true;
}

inline double kpt2(const Position& a, const Position& b, const Position& c) {
    if (a.xpos() == b.xpos() && a.ypos() == b.ypos()) return 0;
    if (a.ypos() <= b.ypos() || a.ypos() >  c.ypos()) return 1;

    double d = (b.xpos()-a.xpos()) * (c.ypos()-a.ypos()) - (b.ypos()-a.ypos()) * (c.xpos()-a.xpos());
    return d>0 ? -1 : (d<0 ? 1 : 0);
}
inline double KreuzProdTest(const Position& a, const Position& b, const Position& c) {
    if (a.ypos() == b.ypos() && b.ypos() == c.ypos()) {
        if (is_between(b.xpos(), a.xpos(), c.xpos())) return 0;
        return 1;
    }
    return (b.ypos()>c.ypos()) ? kpt2(a, c, b) : kpt2(a, b, c);
}
static bool polygon_contains(const Position& mouse, int npos, const Position *pos) {
    // Jordan test for "Position inside polygon?" (see https://de.wikipedia.org/wiki/Punkt-in-Polygon-Test_nach_Jordan)
    double t = -1 * KreuzProdTest(mouse, pos[npos-1], pos[0]);
    for (int i = 1; i<npos; ++i) {
        t = t*KreuzProdTest(mouse, pos[i-1], pos[i]);
    }
    return t>=0;
}

bool AW_device_click::polygon_impl(int gc, AW::FillStyle filled, int npos, const AW::Position *pos, AW_bitset filteri) {
    if (!(filteri & filter)) return false; // needed for motif only?

    int dist = -1;
    aw_assert(npos>2);

    if (filled.is_empty()) {
        LocallyModify<AW_clicked_line> saveLine(opt_line, AW_clicked_line());
        LocallyModify<int>             saveDist(max_distance_line);

        if (!generic_polygon(gc, npos, pos, filteri)) return false;
        if (!opt_line.does_exist()) return true; // no click near any borderline detected

        dist = opt_line.get_distance();
    }
    else {
        bool inside;
        {
            AW::Position *tpos = new AW::Position[npos];
            for (int i = 0; i<npos; ++i) {
                tpos[i] = transform(pos[i]);
            }
            inside = polygon_contains(mouse, npos, tpos);
            delete [] tpos;
        }

        if (!inside) {
            return polygon_impl(gc, FillStyle::EMPTY, npos, pos, filteri);
        }
        dist = 0; // if inside polygon -> use zero distance
    }

    aw_assert(dist != -1);
    if (!opt_polygon.does_exist() || dist<opt_polygon.get_distance()) {
        opt_polygon.assign(npos, pos, dist, 0.0, click_cd);
    }
    return true;
}

bool AW_device_click::text_impl(int gc, const SizedCstr& cstr, const AW::Position& pos, AW_pos alignment, AW_bitset filteri) {
    if (!(filteri & filter)) return false;

    AW_pos X0, Y0;          // Transformed pos
    this->transform(pos.xpos(), pos.ypos(), X0, Y0);

    const AW_GC           *gcm  = get_common()->map_gc(gc);
    const AW_font_limits&  font = gcm->get_font_limits();

    AW_pos Y1 = Y0+font.descent;
    Y0        = Y0-font.ascent;

    // Fast check text against top/bottom clip
    const AW_screen_area& clipRect = get_cliprect();
    if (clipRect.t == 0) {
        if (Y1 < clipRect.t) return false;
    }
    else {
        if (Y0 < clipRect.t) return false;
    }

    if (clipRect.b == get_common()->get_screen().b) {
        if (Y0 > clipRect.b) return false;
    }
    else {
        if (Y1 > clipRect.b) return false;
    }

    // vertical check mouse against textsurrounding
    int  dist2text = 0; // exact hit -> distance == 0

    // vertical check against textborders
    if (mouse.ypos() > Y1) { // above text
        int ydist = mouse.ypos()-Y1;
        if (ydist > max_distance_text) return false; // too far above
        dist2text = ydist;
    }
    else if (mouse.ypos() < Y0) { // below text
        int ydist = Y0-mouse.ypos();
        if (ydist > max_distance_text) return false; // too far below
        dist2text = ydist;
    }

    // align text
    int text_width = gcm->get_string_size(cstr);

    X0        = x_alignment(X0, text_width, alignment);
    AW_pos X1 = X0+text_width;

    // check against left/right clipping areas
    if (X1 < clipRect.l) return false;
    if (X0 > clipRect.r) return false;

    // horizontal check against textborders
    if (mouse.xpos() > X1) { // right of text
        int xdist = mouse.xpos()-X1;
        if (xdist > max_distance_text) return false; // too far right
        dist2text = std::max(xdist, dist2text);
    }
    else if (mouse.xpos() < X0) { // left of text
        int xdist = X0-mouse.xpos();
        if (xdist > max_distance_text) return false; // too far left
        dist2text = std::max(xdist, dist2text);
    }

    max_distance_text = dist2text; // exact hit -> distance = 0

    if (!opt_text.does_exist() ||            // first candidate
        (opt_text.get_distance()>dist2text)) // previous candidate had greater distance to click
    {
        Rectangle textArea(LineVector(X0, Y0, X1, Y1));

        LineVector orientation = textArea.bigger_extent();
        LineVector clippedOrientation;

        bool visible = clip(orientation, clippedOrientation);
        if (visible) {
            double   nearest_rel_pos;
            Position nearest = nearest_linepoint(mouse, clippedOrientation, nearest_rel_pos);

            opt_text.assign(rtransform(textArea), max_distance_text, nearest_rel_pos, click_cd);
        }
    }
    return true;
}

const AW_clicked_element *AW_device_click::best_click(ClickPreference prefer) {
    // returns the element with lower distance (to mouse-click- or key-"click"-position).
    // or NULp (if no element was found inside catch-distance)
    //
    // Note: during drag/drop the target element at mouse position
    //       is only updated if requested using AWT_graphic::drag_target_detection
    // see ../AWT/AWT_canvas.cxx@motion_event

    const AW_clicked_element *bestClick = NULp;

    if (prefer == PREFER_LINE && opt_line.does_exist()) bestClick = &opt_line;
    if (prefer == PREFER_TEXT && opt_text.does_exist()) bestClick = &opt_text;

    if (!bestClick) {
        const AW_clicked_element *maybeClicked[] = {
            // earlier elements are preferred over later elements
            &opt_polygon,
            &opt_box,
            &opt_line,
            &opt_text,
        };

        for (size_t i = 0; i<ARRAY_ELEMS(maybeClicked); ++i) {
            if (maybeClicked[i]->does_exist()) {
                if (!bestClick || maybeClicked[i]->get_distance()<bestClick->get_distance()) {
                    bestClick = maybeClicked[i];
                }
            }
        }
    }

    return bestClick;
}

AW::Rectangle AW_clicked_polygon::get_bounding_box() const {
    Rectangle box = bounding_box(pos[0], pos[1]);
    for (int i = 2; i<npos; ++i) {
        box = bounding_box(box, pos[i]);
    }
    return box;
}

int AW_clicked_line::indicate_selected(AW_device *d, int gc) const {
    return d->line(gc, line);
}
int AW_clicked_text::indicate_selected(AW_device *d, int gc) const {
    return d->box(gc, AW::FillStyle::SOLID, textArea);
}
int AW_clicked_box::indicate_selected(AW_device *d, int gc) const {
    return d->box(gc, AW::FillStyle::SOLID, box);
}
int AW_clicked_polygon::indicate_selected(AW_device *d, int gc) const {
    return d->polygon(gc, AW::FillStyle::SOLID, npos, pos);
}