1 // The canvas for rendering with the 2d API
3 // Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Library General Public
7 // License as published by the Free Software Foundation; either
8 // version 2 of the License, or (at your option) any later version.
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Library General Public License for more details.
15 // You should have received a copy of the GNU Library General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "canvas_fwd.hxx"
23 #include "ODGauge.hxx"
25 #include <simgear/canvas/elements/CanvasGroup.hxx>
26 #include <simgear/math/SGRect.hxx>
27 #include <simgear/props/PropertyBasedElement.hxx>
28 #include <simgear/props/propertyObject.hxx>
29 #include <osg/NodeCallback>
30 #include <osg/observer_ptr>
32 #include <boost/scoped_ptr.hpp>
43 public PropertyBasedElement
51 MISSING_SIZE_X = STATUS_DIRTY << 1,
52 MISSING_SIZE_Y = MISSING_SIZE_X << 1,
53 CREATE_FAILED = MISSING_SIZE_Y << 1
57 * This callback is installed on every placement of the canvas in the
58 * scene to only render the canvas if at least one placement is visible
61 public osg::NodeCallback
64 CullCallback(const CanvasWeakPtr& canvas);
67 CanvasWeakPtr _canvas;
69 virtual void operator()(osg::Node* node, osg::NodeVisitor* nv);
71 typedef osg::ref_ptr<CullCallback> CullCallbackPtr;
73 Canvas(SGPropertyNode* node);
75 virtual void onDestroy();
77 void setSystemAdapter(const SystemAdapterPtr& system_adapter);
78 SystemAdapterPtr getSystemAdapter() const;
80 void setCanvasMgr(CanvasMgr* canvas_mgr);
81 CanvasMgr* getCanvasMgr() const;
86 * Add a canvas which should be marked as dirty upon any change to this
89 * This mechanism is used to eg. redraw a canvas if it's displaying
90 * another canvas (recursive canvases)
92 void addParentCanvas(const CanvasWeakPtr& canvas);
95 * Add a canvas which should be marked visible if this canvas is visible.
97 void addChildCanvas(const CanvasWeakPtr& canvas);
100 * Stop notifying the given canvas upon changes
102 void removeParentCanvas(const CanvasWeakPtr& canvas);
103 void removeChildCanvas(const CanvasWeakPtr& canvas);
108 GroupPtr createGroup(const std::string& name = "");
111 * Get an existing group with the given name
113 GroupPtr getGroup(const std::string& name);
116 * Get an existing group with the given name or otherwise create a new
119 GroupPtr getOrCreateGroup(const std::string& name);
122 * Get the root group of the canvas
124 GroupPtr getRootGroup();
127 * Enable rendering for the next frame
129 * @param force Force redraw even if nothing has changed (if dirty flag
132 void enableRendering(bool force = false);
134 void update(double delta_time_sec);
136 bool addEventListener(const std::string& type, const EventListener& cb);
138 void setSizeX(int sx);
139 void setSizeY(int sy);
141 int getSizeX() const;
142 int getSizeY() const;
144 void setViewWidth(int w);
145 void setViewHeight(int h);
147 int getViewWidth() const;
148 int getViewHeight() const;
149 SGRect<int> getViewport() const;
151 bool handleMouseEvent(const MouseEventPtr& event);
153 virtual void childAdded( SGPropertyNode * parent,
154 SGPropertyNode * child );
155 virtual void childRemoved( SGPropertyNode * parent,
156 SGPropertyNode * child );
157 virtual void valueChanged (SGPropertyNode * node);
159 osg::Texture2D* getTexture() const;
161 CullCallbackPtr getCullCallback() const;
163 void reloadPlacements( const std::string& type = std::string() );
164 static void addPlacementFactory( const std::string& type,
165 PlacementFactory factory );
166 static void removePlacementFactory(const std::string& type);
170 SystemAdapterPtr _system_adapter;
171 CanvasMgr *_canvas_mgr;
173 boost::scoped_ptr<EventManager> _event_manager;
180 PropertyObject<int> _status;
181 PropertyObject<std::string> _status_msg;
183 bool _sampling_dirty,
188 GroupPtr _root_group;
190 CullCallbackPtr _cull_callback;
191 bool _render_always; //<! Used to disable automatic lazy rendering (culling)
193 std::vector<SGPropertyNode*> _dirty_placements;
194 std::vector<Placements> _placements;
195 std::set<CanvasWeakPtr> _parent_canvases, //<! Canvases showing this canvas
196 _child_canvases; //<! Canvases displayed within
199 typedef std::map<std::string, PlacementFactory> PlacementFactoryMap;
200 static PlacementFactoryMap _placement_factories;
202 virtual void setSelf(const PropertyBasedElementPtr& self);
203 void setStatusFlags(unsigned int flags, bool set = true);
207 Canvas(const Canvas&); // = delete;
208 Canvas& operator=(const Canvas&); // = delete;
211 } // namespace canvas
212 } // namespace simgear
214 #endif /* CANVAS_HXX_ */