select.h

/***************************************************************************
 *
 * Project:  OpenCPN
 *
 ***************************************************************************
 *   Copyright (C) 2013 by David S. Register                               *
 *                                                                         *
 *   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 2 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 _SELECT_H__
#define _SELECT_H__
 
#include "select_item.h"
 
#include "model/track.h"
#include "model/route.h"
 
#define SELTYPE_UNKNOWN 0x0001
#define SELTYPE_ROUTEPOINT 0x0002
#define SELTYPE_ROUTESEGMENT 0x0004
#define SELTYPE_TIDEPOINT 0x0008
#define SELTYPE_CURRENTPOINT 0x0010
#define SELTYPE_ROUTECREATE 0x0020
#define SELTYPE_AISTARGET 0x0040
#define SELTYPE_MARKPOINT 0x0080
#define SELTYPE_TRACKSEGMENT 0x0100
#define SELTYPE_DRAGHANDLE 0x0200
 
class Select;  // forward
 
extern Select *pSelect;
 
struct SelectCtx {
  const bool show_nav_objects;
  const double scale;
  const double chart_scale;
  SelectCtx(bool s, double _scale, double _chart_scale)
      : show_nav_objects(s), scale(_scale), chart_scale(_chart_scale) {}
};
 
class Select {
public:
  Select();
  ~Select();
 
  void SetSelectPixelRadius(int radius) { pixelRadius = radius; }
 
  bool IsSelectableRoutePointValid(RoutePoint *pRoutePoint);
  bool AddSelectableRoutePoint(float slat, float slon,
                               RoutePoint *pRoutePointAdd);
  bool AddSelectableRouteSegment(float slat1, float slon1, float slat2,
                                 float slon2, RoutePoint *pRoutePointAdd1,
                                 RoutePoint *pRoutePointAdd2, Route *pRoute);
 
  bool AddSelectableTrackSegment(float slat1, float slon1, float slat2,
                                 float slon2, TrackPoint *pTrackPointAdd1,
                                 TrackPoint *pTrackPointAdd2, Track *pTrack);
 
  SelectItem *FindSelection(SelectCtx &ctx, float slat, float slon,
                            int fseltype);
  SelectableItemList FindSelectionList(SelectCtx &ctx, float slat, float slon,
                                       int fseltype);
 
  bool DeleteAllSelectableRouteSegments(Route *);
  bool DeleteAllSelectableTrackSegments(Track *);
  bool DeleteAllSelectableRoutePoints(Route *);
  bool AddAllSelectableRouteSegments(Route *pr);
  bool AddAllSelectableTrackSegments(Track *pr);
  bool AddAllSelectableRoutePoints(Route *pr);
  bool UpdateSelectableRouteSegments(RoutePoint *prp);
  bool DeletePointSelectableTrackSegments(TrackPoint *pt);
  bool IsSegmentSelected(float a, float b, float c, float d, float slat,
                         float slon);
  bool IsSelectableSegmentSelected(SelectCtx &ctx, float slat, float slon,
                                   SelectItem *pFindSel);
 
  //    Generic Point Support
  //      e.g. Tides/Currents and AIS Targets
  SelectItem *AddSelectablePoint(float slat, float slon, const void *data,
                                 int fseltype);
  bool DeleteAllPoints(void);
  bool DeleteSelectablePoint(void *data, int SeltypeToDelete);
  bool ModifySelectablePoint(float slat, float slon, void *data, int fseltype);
 
  //    Delete all selectable points in list by type
  bool DeleteAllSelectableTypePoints(int SeltypeToDelete);
 
  bool DeleteSelectableRoutePoint(RoutePoint *prp);
 
  //  Accessors
 
  SelectableItemList *GetSelectList() { return pSelectList; }
 
private:
  // FIXME (leamas?) this is not model stuff.
  void CalcSelectRadius(SelectCtx &ctx);
 
  SelectableItemList *pSelectList;
  int pixelRadius;
  float selectRadius;
};
 
#endif  // _SELECT_H__