7 #include "WaypointList.hxx"
10 #include <boost/tuple/tuple.hpp>
12 #include <plib/puAux.h>
14 #include <simgear/structure/callback.hxx>
15 #include <simgear/sg_inlines.h>
17 #include <Main/globals.hxx>
18 #include <Main/fg_props.hxx>
20 #include <Navaids/positioned.hxx>
21 #include <Navaids/routePath.hxx>
22 #include <Autopilot/route_mgr.hxx>
24 // select if the widget grabs keys necessary to fly aircraft from the keyboard,
25 // or not. See http://code.google.com/p/flightgear-bugs/issues/detail?id=338
26 // for discussion about why / what is going on.
27 #define AVOID_FLIGHT_KEYS 1
29 using namespace flightgear;
37 static const double BLINK_TIME = 0.3;
38 static const int DRAG_START_DISTANCE_PX = 5;
40 class FlightPlanWaypointModel :
41 public WaypointList::Model,
42 public SGPropertyChangeListener
45 FlightPlanWaypointModel(flightgear::FlightPlan* fp) :
48 SGPropertyNode* routeEdited = fgGetNode("/autopilot/route-manager/signals/edited", true);
49 SGPropertyNode* flightplanChanged = fgGetNode("/autopilot/route-manager/signals/flightplan-changed", true);
50 routeEdited->addChangeListener(this);
51 flightplanChanged->addChangeListener(this);
54 ~FlightPlanWaypointModel()
56 SGPropertyNode* routeEdited = fgGetNode("/autopilot/route-manager/signals/edited", true);
57 SGPropertyNode* flightplanChanged = fgGetNode("/autopilot/route-manager/signals/flightplan-changed", true);
58 routeEdited->removeChangeListener(this);
59 flightplanChanged->removeChangeListener(this);
62 // implement WaypointList::Model
63 virtual unsigned int numWaypoints() const
65 return _fp->numLegs();
68 virtual int currentWaypoint() const
70 return _fp->currentIndex();
73 virtual flightgear::Waypt* waypointAt(unsigned int index) const
75 if (index >= numWaypoints()) {
79 return _fp->legAtIndex(index)->waypoint();
82 virtual flightgear::FlightPlan* flightplan() const
87 virtual void deleteAt(unsigned int index)
89 _fp->deleteIndex(index);
92 virtual void moveWaypointToIndex(unsigned int srcIndex, unsigned int destIndex)
94 SG_LOG(SG_GENERAL, SG_INFO, "moveWaypoint: from " << srcIndex << " to " << destIndex);
95 if (destIndex > srcIndex) {
99 int currentWpIndex = currentWaypoint();
101 WayptRef w = _fp->legAtIndex(srcIndex)->waypoint();
102 _fp->deleteIndex(srcIndex);
103 _fp->insertWayptAtIndex(w, destIndex);
105 if ((signed int) srcIndex == currentWpIndex) {
106 // current waypoint was moved
107 _fp->setCurrentIndex(destIndex);
111 virtual void setUpdateCallback(SGCallback* cb)
116 // implement SGPropertyChangeListener
117 void valueChanged(SGPropertyNode *prop)
119 if (prop->getNameString() == "edited") {
125 if (prop->getNameString() == "flightplan-changed") {
127 static_cast<FGRouteMgr*>(globals->get_subsystem("route-manager"))->flightPlan();
131 flightgear::FlightPlan* _fp;
135 //////////////////////////////////////////////////////////////////////////////
137 static void drawClippedString(puFont& font, const char* s, int x, int y, int maxWidth)
139 int fullWidth = font.getStringWidth(s);
140 if (fullWidth <= maxWidth) { // common case, easy and efficent
141 font.drawString(s, x, y);
146 int len = buf.size();
149 fullWidth = font.getStringWidth(buf.c_str());
150 } while (fullWidth > maxWidth);
152 font.drawString(buf.c_str(), x, y);
155 //////////////////////////////////////////////////////////////////////////////
157 WaypointList::WaypointList(int x, int y, int width, int height) :
158 puFrame(x, y, width, height),
159 GUI_ID(FGCLASS_WAYPOINTLIST),
162 _dragScroll(SCROLL_NO),
165 _updateCallback(NULL),
166 _scrollCallback(NULL),
169 // pretend to be a list, so fgPopup doesn't mess with our mouse events
170 type |= PUCLASS_LIST;
171 flightgear::FlightPlan* fp =
172 static_cast<FGRouteMgr*>(globals->get_subsystem("route-manager"))->flightPlan();
173 setModel(new FlightPlanWaypointModel(fp));
174 setSize(width, height);
180 WaypointList::~WaypointList()
183 delete _updateCallback;
184 delete _scrollCallback;
187 void WaypointList::setUpdateCallback(SGCallback* cb)
189 _updateCallback = cb;
192 void WaypointList::setScrollCallback(SGCallback* cb)
194 _scrollCallback = cb;
197 void WaypointList::setSize(int width, int height)
199 double scrollP = getVScrollPercent();
201 puFrame::setSize(width, height);
203 if (wantsVScroll()) {
204 setVScrollPercent(scrollP);
210 int WaypointList::checkHit ( int button, int updown, int x, int y )
212 if ( isHit( x, y ) || ( puActiveWidget () == this ) )
214 doHit ( button, updown, x, y ) ;
222 void WaypointList::doHit( int button, int updown, int x, int y )
224 puFrame::doHit(button, updown, x, y);
225 if (updown == PU_DRAG) {
230 if (button != active_mouse_button) {
234 if (updown == PU_UP) {
235 puDeactivateWidget();
240 } else if (updown == PU_DOWN) {
241 puSetActiveWidget(this, x, y);
248 int row = rowForY(y - abox.min[1]);
249 if (row >= (int) _model->numWaypoints()) {
250 row = -1; // 'no selection'
253 if (row == getSelected()) {
254 _showLatLon = !_showLatLon;
262 void WaypointList::handleDrag(int x, int y)
265 // don't start drags immediately, require a certain mouse movement first
266 int manhattanLength = abs(x - _mouseDownX) + abs(y - _mouseDownY);
267 if (manhattanLength < DRAG_START_DISTANCE_PX) {
271 _dragSourceRow = rowForY(y - abox.min[1]);
272 Waypt* wp = _model->waypointAt(_dragSourceRow);
273 if (!wp || wp->flag(WPT_GENERATED)) {
274 return; // don't allow generated points to be dragged
278 _dragScroll = SCROLL_NO;
281 if (y < abox.min[1]) {
282 if (_dragScroll != SCROLL_DOWN) {
283 _dragScroll = SCROLL_DOWN;
284 _dragScrollTime.stamp();
286 } else if (y > abox.max[1]) {
287 if (_dragScroll != SCROLL_UP) {
288 _dragScroll = SCROLL_UP;
289 _dragScrollTime.stamp();
292 _dragScroll = SCROLL_NO;
293 _dragTargetRow = rowForY(y - abox.min[1] - (rowHeightPx() / 2));
297 void WaypointList::doDrop(int x, int y)
300 puDeactivateWidget();
302 SG_LOG(SG_GENERAL, SG_INFO, "doDrop");
304 if ((y < abox.min[1]) || (y >= abox.max[1])) {
305 SG_LOG(SG_GENERAL, SG_INFO, "y out of bounds:" << y);
309 if (_dragSourceRow == _dragTargetRow) {
310 SG_LOG(SG_GENERAL, SG_INFO, "source and target row match");
314 _model->moveWaypointToIndex(_dragSourceRow, _dragTargetRow);
316 // keep row indexes linged up when moving an item down the list
317 if (_dragSourceRow < _dragTargetRow) {
321 setSelected(_dragTargetRow);
324 void WaypointList::invokeDownCallback(void)
327 _dragScroll = SCROLL_NO;
328 SG_LOG(SG_GENERAL, SG_INFO, "cancel drag");
331 int WaypointList::rowForY(int y) const
337 // flip y to increase down, not up (as rows do)
338 int flipY = _heightPx - y;
339 int row = (flipY + _scrollPx) / rowHeightPx();
343 void WaypointList::draw( int dx, int dy )
345 puFrame::draw(dx, dy);
351 if (_dragScroll != SCROLL_NO) {
355 double dt = (SGTimeStamp::now() - _blinkTimer).toSecs();
356 if (dt > BLINK_TIME) {
361 glEnable(GL_SCISSOR_TEST);
362 GLint sx = (int) abox.min[0],
364 GLsizei w = (GLsizei) abox.max[0] - abox.min[0],
367 sx += border_thickness;
368 sy += border_thickness;
369 w -= 2 * border_thickness;
370 h -= 2 * border_thickness;
372 glScissor(sx + dx, sy + dy, w, h);
373 int row = firstVisibleRow(),
374 final = lastVisibleRow(),
375 rowHeight = rowHeightPx(),
378 y -= (_scrollPx % rowHeight); // partially draw the first row
380 _arrowWidth = legendFont.getStringWidth(">");
382 RoutePath path(_model->flightplan());
384 for ( ; row <= final; ++row, y += rowHeight) {
385 drawRow(dx, dy, row, y, path);
386 } // of row drawing iteration
388 glDisable(GL_SCISSOR_TEST);
391 // draw the insert marker after the rows
392 int insertY = (_dragTargetRow * rowHeight) - _scrollPx;
393 SG_CLAMP_RANGE(insertY, 0, std::min(_heightPx, totalHeightPx()));
395 glColor4f(1.0f, 0.5f, 0.0f, 0.8f);
398 glVertex2f(dx + abox.min[0], dy + abox.max[1] - insertY);
399 glVertex2f(dx + abox.max[0], dy + abox.max[1] - insertY);
404 void WaypointList::drawRow(int dx, int dy, int rowIndex, int y,
405 const RoutePath& path)
407 flightgear::Waypt* wp(_model->waypointAt(rowIndex));
409 bool isSelected = (rowIndex == getSelected());
410 bool isCurrent = (rowIndex == _model->currentWaypoint());
411 bool isDragSource = (_dragging && (rowIndex == _dragSourceRow));
414 bkgBox.min[1] = abox.max[1] - y;
415 bkgBox.max[1] = bkgBox.min[1] + rowHeightPx();
418 puFont* f = &legendFont;
419 bool drawBox = false;
421 if (wp->flag(WPT_MISS)) {
423 puSetColor(col, 1.0, 0.0, 0.0, 0.3); // red
424 } else if (wp->flag(WPT_ARRIVAL) || wp->flag(WPT_DEPARTURE)) {
426 puSetColor(col, 0.0, 0.0, 0.0, 0.3);
427 } else if (wp->flag(WPT_APPROACH)) {
429 puSetColor(col, 0.0, 0.0, 0.1, 0.3);
433 // draw later, on *top* of text string
434 } else if (isSelected) { // -PLAIN means selected, apparently
435 bkgBox.draw(dx, dy, -PUSTYLE_PLAIN, colour, false, 0);
436 } else if (drawBox) {
437 bkgBox.draw(dx, dy, PUSTYLE_PLAIN, &col, false, 0);
441 glColor4f (1.0, 0.5, 0.0, 1.0) ;
443 glColor4fv ( colour [ PUCOL_LEGEND ] ) ;
446 int xx = dx + abox.min[0] + PUSTR_LGAP;
447 int yy = dy + abox.max[1] - y ;
448 yy += 4; // center text in row height
451 f->drawString(">", xx, yy);
455 x += _arrowWidth + PUSTR_LGAP;
460 int count = ::snprintf(buffer, 128, "%03d %-5s", rowIndex, wp->ident().c_str());
462 FGPositioned* src = wp->source();
463 if (src && !src->name().empty() && (src->name() != wp->ident())) {
464 // append name if present, and different to id
465 ::snprintf(buffer + count, 128 - count, " (%s)", src->name().c_str());
468 drawClippedString(legendFont, buffer, x, yy, 300);
469 x += 300 + PUSTR_LGAP;
472 // only show for non-dynamic waypoints
473 if (!wp->flag(WPT_DYNAMIC)) {
474 SGGeod p(wp->position());
475 char ns = (p.getLatitudeDeg() > 0.0) ? 'N' : 'S';
476 char ew = (p.getLongitudeDeg() > 0.0) ? 'E' : 'W';
478 ::snprintf(buffer, 128 - count, "%4.2f%c %4.2f%c",
479 fabs(p.getLongitudeDeg()), ew, fabs(p.getLatitudeDeg()), ns);
483 } else if (rowIndex > 0) {
484 double courseDeg = path.trackForIndex(rowIndex);
485 double distanceM = path.distanceForIndex(rowIndex);
486 ::snprintf(buffer, 128 - count, "%03.0f %5.1fnm",
487 courseDeg, distanceM * SG_METER_TO_NM);
490 f->drawString(buffer, x, yy);
491 x += 100 + PUSTR_LGAP;
493 if (wp->altitudeRestriction() != RESTRICT_NONE) {
494 char aboveAtBelow = ' ';
495 if (wp->altitudeRestriction() == RESTRICT_ABOVE) {
497 } else if (wp->altitudeRestriction() == RESTRICT_BELOW) {
501 int altHundredFt = (wp->altitudeFt() + 50) / 100; // round to nearest 100ft
502 if (altHundredFt < 100) {
503 count = ::snprintf(buffer, 128, "%d'%c", altHundredFt * 100, aboveAtBelow);
504 } else { // display as a flight-level
505 count = ::snprintf(buffer, 128, "FL%d%c", altHundredFt, aboveAtBelow);
508 f->drawString(buffer, x, yy);
509 } // of valid wp altitude
510 x += 60 + PUSTR_LGAP;
512 if (wp->speedRestriction() == SPEED_RESTRICT_MACH) {
513 count = ::snprintf(buffer, 126, "%03.2fM", wp->speedMach());
514 f->drawString(buffer, x, yy);
515 } else if (wp->speedRestriction() != RESTRICT_NONE) {
516 count = ::snprintf(buffer, 126, "%dKts", (int) wp->speedKts());
517 f->drawString(buffer, x, yy);
521 puSetColor(col, 1.0, 0.5, 0.0, 0.5);
522 bkgBox.draw(dx, dy, PUSTYLE_PLAIN, &col, false, 0);
526 const double SCROLL_PX_SEC = 200.0;
528 void WaypointList::doDragScroll()
530 double dt = (SGTimeStamp::now() - _dragScrollTime).toSecs();
531 _dragScrollTime.stamp();
532 int deltaPx = (int)(dt * SCROLL_PX_SEC);
534 if (_dragScroll == SCROLL_UP) {
535 _scrollPx = _scrollPx - deltaPx;
536 SG_CLAMP_RANGE(_scrollPx, 0, scrollRangePx());
537 _dragTargetRow = firstVisibleRow();
539 _scrollPx = _scrollPx + deltaPx;
540 SG_CLAMP_RANGE(_scrollPx, 0, scrollRangePx());
541 _dragTargetRow = lastFullyVisibleRow() + 1;
544 if (_scrollCallback) {
545 (*_scrollCallback)();
549 int WaypointList::getSelected()
551 return getIntegerValue();
554 void WaypointList::setSelected(int rowIndex)
556 if (rowIndex == getSelected()) {
562 if (rowIndex == -1) {
566 ensureRowVisible(rowIndex);
569 void WaypointList::ensureRowVisible(int rowIndex)
571 if ((rowIndex >= firstFullyVisibleRow()) && (rowIndex <= lastFullyVisibleRow())) {
572 return; // already visible, fine
575 // ideal position would place the desired row in the middle of the
576 // visible section - hence subtract half the visible height.
577 int targetScrollPx = (rowIndex * rowHeightPx()) - (_heightPx / 2);
579 // clamp the scroll value to something valid
580 SG_CLAMP_RANGE(targetScrollPx, 0, scrollRangePx());
581 _scrollPx = targetScrollPx;
584 if (_scrollCallback) { // keep scroll observers in sync
585 (*_scrollCallback)();
589 unsigned int WaypointList::numWaypoints() const
595 return _model->numWaypoints();
598 bool WaypointList::wantsVScroll() const
600 return totalHeightPx() > _heightPx;
603 float WaypointList::getVScrollPercent() const
605 float scrollRange = scrollRangePx();
606 if (scrollRange < 1.0f) {
610 return _scrollPx / scrollRange;
613 float WaypointList::getVScrollThumbPercent() const
615 return _heightPx / (float) totalHeightPx();
618 void WaypointList::setVScrollPercent(float perc)
620 float scrollRange = scrollRangePx();
621 _scrollPx = (int)(scrollRange * perc);
624 int WaypointList::firstVisibleRow() const
626 return _scrollPx / rowHeightPx();
629 int WaypointList::firstFullyVisibleRow() const
631 int rh = rowHeightPx();
632 return (_scrollPx + rh - 1) / rh;
635 int WaypointList::numVisibleRows() const
637 int rh = rowHeightPx();
638 int topOffset = _scrollPx % rh; // pixels of first visible row
639 return (_heightPx - topOffset + rh - 1) / rh;
643 int WaypointList::numFullyVisibleRows() const
645 int rh = rowHeightPx();
646 int topOffset = _scrollPx % rh; // pixels of first visible row
647 return (_heightPx - topOffset) / rh;
650 int WaypointList::rowHeightPx() const
652 return legendFont.getStringHeight() + PUSTR_BGAP;
655 int WaypointList::scrollRangePx() const
657 return std::max(0, totalHeightPx() - _heightPx);
660 int WaypointList::totalHeightPx() const
666 return (int) _model->numWaypoints() * rowHeightPx();
669 int WaypointList::lastFullyVisibleRow() const
671 int row = firstFullyVisibleRow() + numFullyVisibleRows();
672 return std::min(row, (int) _model->numWaypoints() - 1);
675 int WaypointList::lastVisibleRow() const
677 int row = firstVisibleRow() + numVisibleRows();
678 return std::min(row, (int) _model->numWaypoints() - 1);
681 void WaypointList::setModel(Model* model)
688 _model->setUpdateCallback(make_callback(this, &WaypointList::modelUpdateCallback));
693 int WaypointList::checkKey (int key, int updown )
695 if ((updown == PU_UP) || !isVisible () || !isActive () || (window != puGetWindow())) {
699 #ifdef AVOID_FLIGHT_KEYS
710 setSelected(_model->numWaypoints() - 1);
714 case PU_KEY_PAGE_UP :
715 if (getSelected() >= 0) {
716 setSelected(getSelected() - 1);
721 case PU_KEY_PAGE_DOWN : {
722 int newSel = getSelected() + 1;
723 if (newSel >= (int) _model->numWaypoints()) {
732 if (getSelected() >= 0) {
733 Waypt* wp = _model->waypointAt(getSelected());
734 if (wp->flag(WPT_GENERATED)) {
738 if (wp->altitudeRestriction() != RESTRICT_NONE) {
739 int curAlt = (static_cast<int>(wp->altitudeFt()) + 50) / 100;
741 wp->setAltitude(0, RESTRICT_NONE);
743 wp->setAltitude((curAlt - 10) * 100, wp->altitudeRestriction());
750 if (getSelected() >= 0) {
751 flightgear::Waypt* wp = _model->waypointAt(getSelected());
752 if (wp->flag(WPT_GENERATED)) {
756 if (wp->altitudeRestriction() == RESTRICT_NONE) {
757 wp->setAltitude(1000, RESTRICT_AT);
759 int curAlt = (static_cast<int>(wp->altitudeFt()) + 50) / 100;
760 wp->setAltitude((curAlt + 10) * 100, wp->altitudeRestriction());
766 if (getSelected() >= 0) {
767 int index = getSelected();
768 Waypt* wp = _model->waypointAt(getSelected());
769 if (wp->flag(WPT_GENERATED)) {
773 _model->deleteAt(index);
774 setSelected(index - 1);
785 void WaypointList::modelUpdateCallback()
789 if (_updateCallback) {
790 (*_updateCallback)();
794 //////////////////////////////////////////////////////////////////////////////
797 static void handle_scrollbar(puObject* scrollbar)
799 ScrolledWaypointList* self = (ScrolledWaypointList*)scrollbar->getUserData();
800 self->setScrollPercent(scrollbar->getFloatValue());
803 static void waypointListCb(puObject* wpl)
805 ScrolledWaypointList* self = (ScrolledWaypointList*)wpl->getUserData();
806 self->setValue(wpl->getIntegerValue());
807 self->invokeCallback();
810 ScrolledWaypointList::ScrolledWaypointList(int x, int y, int width, int height) :
814 // ensure our type is compound, so fgPopup::applySize doesn't descend into
815 // us, and try to cast our children's user-data to GUIInfo*.
816 type |= PUCLASS_LIST;
821 void ScrolledWaypointList::setValue(float v)
823 puGroup::setValue(v);
827 void ScrolledWaypointList::setValue(int v)
829 puGroup::setValue(v);
833 void ScrolledWaypointList::init(int w, int h)
835 _list = new WaypointList(0, 0, w, h);
836 _list->setUpdateCallback(make_callback(this, &ScrolledWaypointList::modelUpdated));
837 _hasVScroll = _list->wantsVScroll();
838 _list->setUserData(this);
839 _list->setCallback(waypointListCb);
841 _list->setScrollCallback(make_callback(this, &ScrolledWaypointList::updateScroll));
843 _scrollbar = new puaScrollBar(w - _scrollWidth, 0, h,
844 1 /*arrow*/, 1 /* vertical */, _scrollWidth);
845 _scrollbar->setMinValue(0.0);
846 _scrollbar->setMaxValue(1.0);
847 _scrollbar->setUserData(this);
848 _scrollbar->setCallback(handle_scrollbar);
849 close(); // close the group
854 void ScrolledWaypointList::modelUpdated()
858 updateWantsScroll(w, h);
861 void ScrolledWaypointList::setScrollPercent(float v)
863 // slider's min is the bottom, so invert the value
864 _list->setVScrollPercent(1.0f - v);
867 void ScrolledWaypointList::setSize(int w, int h)
869 updateWantsScroll(w, h);
870 puGroup::setSize(w, h);
873 void ScrolledWaypointList::updateWantsScroll(int w, int h)
875 _hasVScroll = _list->wantsVScroll();
878 _scrollbar->reveal();
879 _scrollbar->setPosition(w - _scrollWidth, 0);
880 _scrollbar->setSize(_scrollWidth, h);
881 _list->setSize(w - _scrollWidth, h);
885 _list->setSize(w, h);
889 void ScrolledWaypointList::updateScroll()
891 // _scrollbar->setMaxValue(_list->numWaypoints());
892 _scrollbar->setValue(1.0f - _list->getVScrollPercent());
893 _scrollbar->setSliderFraction(_list->getVScrollThumbPercent());