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 <Main/globals.hxx>
28 #include <Scripting/NasalSys.hxx>
30 #include <osgGA/GUIEventAdapter>
32 #include <simgear/sg_inlines.h>
34 #include <simgear/canvas/Canvas.hxx>
35 #include <simgear/canvas/elements/CanvasElement.hxx>
36 #include <simgear/canvas/elements/CanvasText.hxx>
37 #include <simgear/canvas/MouseEvent.hxx>
39 #include <simgear/nasal/cppbind/from_nasal.hxx>
40 #include <simgear/nasal/cppbind/to_nasal.hxx>
41 #include <simgear/nasal/cppbind/NasalHash.hxx>
42 #include <simgear/nasal/cppbind/Ghost.hxx>
44 extern naRef propNodeGhostCreate(naContext c, SGPropertyNode* n);
46 namespace sc = simgear::canvas;
48 template<class Element>
49 naRef elementGetNode(naContext c, Element& element)
51 return propNodeGhostCreate(c, element.getProps());
54 typedef nasal::Ghost<sc::EventPtr> NasalEvent;
55 typedef nasal::Ghost<sc::MouseEventPtr> NasalMouseEvent;
56 typedef nasal::Ghost<sc::CanvasPtr> NasalCanvas;
57 typedef nasal::Ghost<sc::ElementPtr> NasalElement;
58 typedef nasal::Ghost<sc::GroupPtr> NasalGroup;
59 typedef nasal::Ghost<sc::TextPtr> NasalText;
61 SGPropertyNode* from_nasal_helper(naContext c, naRef ref, SGPropertyNode**)
63 SGPropertyNode* props = ghostToPropNode(ref);
65 naRuntimeError(c, "Not a SGPropertyNode ghost.");
70 CanvasMgr& requireCanvasMgr(naContext c)
72 CanvasMgr* canvas_mgr =
73 static_cast<CanvasMgr*>(globals->get_subsystem("Canvas"));
75 naRuntimeError(c, "Failed to get Canvas subsystem");
81 * Create new Canvas and get ghost for it.
83 static naRef f_createCanvas(naContext c, naRef me, int argc, naRef* args)
85 return NasalCanvas::create(c, requireCanvasMgr(c).createCanvas());
89 * Get ghost for existing Canvas.
91 static naRef f_getCanvas(naContext c, naRef me, int argc, naRef* args)
93 nasal::CallContext ctx(c, argc, args);
94 SGPropertyNode& props = *ctx.requireArg<SGPropertyNode*>(0);
95 CanvasMgr& canvas_mgr = requireCanvasMgr(c);
98 if( canvas_mgr.getPropertyRoot() == props.getParent() )
100 // get a canvas specified by its root node
101 canvas = canvas_mgr.getCanvas( props.getIndex() );
102 if( !canvas || canvas->getProps() != &props )
107 // get a canvas by name
108 if( props.hasValue("name") )
109 canvas = canvas_mgr.getCanvas( props.getStringValue("name") );
110 else if( props.hasValue("index") )
111 canvas = canvas_mgr.getCanvas( props.getIntValue("index") );
114 return NasalCanvas::create(c, canvas);
117 naRef f_canvasCreateGroup(sc::Canvas& canvas, const nasal::CallContext& ctx)
119 return NasalGroup::create
122 canvas.createGroup( ctx.getArg<std::string>(0) )
126 naRef f_elementGetTransformedBounds(sc::Element& el, const nasal::CallContext& ctx)
128 osg::BoundingBox bb = el.getTransformedBounds( osg::Matrix::identity() );
130 std::vector<float> bb_vec(4);
131 bb_vec[0] = bb._min.x();
132 bb_vec[1] = bb._min.y();
133 bb_vec[2] = bb._max.x();
134 bb_vec[3] = bb._max.y();
136 return nasal::to_nasal(ctx.c, bb_vec);
139 naRef f_groupCreateChild(sc::Group& group, const nasal::CallContext& ctx)
141 return NasalElement::create
144 group.createChild( ctx.requireArg<std::string>(0),
145 ctx.getArg<std::string>(1) )
149 naRef f_groupGetChild(sc::Group& group, const nasal::CallContext& ctx)
151 return NasalElement::create
154 group.getChild( ctx.requireArg<SGPropertyNode*>(0) )
158 naRef f_groupGetElementById(sc::Group& group, const nasal::CallContext& ctx)
160 return NasalElement::create
163 group.getElementById( ctx.requireArg<std::string>(0) )
167 naRef f_textGetNearestCursor(sc::Text& text, const nasal::CallContext& ctx)
169 return nasal::to_nasal
172 text.getNearestCursor( ctx.requireArg<osg::Vec2>(0) )
176 naRef f_eventGetTarget(naContext c, sc::Event& event)
178 return NasalElement::create(c, event.getTarget().lock());
181 // TODO allow directly exposing functions without parameters and return type
182 naRef f_eventStopPropagation(sc::Event& event, const nasal::CallContext& ctx)
185 naRuntimeError(ctx.c, "Event::stopPropagation no argument expected");
186 event.stopPropagation();
190 naRef initNasalCanvas(naRef globals, naContext c, naRef gcSave)
192 NasalEvent::init("canvas.Event")
193 .member("type", &sc::Event::getTypeString)
194 .member("target", &f_eventGetTarget)
195 .method_func<&f_eventStopPropagation>("stopPropagation");
196 NasalMouseEvent::init("canvas.MouseEvent")
198 .member("screenX", &sc::MouseEvent::getScreenX)
199 .member("screenY", &sc::MouseEvent::getScreenY)
200 .member("clientX", &sc::MouseEvent::getClientX)
201 .member("clientY", &sc::MouseEvent::getClientY)
202 .member("deltaX", &sc::MouseEvent::getDeltaX)
203 .member("deltaY", &sc::MouseEvent::getDeltaY)
204 .member("click_count", &sc::MouseEvent::getCurrentClickCount);
205 NasalCanvas::init("Canvas")
206 .member("_node_ghost", &elementGetNode<sc::Canvas>)
207 .member("size_x", &sc::Canvas::getSizeX)
208 .member("size_y", &sc::Canvas::getSizeY)
209 .method_func<&f_canvasCreateGroup>("_createGroup")
210 .method<&sc::Canvas::addEventListener>("addEventListener");
211 NasalElement::init("canvas.Element")
212 .member("_node_ghost", &elementGetNode<sc::Element>)
213 .method<&sc::Element::addEventListener>("addEventListener")
214 .method_func<&f_elementGetTransformedBounds>("getTransformedBounds");
215 NasalGroup::init("canvas.Group")
216 .bases<NasalElement>()
217 .method_func<&f_groupCreateChild>("_createChild")
218 .method_func<&f_groupGetChild>("_getChild")
219 .method_func<&f_groupGetElementById>("_getElementById");
220 NasalText::init("canvas.Text")
221 .bases<NasalElement>()
222 .method_func<&f_textGetNearestCursor>("getNearestCursor");
224 nasal::Hash globals_module(globals, c),
225 canvas_module = globals_module.createHash("canvas");
227 canvas_module.set("_newCanvasGhost", f_createCanvas);
228 canvas_module.set("_getCanvasGhost", f_getCanvas);