1 // NasalCanvas.cxx -- expose Canvas classes to Nasal
3 // Written by James Turner, started 2012.
5 // Copyright (C) 2012 James Turner
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 #include "NasalCanvas.hxx"
26 #include <Canvas/canvas_mgr.hxx>
27 #include <Canvas/gui_mgr.hxx>
28 #include <Main/globals.hxx>
29 #include <Scripting/NasalSys.hxx>
31 #include <osgGA/GUIEventAdapter>
33 #include <simgear/sg_inlines.h>
35 #include <simgear/canvas/Canvas.hxx>
36 #include <simgear/canvas/CanvasWindow.hxx>
37 #include <simgear/canvas/elements/CanvasElement.hxx>
38 #include <simgear/canvas/elements/CanvasText.hxx>
39 #include <simgear/canvas/MouseEvent.hxx>
41 #include <simgear/nasal/cppbind/from_nasal.hxx>
42 #include <simgear/nasal/cppbind/to_nasal.hxx>
43 #include <simgear/nasal/cppbind/NasalHash.hxx>
44 #include <simgear/nasal/cppbind/Ghost.hxx>
46 extern naRef propNodeGhostCreate(naContext c, SGPropertyNode* n);
48 namespace sc = simgear::canvas;
50 template<class Element>
51 naRef elementGetNode(Element& element, naContext c)
53 return propNodeGhostCreate(c, element.getProps());
56 typedef nasal::Ghost<sc::EventPtr> NasalEvent;
57 typedef nasal::Ghost<sc::MouseEventPtr> NasalMouseEvent;
58 typedef nasal::Ghost<sc::CanvasPtr> NasalCanvas;
59 typedef nasal::Ghost<sc::ElementPtr> NasalElement;
60 typedef nasal::Ghost<sc::GroupPtr> NasalGroup;
61 typedef nasal::Ghost<sc::TextPtr> NasalText;
62 typedef nasal::Ghost<sc::WindowWeakPtr> NasalWindow;
64 naRef to_nasal_helper(naContext c, const osg::BoundingBox& bb)
66 std::vector<float> bb_vec(4);
67 bb_vec[0] = bb._min.x();
68 bb_vec[1] = bb._min.y();
69 bb_vec[2] = bb._max.x();
70 bb_vec[3] = bb._max.y();
72 return nasal::to_nasal(c, bb_vec);
75 SGPropertyNode* from_nasal_helper(naContext c, naRef ref, SGPropertyNode**)
77 SGPropertyNode* props = ghostToPropNode(ref);
79 naRuntimeError(c, "Not a SGPropertyNode ghost.");
84 CanvasMgr& requireCanvasMgr(naContext c)
86 CanvasMgr* canvas_mgr =
87 static_cast<CanvasMgr*>(globals->get_subsystem("Canvas"));
89 naRuntimeError(c, "Failed to get Canvas subsystem");
94 GUIMgr& requireGUIMgr(naContext c)
97 static_cast<GUIMgr*>(globals->get_subsystem("CanvasGUI"));
99 naRuntimeError(c, "Failed to get CanvasGUI subsystem");
105 * Create new Canvas and get ghost for it.
107 static naRef f_createCanvas(const nasal::CallContext& ctx)
109 return NasalCanvas::create(ctx.c, requireCanvasMgr(ctx.c).createCanvas());
113 * Create new Window and get ghost for it.
115 static naRef f_createWindow(const nasal::CallContext& ctx)
117 return NasalWindow::create
120 requireGUIMgr(ctx.c).createWindow( ctx.getArg<std::string>(0) )
125 * Get ghost for existing Canvas.
127 static naRef f_getCanvas(naContext c, naRef me, int argc, naRef* args)
129 nasal::CallContext ctx(c, argc, args);
130 SGPropertyNode& props = *ctx.requireArg<SGPropertyNode*>(0);
131 CanvasMgr& canvas_mgr = requireCanvasMgr(c);
133 sc::CanvasPtr canvas;
134 if( canvas_mgr.getPropertyRoot() == props.getParent() )
136 // get a canvas specified by its root node
137 canvas = canvas_mgr.getCanvas( props.getIndex() );
138 if( !canvas || canvas->getProps() != &props )
143 // get a canvas by name
144 if( props.hasValue("name") )
145 canvas = canvas_mgr.getCanvas( props.getStringValue("name") );
146 else if( props.hasValue("index") )
147 canvas = canvas_mgr.getCanvas( props.getIntValue("index") );
150 return NasalCanvas::create(c, canvas);
153 naRef f_canvasCreateGroup(sc::Canvas& canvas, const nasal::CallContext& ctx)
155 return NasalGroup::create
158 canvas.createGroup( ctx.getArg<std::string>(0) )
163 * Get group containing all gui windows
165 naRef f_getDesktop(naContext c, naRef me, int argc, naRef* args)
167 return NasalGroup::create(c, requireGUIMgr(c).getDesktop());
170 naRef f_groupCreateChild(sc::Group& group, const nasal::CallContext& ctx)
172 return NasalElement::create
175 group.createChild( ctx.requireArg<std::string>(0),
176 ctx.getArg<std::string>(1) )
180 naRef f_groupGetChild(sc::Group& group, const nasal::CallContext& ctx)
182 return NasalElement::create
185 group.getChild( ctx.requireArg<SGPropertyNode*>(0) )
189 naRef f_groupGetElementById(sc::Group& group, const nasal::CallContext& ctx)
191 return NasalElement::create
194 group.getElementById( ctx.requireArg<std::string>(0) )
199 naRef f_eventGetModifier(sc::MouseEvent& event, naContext)
201 return naNum((event.getModifiers() & Mask) != 0);
204 naRef to_nasal_helper(naContext c, const sc::ElementWeakPtr& el)
206 return NasalElement::create(c, el.lock());
209 naRef initNasalCanvas(naRef globals, naContext c)
211 using osgGA::GUIEventAdapter;
212 NasalEvent::init("canvas.Event")
213 .member("type", &sc::Event::getTypeString)
214 .member("target", &sc::Event::getTarget)
215 .member("currentTarget", &sc::Event::getCurrentTarget)
216 .method("stopPropagation", &sc::Event::stopPropagation);
217 NasalMouseEvent::init("canvas.MouseEvent")
219 .member("screenX", &sc::MouseEvent::getScreenX)
220 .member("screenY", &sc::MouseEvent::getScreenY)
221 .member("clientX", &sc::MouseEvent::getClientX)
222 .member("clientY", &sc::MouseEvent::getClientY)
223 .member("localX", &sc::MouseEvent::getLocalX)
224 .member("localY", &sc::MouseEvent::getLocalY)
225 .member("deltaX", &sc::MouseEvent::getDeltaX)
226 .member("deltaY", &sc::MouseEvent::getDeltaY)
227 .member("button", &sc::MouseEvent::getButton)
228 .member("buttons", &sc::MouseEvent::getButtonMask)
229 .member("modifiers", &sc::MouseEvent::getModifiers)
230 .member("ctrlKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_CTRL>)
231 .member("shiftKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_SHIFT>)
232 .member("altKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_ALT>)
233 .member("metaKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_META>)
234 .member("click_count", &sc::MouseEvent::getCurrentClickCount);
235 NasalCanvas::init("Canvas")
236 .member("_node_ghost", &elementGetNode<sc::Canvas>)
237 .member("size_x", &sc::Canvas::getSizeX)
238 .member("size_y", &sc::Canvas::getSizeY)
239 .method("_createGroup", &f_canvasCreateGroup)
240 .method("_getGroup", &sc::Canvas::getGroup)
241 .method("addEventListener", &sc::Canvas::addEventListener);
242 NasalElement::init("canvas.Element")
243 .member("_node_ghost", &elementGetNode<sc::Element>)
244 .method("_getParent", &sc::Element::getParent)
245 .method("addEventListener", &sc::Element::addEventListener)
246 .method("getBoundingBox", &sc::Element::getBoundingBox)
247 .method("getTightBoundingBox", &sc::Element::getTightBoundingBox);
248 NasalGroup::init("canvas.Group")
249 .bases<NasalElement>()
250 .method("_createChild", &f_groupCreateChild)
251 .method("_getChild", &f_groupGetChild)
252 .method("_getElementById", &f_groupGetElementById);
253 NasalText::init("canvas.Text")
254 .bases<NasalElement>()
255 .method("getNearestCursor", &sc::Text::getNearestCursor);
257 NasalWindow::init("canvas.Window")
258 .bases<NasalElement>()
259 .member("_node_ghost", &elementGetNode<sc::Window>)
260 .method("_getCanvasDecoration", &sc::Window::getCanvasDecoration);
262 nasal::Hash globals_module(globals, c),
263 canvas_module = globals_module.createHash("canvas");
265 canvas_module.set("_newCanvasGhost", f_createCanvas);
266 canvas_module.set("_newWindowGhost", f_createWindow);
267 canvas_module.set("_getCanvasGhost", f_getCanvas);
268 canvas_module.set("_getDesktopGhost", f_getDesktop);