-// The canvas for rendering with the 2d API
+///@file The canvas for rendering with the 2d API
//
// Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
//
#include "ODGauge.hxx"
#include <simgear/canvas/elements/CanvasGroup.hxx>
+#include <simgear/canvas/layout/Layout.hxx>
+#include <simgear/math/SGRect.hxx>
+#include <simgear/nasal/cppbind/NasalObject.hxx>
#include <simgear/props/PropertyBasedElement.hxx>
#include <simgear/props/propertyObject.hxx>
+
#include <osg/NodeCallback>
#include <osg/observer_ptr>
-#include <memory>
+#include <boost/scoped_ptr.hpp>
#include <string>
namespace simgear
{
+/// Canvas 2D drawing API
namespace canvas
{
class CanvasMgr;
class MouseEvent;
class Canvas:
- public PropertyBasedElement
+ public PropertyBasedElement,
+ public nasal::Object
{
public:
enum StatusFlags
{
STATUS_OK,
- MISSING_SIZE_X = 0x0001,
- MISSING_SIZE_Y = 0x0002,
- CREATE_FAILED = 0x0004
+ STATUS_DIRTY = 1,
+ LAYOUT_DIRTY = STATUS_DIRTY << 1,
+ MISSING_SIZE_X = LAYOUT_DIRTY << 1,
+ MISSING_SIZE_Y = MISSING_SIZE_X << 1,
+ MISSING_SIZE = MISSING_SIZE_X | MISSING_SIZE_Y,
+ CREATE_FAILED = MISSING_SIZE_Y << 1
};
/**
Canvas(SGPropertyNode* node);
virtual ~Canvas();
-
- void setSystemAdapter(const SystemAdapterPtr& system_adapter);
- SystemAdapterPtr getSystemAdapter() const;
+ virtual void onDestroy();
void setCanvasMgr(CanvasMgr* canvas_mgr);
CanvasMgr* getCanvasMgr() const;
+ bool isInit() const;
+
/**
- * Add a canvas which should be mared as dirty upon any change to this
+ * Add a canvas which should be marked as dirty upon any change to this
* canvas.
*
* This mechanism is used to eg. redraw a canvas if it's displaying
* another canvas (recursive canvases)
*/
- void addDependentCanvas(const CanvasWeakPtr& canvas);
+ void addParentCanvas(const CanvasWeakPtr& canvas);
+
+ /**
+ * Add a canvas which should be marked visible if this canvas is visible.
+ */
+ void addChildCanvas(const CanvasWeakPtr& canvas);
/**
* Stop notifying the given canvas upon changes
*/
- void removeDependentCanvas(const CanvasWeakPtr& canvas);
+ void removeParentCanvas(const CanvasWeakPtr& canvas);
+ void removeChildCanvas(const CanvasWeakPtr& canvas);
+ /**
+ * Create a new group
+ */
GroupPtr createGroup(const std::string& name = "");
+ /**
+ * Get an existing group with the given name
+ */
+ GroupPtr getGroup(const std::string& name);
+
+ /**
+ * Get an existing group with the given name or otherwise create a new
+ * group
+ */
+ GroupPtr getOrCreateGroup(const std::string& name);
+
+ /**
+ * Get the root group of the canvas
+ */
+ GroupPtr getRootGroup();
+
+ /**
+ * Set the layout of the canvas (the layout will automatically update with
+ * the viewport size of the canvas)
+ */
+ void setLayout(const LayoutRef& layout);
+
/**
* Enable rendering for the next frame
*
void update(double delta_time_sec);
+ bool addEventListener(const std::string& type, const EventListener& cb);
+ bool dispatchEvent(const EventPtr& event);
+
void setSizeX(int sx);
void setSizeY(int sy);
void setViewWidth(int w);
void setViewHeight(int h);
- bool handleMouseEvent(const MouseEvent& event);
+ int getViewWidth() const;
+ int getViewHeight() const;
+ SGRect<int> getViewport() const;
+
+ bool handleMouseEvent(const MouseEventPtr& event);
+ bool propagateEvent( EventPtr const& event,
+ EventPropagationPath const& path );
virtual void childAdded( SGPropertyNode * parent,
SGPropertyNode * child );
CullCallbackPtr getCullCallback() const;
+ void reloadPlacements( const std::string& type = std::string() );
static void addPlacementFactory( const std::string& type,
PlacementFactory factory );
+ static void removePlacementFactory(const std::string& type);
+
+ /**
+ * Set global SystemAdapter for all Canvas/ODGauge instances.
+ *
+ * The SystemAdapter is responsible for application specific operations
+ * like loading images/fonts and adding/removing cameras to the scene
+ * graph.
+ */
+ static void setSystemAdapter(const SystemAdapterPtr& system_adapter);
+ static SystemAdapterPtr getSystemAdapter();
protected:
- SystemAdapterPtr _system_adapter;
CanvasMgr *_canvas_mgr;
+ boost::scoped_ptr<EventManager> _event_manager;
+
int _size_x,
_size_y,
_view_width,
PropertyObject<int> _status;
PropertyObject<std::string> _status_msg;
- PropertyObject<int> _mouse_x, _mouse_y,
- _mouse_dx, _mouse_dy,
- _mouse_button,
- _mouse_state,
- _mouse_mod,
- _mouse_scroll,
- _mouse_event;
-
bool _sampling_dirty,
_render_dirty,
_visible;
ODGauge _texture;
- std::auto_ptr<Group> _root_group;
+
+ GroupPtr _root_group;
+ LayoutRef _layout;
CullCallbackPtr _cull_callback;
bool _render_always; //<! Used to disable automatic lazy rendering (culling)
std::vector<SGPropertyNode*> _dirty_placements;
- std::vector<canvas::Placements> _placements;
- std::set<CanvasWeakPtr> _dependent_canvases; //<! Canvases which use this
- // canvas and should be
- // notified about changes
+ std::vector<Placements> _placements;
+ std::set<CanvasWeakPtr> _parent_canvases, //<! Canvases showing this canvas
+ _child_canvases; //<! Canvases displayed within
+ // this canvas
- typedef std::map<std::string, canvas::PlacementFactory> PlacementFactoryMap;
+ typedef std::map<std::string, PlacementFactory> PlacementFactoryMap;
static PlacementFactoryMap _placement_factories;
- virtual void setSelf(const PropertyBasedElementPtr& self);
void setStatusFlags(unsigned int flags, bool set = true);
private:
+ static SystemAdapterPtr _system_adapter;
+
Canvas(const Canvas&); // = delete;
Canvas& operator=(const Canvas&); // = delete;
};
projects / simgear.git / blobdiff