TreeItem.cc 10.9 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40
\*===========================================================================*/
Dirk Wilden's avatar
Dirk Wilden committed
41

42
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
43 44 45 46 47
*                                                                            *
*   $Revision: 10272 $                                                       *
*   $LastChangedBy: moebius $                                                *
*   $Date: 2010-11-24 17:45:10 +0100 (Mi, 24 Nov 2010) $                     *
*                                                                            *
48
\*===========================================================================*/
Dirk Wilden's avatar
Dirk Wilden committed
49 50 51

#include "TreeItem.hh"

Jan Möbius's avatar
Jan Möbius committed
52
QMap<int,TreeItem*> TreeItem::kTreeMap_;
53

Dirk Wilden's avatar
Dirk Wilden committed
54 55 56 57 58
//--------------------------------------------------------------------------------

TreeItem::TreeItem(int _id, QString _name, DataType _type, TreeItem* _parent) :
  id_(_id),
  dataType_(_type),
59 60 61
  target_(true),
  source_(false),
  visible_(true),
Dirk Wilden's avatar
Dirk Wilden committed
62
  name_(_name),
Jan Möbius's avatar
Jan Möbius committed
63 64
  parentItem_(_parent),
  row_(0)
Dirk Wilden's avatar
Dirk Wilden committed
65
{
66
  // Remember ourself ;-)
Jan Möbius's avatar
Jan Möbius committed
67
  kTreeMap_[_id] = this;
68 69 70 71 72
}


TreeItem::~TreeItem() {
  // Remove itself from map
Jan Möbius's avatar
Jan Möbius committed
73 74 75
  QMap<int,TreeItem*>::iterator iter = kTreeMap_.find( id() );
  if( iter != kTreeMap_.end() ) {
    kTreeMap_.erase(iter);
76 77 78
  } else {
    std::cerr << "Map accelerator destructor in DataControl: Currently removing object that is not in the map!" << std::endl;
  }
Dirk Wilden's avatar
Dirk Wilden committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
}


// ===============================================================================
// Static Members
// ===============================================================================

int TreeItem::id() {
  return id_;
}

//--------------------------------------------------------------------------------

bool TreeItem::dataType(DataType _type) {
  if ( _type == DATA_ALL ) {
    return true;
  }

  return ( dataType_ & _type);
}

//--------------------------------------------------------------------------------

DataType TreeItem::dataType() {
  return dataType_;
}

//--------------------------------------------------------------------------------

int TreeItem::group() {
  // Skip root node
  if ( parent() == 0 )
    return -1;

113
  // Don't count root node as a group
Dirk Wilden's avatar
Dirk Wilden committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
  if ( parent()->parent() == 0 )
    return -1;

  // Only consider groups
  if ( !parent()->dataType(DATA_GROUP) )
    return -1;

  // Get the group id
  return ( parent()->id() );
}

//--------------------------------------------------------------------------------

bool TreeItem::isGroup() {
  return ( dataType(DATA_GROUP) );
}

// ===============================================================================
// Dynamic Members
// ===============================================================================

bool TreeItem::target() {
  return target_;
}

//--------------------------------------------------------------------------------

void TreeItem::target(bool _target) {
  target_= _target;
}

//--------------------------------------------------------------------------------

bool TreeItem::source() {
  return source_;
}

//--------------------------------------------------------------------------------

void TreeItem::source(bool _source) {
  source_ = _source;
}

//--------------------------------------------------------------------------------

bool TreeItem::visible() {
  return visible_;
}

//--------------------------------------------------------------------------------

void TreeItem::visible(bool _visible) {
  visible_ = _visible;
}

//--------------------------------------------------------------------------------

QString TreeItem::name() {
  return name_;
}

//--------------------------------------------------------------------------------

void TreeItem::name(QString _name ) {
  name_ = _name;
}

// ===============================================================================
// Tree Structure
// ===============================================================================

TreeItem* TreeItem::next() {
  // Visit child item of this node
  if ( childItems_.size() > 0 ) {
     return childItems_[0];
  }

  // No Child Item so visit the next child of the parentItem_
  if ( parentItem_ ) {

    TreeItem* parentPointer = parentItem_;
    TreeItem* thisPointer   = this;

    // while we are not at the root node
    while ( parentPointer ) {

      // If there is an unvisited child of the parent, return this one
Jan Möbius's avatar
Jan Möbius committed
201 202
      int position = thisPointer->row() + 1;
      if ( parentPointer->childCount() > position ) {
Jan Möbius's avatar
Jan Möbius committed
203
        return parentPointer->childItems_[ position ];
Dirk Wilden's avatar
Dirk Wilden committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
      }

      // Go to the next level
      thisPointer   = parentPointer;
      parentPointer = parentPointer->parentItem_;

    }

    return thisPointer;
  }

  return this;

}

//--------------------------------------------------------------------------------

int TreeItem::level() {
  int level = 0;
  TreeItem* current = this;

  // Go up and count the levels to the root node
  while ( current->parent() != 0 ) {
    level++;
    current = current->parent();
  }

  return level;
}

//--------------------------------------------------------------------------------

int TreeItem::row() const
{
Jan Möbius's avatar
Jan Möbius committed
238
  return row_;
Dirk Wilden's avatar
Dirk Wilden committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
}

//--------------------------------------------------------------------------------

TreeItem* TreeItem::parent()
{
  return parentItem_;
}

//--------------------------------------------------------------------------------

void TreeItem::setParent(TreeItem* _parent) {
  parentItem_ = _parent;
}

//--------------------------------------------------------------------------------

void TreeItem::appendChild(TreeItem *item)
{
Jan Möbius's avatar
Jan Möbius committed
258
  kTreeMap_[item->id()] = item;
259
  childItems_.append(item);
Jan Möbius's avatar
Jan Möbius committed
260
  item->row_ = childItems_.size() - 1;
Dirk Wilden's avatar
Dirk Wilden committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
}

//--------------------------------------------------------------------------------

TreeItem *TreeItem::child(int row)
{
    return childItems_.value(row);
}

//--------------------------------------------------------------------------------

int TreeItem::childCount() const
{
    return childItems_.count();
}

//--------------------------------------------------------------------------------

TreeItem* TreeItem::childExists(int _objectId) {

  // Check if this object has the requested id
  if ( id_ == _objectId )
    return this;

285
  // Check the map, for the item
Jan Möbius's avatar
Jan Möbius committed
286
  QMap<int,TreeItem*>::const_iterator iter = kTreeMap_.find(_objectId);
Dirk Wilden's avatar
Dirk Wilden committed
287

288
  // Not found -> return 0
Jan Möbius's avatar
Jan Möbius committed
289
  if( iter == kTreeMap_.end() ) {
290 291
    return 0;
  }
Dirk Wilden's avatar
Dirk Wilden committed
292

293 294
  // Move the tree up and check if we are in the line to the root
  TreeItem* current = *iter;
Dirk Wilden's avatar
Dirk Wilden committed
295

296
  while ( true ) {
Dirk Wilden's avatar
Dirk Wilden committed
297

298 299 300 301
    // Current item is a parent of the found one
    if ( current == this ) {
      return *iter;
    }
Dirk Wilden's avatar
Dirk Wilden committed
302

303 304 305 306 307
    // Move to parent or if there is no parent, we return 0
    if ( current->parent() != 0) {
      current = current->parent();
    } else
      return 0;
Dirk Wilden's avatar
Dirk Wilden committed
308 309
  }

310
  // Not in the line, so child does not exist
Dirk Wilden's avatar
Dirk Wilden committed
311 312 313 314 315 316 317
  return 0;
}

//--------------------------------------------------------------------------------

void TreeItem::removeChild( TreeItem* _item ) {

Jan Möbius's avatar
Jan Möbius committed
318
  int idx = (_item != 0) ? _item->row_ : -1;
Dirk Wilden's avatar
Dirk Wilden committed
319

Jan Möbius's avatar
Jan Möbius committed
320
  if ( (idx < 0) || (idx >= childItems_.size()) || (childItems_[idx] != _item) ) {
Dirk Wilden's avatar
Dirk Wilden committed
321 322 323 324
    std::cerr << "TreeItem: Illegal remove request" << std::endl;
    return;
  }

Jan Möbius's avatar
Jan Möbius committed
325 326 327 328 329
  childItems_.removeAt(idx);

  for ( ; idx < childItems_.size(); ++idx ) {
    --(childItems_[idx]->row_);
  }
Dirk Wilden's avatar
Dirk Wilden committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
}

//--------------------------------------------------------------------------------

QList< TreeItem* > TreeItem::getLeafs() {

  QList< TreeItem* > items;

  for ( int i = 0 ; i < childItems_.size(); ++i ) {
    items = items + childItems_[i]->getLeafs();
  }

  // If we are a leave...
  if ( childCount() == 0 )
    items.push_back(this);

  return items;
}

//--------------------------------------------------------------------------------

void TreeItem::deleteSubtree() {

  // call function for all children of this node
  for ( int i = 0 ; i < childItems_.size(); ++i) {

    // remove the subtree recursively
    childItems_[i]->deleteSubtree();

    // delete child
    delete childItems_[i];
  }

  // clear the array
  childItems_.clear();
}

//=============================================================================