|
6 | 6 |
|
7 | 7 |
|
8 | 8 | class ThreeWidget(Widget):
|
| 9 | + """Base widget type for all pythreejs widgets""" |
| 10 | + |
9 | 11 | _model_module = Unicode(npm_pkg_name).tag(sync=True)
|
10 | 12 | _model_module_version = Unicode(EXTENSION_VERSION).tag(sync=True)
|
11 | 13 |
|
12 | 14 | def __init__(self, **kwargs):
|
13 | 15 | super(ThreeWidget, self).__init__(**kwargs)
|
14 |
| - self.on_msg(self.on_potential_ret_val) |
| 16 | + self.on_msg(self._on_potential_ret_val) |
15 | 17 |
|
16 | 18 | def exec_three_obj_method(self, method_name, *args, **kwargs):
|
| 19 | + """Execute a method on the three object. |
| 20 | +
|
| 21 | + Excute the method specified by `method_name` on the three |
| 22 | + object, with arguments `args`. `kwargs` is currently ignored. |
| 23 | + """ |
17 | 24 | content = {
|
18 | 25 | "type": "exec_three_obj_method",
|
19 | 26 | "method_name": method_name,
|
20 | 27 | "args": widget_serialization['to_json'](args, None)
|
21 | 28 | }
|
22 | 29 | self.send(content=content, buffers=None)
|
23 | 30 |
|
24 |
| - def on_potential_ret_val(self, widget, content, buffers): |
| 31 | + def _on_potential_ret_val(self, widget, content, buffers): |
| 32 | + """Message callback used internally""" |
25 | 33 | if content['type'] == "exec_three_obj_method_retval":
|
26 |
| - self.on_ret_val(content['method_name'], content['ret_val']) |
| 34 | + self._on_ret_val(content['method_name'], content['ret_val']) |
27 | 35 |
|
28 |
| - def on_ret_val(self, method_name, ret_val): |
| 36 | + def _on_ret_val(self, method_name, ret_val): |
| 37 | + """Message callback used internally for logging exec returns""" |
29 | 38 | self.log.info('%s() -> %s' % (method_name, ret_val))
|
30 | 39 |
|
31 | 40 | def _ipython_display_(self, **kwargs):
|
|
0 commit comments