CRouteOverlay.cpp

Go to the documentation of this file.

// INDENTING (emacs/vi): -*- mode:c++; tab-width:2; c-basic-offset:2; intent-tabs-mode:nil; -*- ex: set tabstop=2 expandtab:
 
/*
 * Qt Virtual Chart Table (QVCT)
 * Copyright (C) 2012 Cedric Dufour <http://cedric.dufour.name>
 * Author: Cedric Dufour <http://cedric.dufour.name>
 *
 * The Qt Virtual Chart Table (QVCT) 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, Version 3.
 *
 * The Qt Virtual Chart Table (QVCT) 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.
 */
 
// QT
#include <QByteArray>
#include <QDataStream>
#include <QDomDocument> // QtXml module
#include <QFileInfo>
#include <QList>
#include <QMimeData>
#include <QPainter>
#include <QPointF>
#include <QStringList>
#include <QTreeWidget>
#include <QTreeWidgetItem>
#include <QWidget>
#include <QXmlStreamWriter>
 
// QVCT
#include "QVCTRuntime.hpp"
#include "overlays/route/CRouteContainer.hpp"
#include "overlays/route/CRouteContainerPickView.hpp"
#include "overlays/route/CRouteOverlay.hpp"
#include "overlays/route/CRoutePoint.hpp"
 
 
//------------------------------------------------------------------------------
// CONSTRUCTORS / DESTRUCTOR
//------------------------------------------------------------------------------
 
CRouteOverlay::CRouteOverlay( QWidget* _pqParent )
  : COverlayBaseTree( _pqParent, tr("Routes") )
{
  importSettings();
 
  // Tree widget
  // ... columns
  QTreeWidget::setColumnCount( 3 );
  QTreeWidget::setColumnWidth( NAME, 184 );
  // ... header
  QTreeWidgetItem* __pqTreeWidgetItem = new QTreeWidgetItem();
  __pqTreeWidgetItem->setText( NAME, tr("Name") );
  __pqTreeWidgetItem->setIcon( VISIBLE, QIcon( ":icons/16x16/visible.png" ) );
  __pqTreeWidgetItem->setIcon( SELECT, QIcon( ":icons/16x16/select.png" ) );
  QTreeWidget::setHeaderItem( __pqTreeWidgetItem );
  QTreeWidget::resizeColumnToContents( VISIBLE );
  QTreeWidget::resizeColumnToContents( SELECT );
  // ... top-level item
  QTreeWidgetItem::setFlags( Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemIsUserCheckable );
  QTreeWidgetItem::setText( NAME, COverlay::qsName );
  QTreeWidgetItem::setCheckState( VISIBLE, Qt::Checked );
  // ... drag 'n drop
  QTreeWidget::setDragDropMode( QAbstractItemView::InternalMove );
}
 
CRouteOverlay::~CRouteOverlay()
{
  COverlayBaseTree::destroy();
  clear();
}
 
 
//------------------------------------------------------------------------------
// METHODS: QTreeWidget (implement/override)
//------------------------------------------------------------------------------
 
QStringList CRouteOverlay::mimeTypes() const
{
  static const QStringList __qStringList( "application/qvct.routepoint" );
  return __qStringList;
}
 
QMimeData* CRouteOverlay::mimeData( const QList<QTreeWidgetItem*> _qListTreeWidgetItems ) const
{
  QByteArray __qByteArray;
  QDataStream __qDataStream( &__qByteArray, QIODevice::WriteOnly );
  for( int __i=0; __i < _qListTreeWidgetItems.count(); __i++ )
  {
    QTreeWidgetItem* __pqTreeWidgetItem = _qListTreeWidgetItems.at( __i );
    if( __pqTreeWidgetItem->type() != COverlayObject::ITEM ) continue;
    CRoutePoint* __poRoutePoint = (CRoutePoint*)__pqTreeWidgetItem;
    __poRoutePoint->serialize( __qDataStream );
  }
  QMimeData* __pqMimeData = new QMimeData();
  __pqMimeData->setData( "application/qvct.routepoint", __qByteArray );
  return __pqMimeData;
}
 
bool CRouteOverlay::dropMimeData ( QTreeWidgetItem* _pqTreeWidgetItem, int _iIndex, const QMimeData* _pqMimeData, Qt::DropAction eAction )
{
  if( !_pqTreeWidgetItem ) return false;
  QByteArray __qByteArray = _pqMimeData->data( "application/qvct.routepoint" );
  QDataStream __qDataStream( &__qByteArray, QIODevice::ReadOnly );
  CRoutePoint* __poRoutePoint = 0;
  while( !__qDataStream.atEnd() )
  {
    __poRoutePoint = new CRoutePoint( "#MIMEDATA#" );
    __poRoutePoint->unserialize( __qDataStream );
    _pqTreeWidgetItem->insertChild( _iIndex, __poRoutePoint );
  }
  if( __poRoutePoint ) QTreeWidget::setCurrentItem( __poRoutePoint );
  return true;
}
 
void CRouteOverlay::dropEvent( QDropEvent* _pqDropEvent )
{
  QTreeWidget::dropEvent( _pqDropEvent );
  COverlay::forceRedraw();
  QVCTRuntime::useChartTable()->updateChart();
}
 
//------------------------------------------------------------------------------
// METHODS: COverlay (implement/override)
//------------------------------------------------------------------------------
 
void CRouteOverlay::drawContent( const CChart* _poChart, QPainter* _pqPainter ) const
{
  if( !bVisible ) return;
  int __iCount = QTreeWidgetItem::childCount();
  for( int __i = 0; __i < __iCount; __i++ )
    ((CRouteContainer*)QTreeWidgetItem::child( __i ))->draw( _poChart, _pqPainter );
}
 
void CRouteOverlay::showDetail( const QTreeWidgetItem* _pqTreeWidgetItem ) const
{
  if( !_pqTreeWidgetItem ) return;
  switch( _pqTreeWidgetItem->type() )
  {
 
  case COverlayObject::CONTAINER:
    {
      CRouteContainer* __poRouteContainer = (CRouteContainer*)_pqTreeWidgetItem;
      __poRouteContainer->showDetail();
    }
    break;
 
  case COverlayObject::ITEM:
    {
      CRoutePoint* __poRoutePoint = (CRoutePoint*)_pqTreeWidgetItem;
      CChartTable* __poChartTable = QVCTRuntime::useChartTable();
      if( __poRoutePoint->CDataPosition::operator!=( CDataPosition::UNDEFINED )
          && ( __poChartTable->setPointerTarget( *__poRoutePoint )
               || __poChartTable->extendPointerPath( *__poRoutePoint ) ) )
        __poChartTable->showGeoPosition( *__poRoutePoint );
      else
        __poRoutePoint->showDetail();
    }
    break;
 
  default:;
 
  }
}
 
void CRouteOverlay::setPosition( const QTreeWidgetItem* _pqTreeWidgetItem ) const
{
  switch( _pqTreeWidgetItem->type() )
  {
 
  case COverlayObject::CONTAINER:
    if( _pqTreeWidgetItem->isExpanded() ) return; // NOTE: Expansion switch is handled *AFTER* this method is called
    {
      CDataPosition __oDataPositionLower, __oDataPositionUpper;
      int __iCount = COverlayPoint::getPositionBox( (CRouteContainer*)_pqTreeWidgetItem, &__oDataPositionLower, &__oDataPositionUpper );
      if( __iCount > 1 ) QVCTRuntime::useChartTable()->setScaleArea( __oDataPositionLower, __oDataPositionUpper, 0.9 );
      else if( __iCount == 1 ) QVCTRuntime::useChartTable()->setGeoPosition( __oDataPositionLower );
    }
    break;
 
  case COverlayObject::ITEM:
    {
      CRoutePoint* __poRoutePoint = (CRoutePoint*)_pqTreeWidgetItem;
      if( __poRoutePoint->CDataPosition::operator==( CDataPosition::UNDEFINED ) ) return;
      QVCTRuntime::useChartTable()->setGeoPosition( *__poRoutePoint );
    }
    break;
 
  default:;
 
  }
}
 
COverlayPoint* CRouteOverlay::matchScrPosition( const CChart* _poChart, const QPointF& _rqPointFScrPosition ) const
{
  if( !bVisible ) return 0;
  int __iCount = QTreeWidgetItem::childCount();
  for( int __i = __iCount-1 ; __i >= 0; __i-- ) // we must go in the reverse order of CRouteOverlay::draw() to pick the correct (overlapping) item
  {
    CRouteContainer* __poRouteContainer = (CRouteContainer*)QTreeWidgetItem::child( __i );
    COverlayPoint* __poOverlayPoint = __poRouteContainer->matchScrPosition( _poChart, _rqPointFScrPosition );
    if( __poOverlayPoint ) return __poOverlayPoint;
  }
  return 0;
}
 
 
//------------------------------------------------------------------------------
// METHODS: COverlayBaseTree (implement/override)
//------------------------------------------------------------------------------
 
void CRouteOverlay::onChange( QTreeWidgetItem* _pqTreeWidgetItem, int _iColumn )
{
  bool bRedraw = false;
  switch( _pqTreeWidgetItem->type() )
  {
 
  case COverlayObject::OVERLAY:
    {
      switch( _iColumn )
      {
      case VISIBLE:
        COverlay::setVisible( _pqTreeWidgetItem->checkState( VISIBLE ) == Qt::Checked );
        bRedraw = true;
        break;
      default:;
      }
    }
    break;
 
  case COverlayObject::CONTAINER:
    {
      CRouteContainer* __poRouteContainer = (CRouteContainer*)_pqTreeWidgetItem;
      switch( _iColumn )
      {
      case NAME:
        __poRouteContainer->setName( _pqTreeWidgetItem->text( NAME ) );
        break;
      case VISIBLE:
        __poRouteContainer->setVisible( _pqTreeWidgetItem->checkState( VISIBLE ) == Qt::Checked );
        bRedraw = true;
        break;
      default:;
      }
    }
    break;
 
  case COverlayObject::ITEM:
    {
      CRoutePoint* __poRoutePoint = (CRoutePoint*)_pqTreeWidgetItem;
      switch( _iColumn )
      {
      case NAME:
        __poRoutePoint->setName( _pqTreeWidgetItem->text( NAME ) );
        bRedraw = true;
        break;
      case VISIBLE:
        __poRoutePoint->setVisible( _pqTreeWidgetItem->checkState( VISIBLE ) == Qt::Checked );
        bRedraw = true;
        break;
      case SELECT:
        __poRoutePoint->setMultiSelected( _pqTreeWidgetItem->checkState( SELECT ) == Qt::Checked );
        bRedraw = true;
        break;
      default:;
      }
    }
    break;
 
  default:;
 
  }
 
  // Redraw
  if( bRedraw )
  {
    COverlay::forceRedraw();
    QVCTRuntime::useChartTable()->updateChart();
  }
}
 
 
//------------------------------------------------------------------------------
// METHODS
//------------------------------------------------------------------------------
 
//
// OTHER
//
 
void CRouteOverlay::importSettings()
{
  QColor __qColor = QVCTRuntime::useSettings()->getColorRoute();
  __qColor.setAlpha( 128 );
  qBrushMarker.setColor( __qColor );
  __qColor.setAlpha( 192 );
  qPenText.setColor( QColor::fromHsv( __qColor.hue(), __qColor.saturation(), std::min( 128, __qColor.value() ), 192 ) );
  qPenMarker.setColor( __qColor );
  qPenLine.setColor( __qColor );
  qPenVector.setColor( __qColor );
}
 
CRouteContainer* CRouteOverlay::addContainer( const QString& _rqsName )
{
  CRouteContainer* __poRouteContainer = new CRouteContainer( _rqsName );
  QTreeWidgetItem::addChild( __poRouteContainer );
  QTreeWidgetItem::setExpanded( true );
  return __poRouteContainer;
}
 
CRouteContainer* CRouteOverlay::pickContainer()
{
  int __iCount = QTreeWidgetItem::childCount();
  if( !__iCount ) return addContainer( COverlay::newChildName( "Route", 1, true ) );
  if( __iCount == 1 ) return (CRouteContainer*)QTreeWidgetItem::child( 0 );
  // else: we must have the user choose among the available containers
  COverlayObject* __poOverlayObject = 0;
  CRouteContainerPickView* __poRouteContainerPickView = new CRouteContainerPickView( this, &__poOverlayObject );
  __poRouteContainerPickView->exec();
  delete __poRouteContainerPickView;
  return (CRouteContainer*)__poOverlayObject;
}
 
int CRouteOverlay::deleteSelection()
{
  int __iCount = 0;
  for( int __i = QTreeWidgetItem::childCount()-1; __i >= 0; __i-- )
    __iCount += ((CRouteContainer*)QTreeWidgetItem::child( __i ))->deleteSelection();
  return __iCount;
}
 
void CRouteOverlay::clear()
{
  QTreeWidgetItem* __pqTreeWidgetItem = QTreeWidgetItem::takeChild( 0 );
  while( __pqTreeWidgetItem )
  {
    delete (CRouteContainer*)__pqTreeWidgetItem;
    __pqTreeWidgetItem = QTreeWidgetItem::takeChild( 0 );
  }
}
 
CRouteContainer* CRouteOverlay::load( const QString& _rqsFilename )
{
  QFileInfo __qFileInfo( _rqsFilename );
  CRouteContainer* __poRouteContainer = 0;
  QString __qsError;
  do // error-catching context [begin]
  {
    // File
    QFileInfo __qFileInfo( _rqsFilename );
    QFile __qFile( __qFileInfo.absoluteFilePath() );
    if( !__qFile.open( QIODevice::ReadOnly ) )
    {
      __qsError = QString( "Failed to open file (%1)" ).arg( __qFile.fileName() );
      break;
    }
    QDomDocument __qDocDocument;
    if( !__qDocDocument.setContent( &__qFile ) )
    {
      __qsError = QString( "Failed to parse XML (%1)" ).arg( __qFile.fileName() );
      __qFile.close();
      break;
    }
    __qFile.close();
 
    // XML
    QDomElement __qDomElement = __qDocDocument.documentElement();
    QString __qDocType = __qDomElement.nodeName();
    if( __qDomElement.isNull() || ( __qDocType != "QVCT" && __qDocType != "gpx" ) )
    {
      __qsError = QString( "Invalid XML document type (%1); expected: 'QVCT' or 'gpx'" ).arg( __qFile.fileName() );
      break;
    }
    if( __qDocType == "QVCT" ) parseQVCT( __qDomElement, &__poRouteContainer );
    else if( __qDocType == "gpx" ) parseGPX( __qDomElement, &__poRouteContainer );
  }
  while( false ); // error-catching context [end]
  if( !__qsError.isEmpty() )
  {
    qCritical( "ERROR[%s]: %s", Q_FUNC_INFO, qPrintable( __qsError ) );
    QVCTRuntime::useMainWindow()->fileError( QVCT::OPEN, _rqsFilename );
    return 0;
  }
  QTreeWidgetItem::setExpanded( true );
  return __poRouteContainer;
}
 
int CRouteOverlay::parseQVCT( const QDomElement& _rqDomElement, CRouteContainer** _ppoRouteContainer )
{
  CRouteContainer* __poRouteContainer = 0;
  int __iCount = 0;
  for( QDomElement __qDomElement = _rqDomElement.firstChildElement( "Route" );
       !__qDomElement.isNull();
       __qDomElement = __qDomElement.nextSiblingElement( "Route" ) )
  {
    __iCount++;
    QString __qsName = __qDomElement.attribute( "name" );
    if( !__qsName.isEmpty() ) __qsName = COverlay::newChildName( __qsName );
    else __qsName = COverlay::newChildName( tr("Route"), 1, true );
    __poRouteContainer = new CRouteContainer( __qsName );
    __poRouteContainer->parseQVCT( __qDomElement );
    QTreeWidgetItem::addChild( __poRouteContainer );
  }
  if( _ppoRouteContainer ) *_ppoRouteContainer = __poRouteContainer;
  return __iCount;
}
 
int CRouteOverlay::parseGPX( const QDomElement& _rqDomElement, CRouteContainer** _ppoRouteContainer )
{
  CRouteContainer* __poRouteContainer = 0;
  int __iCount = 0;
  for( QDomElement __qDomElement = _rqDomElement.firstChildElement( "rte" );
       !__qDomElement.isNull();
       __qDomElement = __qDomElement.nextSiblingElement( "rte" ) )
  {
    __iCount++;
    QString __qsName = __qDomElement.firstChildElement( "name" ).text();
    if( !__qsName.isEmpty() ) __qsName = COverlay::newChildName( __qsName );
    else __qsName = COverlay::newChildName( tr("Route"), 1, true );
    __poRouteContainer = new CRouteContainer( __qsName );
    __poRouteContainer->parseGPX( __qDomElement );
    QTreeWidgetItem::addChild( __poRouteContainer );
  }
  if( _ppoRouteContainer ) *_ppoRouteContainer = __poRouteContainer;
  return __iCount;
}
 
void CRouteOverlay::save( const QString& _rqsFilename, CRouteContainer* _poRouteContainer ) const
{
  QFileInfo __qFileInfo( _rqsFilename );
  QString __qsFormat = __qFileInfo.suffix();
  if( __qsFormat != "qvct" && __qsFormat != "gpx" )
  {
    qCritical( "ERROR[%s]: Invalid file format/extention (%s); expected: 'qvct' or 'gpx'", Q_FUNC_INFO, qPrintable( __qsFormat ) );
    return;
  }
 
  // File [open]
  QFile __qFile( __qFileInfo.absoluteFilePath() );
  if( !__qFile.open( QIODevice::WriteOnly ) )
  {
    qCritical( "ERROR[%s]: Failed to open file (%s)", Q_FUNC_INFO, qPrintable( __qFile.fileName() ) );
    return;
  }
 
  // XML [start]
  QXmlStreamWriter __qXmlStreamWriter( &__qFile );
  __qXmlStreamWriter.setAutoFormatting( true );
  __qXmlStreamWriter.writeStartDocument();
 
  // Data
  if( __qsFormat == "qvct" ) dumpQVCT( __qXmlStreamWriter, _poRouteContainer );
  else if( __qsFormat == "gpx" ) dumpGPX( __qXmlStreamWriter, _poRouteContainer );
 
  // XML [end]
  __qXmlStreamWriter.writeEndDocument();
 
  // File [close]
  __qFile.close();
}
 
void CRouteOverlay::dumpQVCT( QXmlStreamWriter & _rqXmlStreamWriter, CRouteContainer* _poRouteContainer, bool _bProjectDump ) const
{
  // Data
  if( !_bProjectDump ) _rqXmlStreamWriter.writeStartElement( "QVCT" );
  // ... containers
  if( _poRouteContainer )
  {
    _poRouteContainer->dumpQVCT( _rqXmlStreamWriter, false );
  }
  else // no container given; assume selection dump or full dump
  {
    int __iCount = QTreeWidgetItem::childCount();
    for( int __i = 0; __i < __iCount; __i++ )
      ((CRouteContainer*)QTreeWidgetItem::child( __i ))->dumpQVCT( _rqXmlStreamWriter, !_bProjectDump );
  }
  // ... [end]
  if( !_bProjectDump ) _rqXmlStreamWriter.writeEndElement(); // QVCT
}
 
void CRouteOverlay::dumpGPX( QXmlStreamWriter & _rqXmlStreamWriter, CRouteContainer* _poRouteContainer ) const
{
  // GPX format reference: see http://www.topografix.com/GPX/1/1/
 
  // Data
  _rqXmlStreamWriter.writeStartElement( "gpx" );
  _rqXmlStreamWriter.writeAttribute( "version", "1.1" );
  _rqXmlStreamWriter.writeAttribute( "creator", "Qt Virtual Chart Table (QVCT)" );
  // ... containers
  if( _poRouteContainer )
  {
    _poRouteContainer->dumpGPX( _rqXmlStreamWriter, false );
  }
  else // no container given; assume selection dump
  {
    int __iCount = QTreeWidgetItem::childCount();
    for( int __i = 0; __i < __iCount; __i++ )
      ((CRouteContainer*)QTreeWidgetItem::child( __i ))->dumpGPX( _rqXmlStreamWriter, true );
  }
  // ... [end]
  _rqXmlStreamWriter.writeEndElement(); // gpx
}