Cortex  10.0.0-a4
Group.h
1 //
3 // Copyright (c) 2007-2012, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECOREGL_GROUP_H
36 #define IECOREGL_GROUP_H
37 
38 #include "IECoreGL/Export.h"
39 #include "IECoreGL/Renderable.h"
40 
41 #include "OpenEXR/ImathMatrix.h"
42 
43 #include "tbb/recursive_mutex.h"
44 #include <list>
45 
46 
47 namespace IECoreGL
48 {
49 
50 IE_CORE_FORWARDDECLARE( State );
51 
52 class IECOREGL_API Group : public Renderable
53 {
54 
55  public :
56 
57  typedef tbb::recursive_mutex Mutex;
58  typedef std::list<RenderablePtr> ChildContainer;
59 
60  IE_CORE_DECLARERUNTIMETYPEDEXTENSION( IECoreGL::Group, GroupTypeId, Renderable );
61 
64  Group();
67  Group( const Group &other );
68  ~Group() override;
69 
70  void setTransform( const Imath::M44f &matrix );
71  const Imath::M44f &getTransform() const;
72 
73  State *getState();
74  const State *getState() const;
75  void setState( StatePtr state );
76 
77  // render method ( assumes there's no threads modifying the group ).
78  void render( State *currentState ) const override;
79  Imath::Box3f bound() const override;
80 
81  void addChild( RenderablePtr child );
82  void removeChild( Renderable *child );
83  void clearChildren();
84  const ChildContainer &children() const;
85 
86  // Returns a mutex for this group object.
87  // It should be used if the group is manipulated from different threads.
89  Mutex &mutex() const;
90 
91  private :
92 
93  StatePtr m_state;
94  Imath::M44f m_transform;
95  ChildContainer m_children;
96  mutable Mutex m_mutex;
97 
98 };
99 
100 IE_CORE_DECLAREPTR( Group );
101 
102 } // namespace IECoreGL
103 
104 #endif // IECOREGL_GROUP_H
The namespace within which all CoreGL functionality is defined.
Definition: AlphaTexture.h:41