Developer Documentation
elementArea.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #ifndef VSI_ELEMENTAREA_HH
45 #define VSI_ELEMENTAREA_HH
46 
47 //== INCLUDES =================================================================
48 #include <QGraphicsItem>
49 
50 //== NAMESPACES ===============================================================
51 namespace VSI {
52 
53 //== FORWARDDECLARATIONS ======================================================
54 class GraphicsScene;
55 class SceneElement;
56 
57 //== CLASS DEFINITION =========================================================
58 
62 class ElementArea : public QObject, public QGraphicsItem
63 {
64  Q_OBJECT
65  Q_INTERFACES(QGraphicsItem)
66 
67  public:
68 
70  explicit ElementArea (GraphicsScene *_scene);
71 
73  ~ElementArea ();
74 
76  void addElement (SceneElement *_element);
77 
79  bool removeElement (SceneElement *_element, bool _force = false);
80 
82  QRectF boundingRect () const;
83 
85  const QList<SceneElement *>& elements () const;
86 
88  void paint (QPainter * /*_painter*/, const QStyleOptionGraphicsItem * /*_option*/, QWidget * /*_widget*/ = 0) {};
89 
90  private:
91  GraphicsScene *scene_;
92 
93  QList<SceneElement *> elements_;
94 
95  QRectF elementsBoundingRect_;
96 };
97 
98 }
99 
100 #endif
void addElement(SceneElement *_element)
Add a child element.
Definition: elementArea.cc:86
~ElementArea()
Destructor.
Definition: elementArea.cc:71
QRectF boundingRect() const
Bounding rectangle.
Definition: elementArea.cc:78
ElementArea(GraphicsScene *_scene)
Constructor.
Definition: elementArea.cc:63
void paint(QPainter *, const QStyleOptionGraphicsItem *, QWidget *=0)
for QGraphicsItem
Definition: elementArea.hh:88
const QList< SceneElement * > & elements() const
All elements.
Definition: elementArea.cc:123
bool removeElement(SceneElement *_element, bool _force=false)
Remove an element, if its removeable or _force is set.
Definition: elementArea.cc:103