Changes between Version 75 and Version 76 of DevelopGuide

Timestamp:

Mar 31, 2009, 2:33:58 PM (17 years ago)

Author:

Frédéric

Comment:

--

DevelopGuide

@@ -10 +10 @@
   * [#Model Model]
   * [#View View]
+  * [#Plugins Plugins]
  * [#OutputXMLfile Output XML file]
  * [#Distributing Distributing]
@@ -100 +101 @@
 === View ===
 
+=== Plugins ===
+
+Hello Jones,
+
+You seems to be familiar with programing. So, I will explain you the way to develop plugins for Papywizard. First, I suggest you use the svn repository:
+
+    svn co http://svn.gbiloba.org/papywizard/trunk papywizard
+
+Plugins implements one or more 'capacity'. Possible capacities are:
+
+ * ''yawAxis''
+ * ''pitchAxis''
+ * ''shutter''
+
+The first two are responsible of yaw/pitch axis; the last is responsible of triggering the camera shutter.
+
+A plugin needs to implement 2 classes (for each implemented capacity): one for the model (real work), and one for the controller (configuration dialog).
+
+All model classes inherit from the AbstractPlugin class (defined in the papywizard/common/ package).
+
+Then, plugins implementing 'yawAxis' and 'pitchAxis' capacities can inherit from AbstractAxisPlugin, and plugins implementing the 'shutter' capacity can inherits from AbstractShutterPlugin (defined in the papywizard/hardware/ package).
+
+
+
+Controller classes inherits from AbstractPluginController class (defined in the papywizard/controller/ package). This abstract class inherits from other classes, which are responsible to load the .ui GUI defining file.
+
+_defineGui()
+
+Last, a plugin has to implement a register() function, which will be called at startup to register the plugin in Papywizard.
+
+In you case, you need to implement the 'shutter' capacity.
+
+Have a look at the default plugins, in the papywizard/plugins/ package to see concrete examples.
+
+
+-- 
+    Frédéric
+
 == Output XML file  ==