PluginFunctions.hh 25.3 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
41
42
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
43
44
45
46
47
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
48
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67




//=============================================================================
//
//  Standard Functions
//
//=============================================================================

/**
 * \file PluginFunctions.hh
 * This file contains functions which can be used by plugins to access data in the framework.
 */

//
#ifndef PLUGINFUNCTIONS_HH
#define PLUGINFUNCTIONS_HH

Matthias Möller's avatar
Matthias Möller committed
68
69
#include <OpenFlipper/common/Types.hh>

Jan Möbius's avatar
Dennis:    
Jan Möbius committed
70
#include <QPair>
71
#include <QFileDialog>
Jan Möbius's avatar
Dennis:    
Jan Möbius committed
72

Jan Möbius's avatar
   
Jan Möbius committed
73
#include <ACG/Scenegraph/SceneGraph.hh>
74
#include <OpenFlipper/BasePlugin/PluginFunctionsViewControls.hh>
Jan Möbius's avatar
 
Jan Möbius committed
75

76
77
//== FORWARDDECLARATIONS ======================================================
class ViewObjectMarker;
78
class QGLWidget;
79

Jan Möbius's avatar
 
Jan Möbius committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/** The Namespace PluginFunctions contains functions for all plugins. These functions should be used to get the
 *  objects to work on or to set modes in the examiner widget. */
namespace PluginFunctions {

//=======================================
// Get Source/Target objects
/** @name Active Objects
* @{ */
//=======================================

/** \brief Get the picked mesh
 * @param _node_idx Node index returned by examiner picking
 * @param _object returns the object which contains the mesh
 * @return true if mesh was found, false if picked object is not a mesh or not found
 */
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
96
bool getPickedObject(const unsigned int _node_idx , BaseObjectData*& _object);
Jan Möbius's avatar
 
Jan Möbius committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

/** @} */

//=======================================
// Get Objects by their identifier
    /** @name Identifier handling
    * @{ */
//=======================================

/** \brief Get the identifiers of all objects marked as a source object.
 *
 * @param _identifiers ( vector returning the source object identifiers )
 * @return false, if no object is selected as source
*/
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
112
bool getSourceIdentifiers( std::vector<int>& _identifiers  );
Jan Möbius's avatar
 
Jan Möbius committed
113
114
115
116
117
118
119

/** \brief Get the identifiers of all objects marked as a target object.
 *
 * @param _identifiers ( vector returning the target object identifiers )
 * @return false, if no object is selected as target
*/
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
120
bool getTargetIdentifiers( std::vector<int>& _identifiers  );
Jan Möbius's avatar
 
Jan Möbius committed
121

122
/** \brief Get identifiers of all objects
Jan Möbius's avatar
 
Jan Möbius committed
123
124
 *
 * @param _identifiers ( vector returning the identifiers )
125
 * @return false, if no object is found
Jan Möbius's avatar
 
Jan Möbius committed
126
127
*/
DLLEXPORT
128
bool getAllObjectIdentifiers( std::vector<int>& _identifiers  );
Jan Möbius's avatar
 
Jan Möbius committed
129

130
/** \brief Get identifiers of all meshes
Jan Möbius's avatar
 
Jan Möbius committed
131
132
133
134
135
 *
 * @param _identifiers ( vector returning the identifiers )
 * @return false, if no mesh is found
*/
DLLEXPORT
136
bool getAllMeshes( std::vector<int>& _identifiers  );
Jan Möbius's avatar
 
Jan Möbius committed
137
138
139
140
141
142
143
144
145
146
147
148

/** \brief Get the object which has the given identifier.
 *
 *  Every loaded object has a unique identifier which is stored in the id field of the object container.
 *  Use this function to get the object which has this id. This can be used for a consistent mapping
 *  even if the data objects change during plugin operations (e.g. selection and main algorithm).\n
 *  This function only returns visible objects.
 * @param _identifier Object id to search for
 * @param _object  returns the object
 * @return Object found?
 */
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
149
bool getObject(  const int _identifier , BaseObject*& _object );
Jan Möbius's avatar
 
Jan Möbius committed
150
151

/** This functions returns the object with the given id regardless of the type of object.
152
 * See getObject(  const int _identifier , BaseObject*& _object ) for more details.
Jan Möbius's avatar
 
Jan Möbius committed
153
154
 */
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
155
bool getObject(  const int _identifier , BaseObjectData*& _object );
Jan Möbius's avatar
 
Jan Möbius committed
156

157
158
159
/** This functions returns the object's id with the given name.
 */
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
160
int getObjectId( const QString& _name );
161

Jan Möbius's avatar
 
Jan Möbius committed
162
163
164
165
166
167
/** \brief Check if an object with this identifier exists.
 *
 * Searches through the Data containers and checks if the object with the given identifier exists
 * @param _identifier  Object id to search for
 */
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
168
bool objectExists(  const int _identifier );
Jan Möbius's avatar
 
Jan Möbius committed
169
170
171

/// Get the number of available objects
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
172
int objectCount();
Jan Möbius's avatar
 
Jan Möbius committed
173
174
175

/// Get the number of target objects
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
176
int targetCount();
Jan Möbius's avatar
 
Jan Möbius committed
177
178
179

/// Get the number of source objects
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
180
int sourceCount();
Jan Möbius's avatar
 
Jan Möbius committed
181
182
183

/// Get the number of visible objects
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
184
int visibleCount();
Jan Möbius's avatar
 
Jan Möbius committed
185
186
187
188
189
190
191
192

/** @} */

//=======================================
// Get/set status of examiner
    /** @name Examiner handling
    * @{ */
//=======================================
Jan Möbius's avatar
Jan Möbius committed
193

194
195
196

/// Get the number of viewers
DLLEXPORT
197
int viewers( );
198

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/** \brief Disable the core light handling
*
* Use this function to disable OpenFlippers Core light handling.
* Use this function only if the light is handled by your plugin
* Normally this function is called by the light plugin which
* fully takes control over the glLighting and adds its own light nodes.
*/
DLLEXPORT
void disableExaminerLightHandling();

/** \brief returns if internal light handling is active.
*
* Internal light handling could only be deactivated. From than on a plugin
* has to manage all light handling.
*/
DLLEXPORT
bool examinerLightHandling();

Jan Möbius's avatar
Jan Möbius committed
217
218
/// Set the active id of the examiner which got the last mouse events
DLLEXPORT
219
void setActiveExaminer( const unsigned int _id );
Jan Möbius's avatar
 
Jan Möbius committed
220

221
222
223
224
/// Get the id of the examiner which got the last mouse events
DLLEXPORT
unsigned int activeExaminer();

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/// Get the encoded view for the active examiner
DLLEXPORT
QString getEncodedExaminerView();

/// Get the encoded view for the given
DLLEXPORT
QString getEncodedExaminerView(int _viewerId);

/// Set the encoded view for the active examiner
DLLEXPORT
void setEncodedExaminerView( QString _view );

/// Set the encoded view for the given
DLLEXPORT
void setEncodedExaminerView(int _viewerId , QString _view );

241
242
243
244
245
246
/**
 * Set center of scene
 */
DLLEXPORT
void setSceneCenter(const ACG::Vec3d& _center, int _viewer );

247
248
/** \brief Execute picking operation on scenegraph
 *
Jan Möbius's avatar
Jan Möbius committed
249
 * This picking function will pick in the last active examiner context which is automatically
250
 * set by the last mouse event from the core
Jan Möbius's avatar
Jan Möbius committed
251
 */
Jan Möbius's avatar
 
Jan Möbius committed
252
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
253
bool scenegraphPick( ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, unsigned int &_nodeIdx, unsigned int &_targetIdx, ACG::Vec3d *_hitPointPtr );
Jan Möbius's avatar
 
Jan Möbius committed
254

255
256
/** \brief Execute picking operation on scenegraph
 *
Jan Möbius's avatar
Jan Möbius committed
257
258
 * This picking function will pick in the specified examiner context
 */
Jan Möbius's avatar
Jan Möbius committed
259
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
260
bool scenegraphPick( const unsigned int _examiner ,ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, unsigned int &_nodeIdx, unsigned int &_targetIdx, ACG::Vec3d *_hitPointPtr );
Jan Möbius's avatar
Jan Möbius committed
261

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/** \brief Execute picking operation on scenegraph and return object
 *
 * This picking function will pick in the specified examiner context and
 * will return a pointer to the picked object. Furthermore, the refine picking of
 * the picked object will be called in order to achieve higher picking accuracy
 */
DLLEXPORT
bool scenegraphPick( const unsigned int _examiner ,ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, BaseObjectData*& _object, unsigned int &_targetIdx, const bool _refine ,ACG::Vec3d *_hitPointPtr );

/** \brief Execute picking operation on scenegraph and return object
 *
 * This picking function will pick in the examiner context of the last mouse event and
 * will return a pointer to the picked object. Furthermore, the refine picking of
 * the picked object will be called in order to achieve higher picking accuracy
 */
DLLEXPORT
bool scenegraphPick( ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, BaseObjectData*& _object, unsigned int &_targetIdx, const bool _refine, ACG::Vec3d *_hitPointPtr );


Jan Möbius's avatar
Dennis:    
Jan Möbius committed
281
282
283
284
285
/** Execute picking operation on scenegraph
 * This picking function will pick in the last active examiner context which is automatically
 * Set by mouseevents from the core
 */
DLLEXPORT
Henrik Zimmer's avatar
Henrik Zimmer committed
286
287
288
bool scenegraphRegionPick( ACG::SceneGraph::PickTarget                _pickTarget,
                           const QRegion&                             _region,
                           QList<QPair<unsigned int, unsigned int> >& _list,
289
290
                           QVector<float>*                            _depths = 0,
                           QVector<ACG::Vec3d>*                       _points = 0);
Henrik Zimmer's avatar
Henrik Zimmer committed
291
292
293
294
295
296
297
298
299

/** Execute picking operation on scenegraph
 * This picking function will pick in the specified examiner context
 */
DLLEXPORT
bool scenegraphRegionPick( const unsigned int                         _examiner,
                           ACG::SceneGraph::PickTarget                _pickTarget,
                           const QRegion&                             _region,
                           QList<QPair<unsigned int, unsigned int> >& _list,
300
301
                           QVector<float>*                            _depths = 0,
                           QVector<ACG::Vec3d>*                       _points = 0);
Henrik Zimmer's avatar
Henrik Zimmer committed
302

Jan Möbius's avatar
Jan Möbius committed
303
/** Execute Scenegraph traversal with action and use the last active examiner
Jan Möbius's avatar
Jan Möbius committed
304
305
 *  If you are reacting on a mouseEvent you should use this function as it will
 *  automatically set the right view
Jan Möbius's avatar
Jan Möbius committed
306
 */
Jan Möbius's avatar
 
Jan Möbius committed
307
308
309
310
311
DLLEXPORT
void traverse( ACG::SceneGraph::MouseEventAction  &_action );

/// Get the current Picking mode
DLLEXPORT
312
const std::string pickMode ();
Jan Möbius's avatar
 
Jan Möbius committed
313

Jan Möbius's avatar
Jan Möbius committed
314
/// Set the current Picking mode for all examiner widgets
Jan Möbius's avatar
 
Jan Möbius committed
315
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
316
void pickMode ( const std::string& _mode);
Jan Möbius's avatar
 
Jan Möbius committed
317
318
319

/// Returns a QImage of the current View
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
320
void getCurrentViewImage(QImage& _image);
Jan Möbius's avatar
 
Jan Möbius committed
321

Jan Möbius's avatar
Jan Möbius committed
322
323
324
325
/** \brief get scenegraph root node
*
* Get the real root node of the scenegraph.This node is the topmost
* node of the scenegraph. Normally you do not need to use this node.
Jan Möbius's avatar
Jan Möbius committed
326
* Except you are writing a renderer plugin.
Jan Möbius's avatar
Jan Möbius committed
327
328
329
* All objects should be added below the data root node which you can get
* with getRootNode().
*/
Dirk Wilden's avatar
Dirk Wilden committed
330
331
332
DLLEXPORT
ACG::SceneGraph::BaseNode* getSceneGraphRootNode();

Jan Möbius's avatar
Jan Möbius committed
333
334
335
336
337
/** \brief Get the root node for data objects
*
* Get the root node for the objects. This node is a separator node.
* All nodes belonging to objects have to be placed below this node.
* Add a separatornode for each object below this node! */
Jan Möbius's avatar
 
Jan Möbius committed
338
339
340
DLLEXPORT
ACG::SceneGraph::BaseNode* getRootNode();

341
342
343
344
345
/** \brief Add a global node
*
* The node will be added as a global node. Only the global status nodes
* will be above this node.
*/
Dirk Wilden's avatar
Dirk Wilden committed
346
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
347
void addGlobalNode(ACG::SceneGraph::BaseNode* _node);
Dirk Wilden's avatar
Dirk Wilden committed
348

349
350
351
352
353
354
355
/** \brief Adds a global status node.
*
* The node will be added at the top of the scenegraph, before all other nodes except
* The scenegraphs real node. It will therefore influence all nodes in the scenegraph.
*/
void addGlobalStatusNode(ACG::SceneGraph::BaseNode* _node);

Jan Möbius's avatar
Jan Möbius committed
356
357
358
359
360
361
362
363
/** \brief Add scenegraph node modifing object rendering
*
* This function adds nodes in front of the object root node.
* Therefore all objects renderings will be modified by the
* state changes in the added node. This might be usefull for
* adding for example a slicing node, which adds clipping planes
* such that the objects will be sliced.
*/
Dirk Wilden's avatar
Dirk Wilden committed
364
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
365
void addObjectRenderingNode(ACG::SceneGraph::BaseNode* _node);
Dirk Wilden's avatar
Dirk Wilden committed
366

Jan Möbius's avatar
 
Jan Möbius committed
367
368
/// Set the current Action Mode (PickMode,ExamineMode,...)
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
369
void actionMode ( Viewer::ActionMode _mode);
Jan Möbius's avatar
 
Jan Möbius committed
370
371
372

/// Get the current Action mode
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
373
374
Viewer::ActionMode actionMode();

375
376
377
378
379
380
381
382
/// Sets the main QGLWidget for gl data sharing.
DLLEXPORT
void shareGLWidget (QGLWidget* _widget);

/// Returns the main QGLWidget for gl data sharing.
DLLEXPORT
QGLWidget* shareGLWidget ();

Jan Möbius's avatar
 
Jan Möbius committed
383
384
385
386
387
388
389
390
391
392
393
/** Lock scene rotation via mouse
 *
 * @param _mode allow or disallow rotation
 */
DLLEXPORT
void allowRotation(bool _mode);

/** \brief Map coordinates of GL Widget to global coordinates
 *
 */
DLLEXPORT
394
QPoint mapToGlobal( const QPoint _point );
Jan Möbius's avatar
 
Jan Möbius committed
395
396
397
398
399

/** \brief Map global coordinates to GL Widget local coordinates
 *
 */
DLLEXPORT
400
QPoint mapToLocal( const QPoint _point );
Jan Möbius's avatar
 
Jan Möbius committed
401

402
403
404
405
406
407
408
409
410
411
412
413
414
415
/** Set current ViewObjectMarker (will be reseted to default on pick mode change)
 *
 * @param _marker Object marker
 */
DLLEXPORT
void setViewObjectMarker (ViewObjectMarker *_marker);

/** Set the default ViewObjectMarker
 *
 * @param _marker Object marker
 */
DLLEXPORT
void setDefaultViewObjectMarker (ViewObjectMarker *_marker);

416
417
418
419
420
/** Collect and return COMMENT properties of all meshes.
 */
DLLEXPORT
QStringList collectObjectComments(bool visibleOnly, bool targetedOnly);

421
422
423
424
425
/** Collect and return serialized materials of all meshes.
 */
DLLEXPORT
QStringList collectObjectMaterials(bool visibleOnly, bool targetedOnly);

426
427
428
429
/// Get the default ViewObjectMarker
DLLEXPORT
ViewObjectMarker* defaultViewObjectMarker ();

Jan Möbius's avatar
 
Jan Möbius committed
430
431
/** @} */

432

Jan Möbius's avatar
 
Jan Möbius committed
433
434
435
436
437
438
//=======================================
// Iterators for object Access
    /** @name Iterators
    * @{ */
//=======================================

Jan Möbius's avatar
Dennis:    
Jan Möbius committed
439
440
441
442
443
typedef QStringList IteratorRestriction;

const QStringList ALL_OBJECTS;
const QStringList TARGET_OBJECTS ("target");
const QStringList SOURCE_OBJECTS ("source");
Jan Möbius's avatar
 
Jan Möbius committed
444
445
446
447

/** \brief Core Data Iterator
 *
 * This is the core iterator for the whole framework. You should use this iterator to access your data.\n
Jan Möbius's avatar
Jan Möbius committed
448
 * You can choose if the iterator returns only Target, Source or all objects.\n
Jan Möbius's avatar
 
Jan Möbius committed
449
 * Additionally you can set the type of objects returned by the iterator.
Jan Möbius's avatar
Jan Möbius committed
450
 * The ObjectIterator will only return real Objects. Groups are not considered to be objects
Jan Möbius's avatar
 
Jan Möbius committed
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 */
class DLLEXPORT ObjectIterator {

   public :

      /// type of the Objects the iterator works on
      typedef BaseObjectData  value_type;

      /// handle type (just an int)
      typedef BaseObjectData* value_handle;

      /// reference type
      typedef value_type&     reference;

      /// basic pointer type
      typedef value_type*     pointer;

   /** \brief Use this constructor for iterating through your data.
    *
    * @param _restriction Use this parameter to define which objects will be returned.\n
    *                     You can select between ALL_OBJECTS , TARGET_OBJECTS , SOURCE_OBJECTS.
    * @param _dataType Use this parameter to select the returned object types.
    *                  You can use DATA_ALL DATA_POLY_MESH DATA_TRIANGLE_MESH DATA_VOLUME
    */
   ObjectIterator(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   /// additional constructor starting at a given position
   ObjectIterator(BaseObjectData* pos, IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   /// return the current position of the iterator
   operator value_handle() { return pos_;  };

   /// compare iterators
484
   bool operator==( const ObjectIterator& _rhs) const;
Jan Möbius's avatar
 
Jan Möbius committed
485
486

   /// compare iterators
487
   bool operator!=( const ObjectIterator& _rhs) const;
Jan Möbius's avatar
 
Jan Möbius committed
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516

   /// assign iterators
   ObjectIterator& operator=( const ObjectIterator& _rhs);

   /// dereference
   pointer operator->();

   /// next element
   ObjectIterator& operator++();

   /// last element
   ObjectIterator& operator--();

   /// dereference the iterator
   BaseObjectData* operator*();

   /// return current position of the iterator
   BaseObjectData* index() { return pos_; };

   private :
      /// current position of the iterator
      BaseObjectData* pos_;

      /// returned data types of the iterator
      DataType dataType_;

      /// Restriction of the iterator
      IteratorRestriction restriction_;

Jan Möbius's avatar
Jan Möbius committed
517
518
519
520
521
      /** Takes an object and goes through the object tree to the next BaseObjectData
        *  It stops at the root node.
        */
      inline void proceedToNextBaseObjectData(BaseObject*& _object);

Jan Möbius's avatar
 
Jan Möbius committed
522
523
};

524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
/** \brief Range adapter for ObjectIterator
 *
 * An iterator range suitable for iterating over objects using a C++11
 * range-based for loop.
 *
 * \note Use the PluginFunction::objects factory function as a shorthand for
 * creating object ranges.
 **/
class DLLEXPORT ObjectRange {
public:
    explicit ObjectRange(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL) :
        restriction_(_restriction),
        dataType_(_dataType)
    {
    }

    ObjectIterator begin() const {
        return ObjectIterator(restriction_, dataType_);
    }

    ObjectIterator end() const {
        return ObjectIterator(0);
    }

private:
    IteratorRestriction restriction_;
    DataType dataType_;
};


/** \brief Iterable object range
 *
 * Creates an iterator range suitable for iterating over objects using a C++11
 * range-based for loop.
 *
 * \note Iterated elements are *pointers* to objects, not object references.
 * Hence, the loop header should be declared as
 * \code
 * for (auto* object : PluginFunctions::objects(..., ...) {
 *     ...
 * }
 * \endcode
 **/
DLLEXPORT
ObjectRange objects(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL);


Jan Möbius's avatar
Jan Möbius committed
571
572
/** \brief Core Data Iterator used to iterate over all objects (Including groups)
 *
Jan Möbius's avatar
Jan Möbius committed
573
574
575
 * This iterator is a more low level one not only returning really visible objects but also
 * Data containers ( e.g. groups... )
 * You can choose if the iterator returns only Target, Source or all objects.\n
Jan Möbius's avatar
Jan Möbius committed
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 * Additionally you can set the type of objects returned by the iterator.
 */
class DLLEXPORT BaseObjectIterator {

   public :

      /// type of the Objects the iterator works on
      typedef BaseObject  value_type;

      /// handle type (just an int)
      typedef BaseObject* value_handle;

      /// reference type
      typedef value_type&     reference;

      /// basic pointer type
      typedef value_type*     pointer;

   /** \brief Use this constructor for iterating through your data.
    *
    * @param _restriction Use this parameter to define which objects will be returned.\n
    *                     You can select between ALL_OBJECTS , TARGET_OBJECTS , SOURCE_OBJECTS.
    * @param _dataType Use this parameter to select the returned object types.
    *                  You can use DATA_ALL DATA_POLY_MESH DATA_TRIANGLE_MESH DATA_VOLUME
    */
   BaseObjectIterator(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   /// additional constructor starting at a given position
   BaseObjectIterator(BaseObject* pos, IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   /// return the current position of the iterator
   operator value_handle() { return pos_;  };

   /// compare iterators
   bool operator==( const BaseObjectIterator& _rhs);

   /// compare iterators
   bool operator!=( const BaseObjectIterator& _rhs);

   /// assign iterators
   BaseObjectIterator& operator=( const BaseObjectIterator& _rhs);

   /// dereference
   pointer operator->();

   /// next element
   BaseObjectIterator& operator++();

   /// last element
   BaseObjectIterator& operator--();

   /// dereference the iterator
   BaseObject* operator*();

   /// return current position of the iterator
   BaseObject* index() { return pos_; };

   private :
      /// current position of the iterator
      BaseObject* pos_;

      /// returned data types of the iterator
      DataType dataType_;

      /// Restriction of the iterator
      IteratorRestriction restriction_;

};

Jan Möbius's avatar
 
Jan Möbius committed
645
646
647
648
649
// /// Return Iterator to Mesh End
// MeshIterator meshes_end();

/// Return Iterator to Object End
DLLEXPORT
Jan Möbius's avatar
   
Jan Möbius committed
650
ObjectIterator objectsEnd();
Jan Möbius's avatar
 
Jan Möbius committed
651

Jan Möbius's avatar
Jan Möbius committed
652
653
/// Return Iterator to Object End
DLLEXPORT
654
BaseObjectIterator baseObjectsEnd();
Jan Möbius's avatar
Jan Möbius committed
655

Jan Möbius's avatar
 
Jan Möbius committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
/** @} */

//=======================================
// Dont Use functions below!!!
    /** @name Do never use!!
    * @{ */
//=======================================

/** Set the global DataContainer*/
DLLEXPORT
void setDataRoot( BaseObject* _root );

/** @} */

//=======================================
    /** @name Getting data from objects and casting between them
     * @{ */
//=======================================

/** \brief Cast an BaseObject to a BaseObjectData if possible
 *
 * @param _object The object should be of type BaseObject. If the content is a BaseObjectData, a
 *                a BaseObjectData is returned. Otherwise a NULL pointer is returned.
 */
DLLEXPORT
BaseObjectData* baseObjectData( BaseObject* _object );

/** @} */

685
686
687
688
689
690
691
692
693

/** \brief Return unique viewer id
 *
 * This function returns a id which is unique to all running Openflippers on that machine.
 * This id changes when you restart the viewer!
 */
DLLEXPORT
int viewerId();

Jan Möbius's avatar
 
Jan Möbius committed
694
695
/// Get the root of the object structure
DLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
696
BaseObject*& objectRoot();
Jan Möbius's avatar
 
Jan Möbius committed
697

698
699
700
701
702
703
704
705
706
707
/**
 * The same as QFileDialog::getOpenFileName, except the dialog remembers its
 * last location within the file systems and opens at the same location the
 * next time.
 *
 * @param configProperty The name of the property in which to store the
 *                       last location. Should be of the form "Plugin-Foo/OpenBarFile".
 *
 * @param defaultDir If the property doesn't exist yet, defaultDir is used
 *                   as the initial location.
Jan Möbius's avatar
Jan Möbius committed
708
709
710
711
712
713
714
715
 *
 * @param parent       Parent qt widget
 * @param caption      Caption of the dialog
 * @param defaultDir   Default directory when dialog is shown
 * @param filter       name filters
 * @param selectedFilter currently selected filter
 * @param options      filedialog options
 *
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 */
DLLEXPORT
QString getOpenFileName(const QString &configProperty,
                        QWidget * parent = 0, const QString & caption = QString(),
                        const QString & defaultDir = QString(), const QString & filter = QString(),
                        QString * selectedFilter = 0, QFileDialog::Options options = 0);
/**
 * The same as QFileDialog::getSaveFileName, except the dialog remembers its
 * last location within the file systems and opens at the same location the
 * next time.
 *
 * @param configProperty The name of the property in which to store the
 *                       last location. Should be of the form "Plugin-Foo/SaveBarFile".
 *
 * @param defaultDir If the property doesn't exist yet, defaultDir is used
 *                   as the initial location.
Jan Möbius's avatar
Jan Möbius committed
732
 *
Jan Möbius's avatar
Jan Möbius committed
733
734
735
736
 * @param parent         Parent qt widget
 * @param caption        Caption of the dialog
 * @param defaultDir     Default directory when dialog is shown
 * @param filter         name filters
Jan Möbius's avatar
Jan Möbius committed
737
 * @param selectedFilter currently selected filter
Jan Möbius's avatar
Jan Möbius committed
738
739
 * @param options        file dialog options
 * @param defaultSuffix  Optional default suffix used in the dialog
740
741
742
743
744
 */
DLLEXPORT
QString getSaveFileName(const QString &configProperty,
                        QWidget * parent = 0, const QString & caption = QString(),
                        const QString & defaultDir = QString(), const QString & filter = QString(),
Jan Möbius's avatar
Jan Möbius committed
745
746
                        QString * selectedFilter = 0, QFileDialog::Options options = 0,
                        const QString & defaultSuffix = QString() );
747

748
} /* namespace PluginFunctions */
Jan Möbius's avatar
 
Jan Möbius committed
749
750

#endif //PLUGINFUNCTIONS_HH