Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GLScene.h
Go to the documentation of this file.
1 /*
2 
3 License
4 
5 Menge
6 Copyright and trademark 2012-14 University of North Carolina at Chapel Hill.
7 All rights reserved.
8 
9 Permission to use, copy, modify, and distribute this software and its documentation
10 for educational, research, and non-profit purposes, without fee, and without a
11 written agreement is hereby granted, provided that the above copyright notice,
12 this paragraph, and the following four paragraphs appear in all copies.
13 
14 This software program and documentation are copyrighted by the University of North
15 Carolina at Chapel Hill. The software program and documentation are supplied "as is,"
16 without any accompanying services from the University of North Carolina at Chapel
17 Hill or the authors. The University of North Carolina at Chapel Hill and the
18 authors do not warrant that the operation of the program will be uninterrupted
19 or error-free. The end-user understands that the program was developed for research
20 purposes and is advised not to rely exclusively on the program for any reason.
21 
22 IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS
23 BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
24 DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
25 DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE
26 AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY
29 DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY
31 OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
32 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS
33 TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
34 
35 Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu
36 
37 */
38 
48 // TODO: determine if the camera should be part of the scene or viewer.
49 
50 #ifndef __GLSCENE_H__
51 #define __GLSCENE_H__
52 
53 #include "CoreConfig.h"
54 
55 #include "GLNode.h"
56 #include "System.h"
57 #include "Context.h"
58 #include "GLLight.h"
59 
60 #include <list>
61 
62 
63 namespace Menge {
64 
65  namespace SceneGraph {
66 
67  class GLCamera;
68 
72  class MENGE_API GLScene {
73  public:
77  GLScene();
78 
82  ~GLScene();
83 
93  void finish();
94 
100  void newGLContext();
101 
110  void drawGL( const GLCamera & camera, const GLLightVector & lights, int vWidth, int vHeight );
111 
124  bool selectGL( const GLCamera & camera, int vWidth, int vHeight, int * selectPoint );
125 
132  bool updateScene( float time );
133 
147  bool addNode( GLNode * node, GLDagNode * parent = 0x0 );
148 
156  bool addSystem( System * system );
157 
166  void setContext( Context * context );
167 
175  ContextResult handleMouse( SDL_Event & e );
176 
184  ContextResult handleKeyboard( SDL_Event & e );
185 
186  friend class SelectContext;
187  private:
191  SystemList _systems;
192 
197  GLNodeList _nodes;
198 
202  Context * _uiContext;
203  };
204 
205  } // namespace SceneGraph
206 } // namespace Menge
207 #endif //__GLSCENE_H__
The mechanism for evolving a scene w.r.t. time.
An animation system. Responsible for updating the scene based based on increasing time values...
Definition: System.h:83
SDL_Event SDL_Event
Forward declaration of the SDL event type.
Definition: Context.h:53
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
A simple light for defining OpenGL lighting properties.
An abstact class – a generic, scene graph node.
Definition: GLNode.h:66
The node that provides the basis for a "hierarchy" in the scene graph.
Definition: GLNode.h:169
Sets up the proper compiler directives for platform and dll export/import.
The base context class for defining a how events are handled. It also is responsible drawing UI eleme...
Definition: Context.h:156
A context that performs object selection by directly clicking on selectable entities in the OpenGL co...
Definition: Context.h:352
The basic scene graph node. Any object which can be placed into the scene graph is an instance or sub...
The SceneGraph (SceneGraph) name space, containing all elements to use in a SceneGraph.
The class which contains the entire drawable scene.
Definition: GLScene.h:72
Defines the result of the context's consideration of user input.
Definition: Context.h:74
The class for controlling the view camera: it's position, orientation field of view, projection matrix, etc.
Definition: GLCamera.h:57
Defines a context for handling user interaction (mouse and keyboard input).