Creating a GenGIS plugin - Revision history

Dparks at 00:31, 4 March 2012

2012-03-04T00:31:25Z

Dparks: /* Writing the Plugin */

2012-03-04T00:25:03Z

Writing the Plugin

Dparks: /* Specifying Plugin Details */

2012-03-04T00:24:32Z

Specifying Plugin Details

Dparks: /* Specifying Plugin Details */

2012-03-04T00:24:00Z

Specifying Plugin Details

Dparks: /* Writing the Plugin */

2012-03-04T00:17:44Z

Writing the Plugin

Dparks at 00:16, 4 March 2012

2012-03-04T00:16:19Z

Dparks: /* Required Files */

2012-03-04T00:06:09Z

Required Files

Dparks: /* Required Files */

2012-03-04T00:05:11Z

Required Files

Dparks: /* Required Files */

2012-03-04T00:03:42Z

Required Files

Dparks: New page: The functionality of GenGIS can be extended by writing a Python plugin. Python plugins reside in the ''plugins'' folder within your GenGIS directory. In this tutorial we will create a simp...

2012-03-04T00:03:29Z

New page: The functionality of GenGIS can be extended by writing a Python plugin. Python plugins reside in the ''plugins'' folder within your GenGIS directory. In this tutorial we will create a simp...

New page

The functionality of GenGIS can be extended by writing a Python plugin. Python plugins reside in the ''plugins'' folder within your GenGIS directory. In this tutorial we will create a simple "Hello World" plugin which writes a simple greeting to the GenGIS viewport.

= Required Files =

Begin by creating the directory ''HelloWorld'' within the GenGIS ''plugins' directory. Within this directory create a file called ''__init__.py''. This file contains general information about your plugin which is used by GenGIS to load the plugin. For our Hello World plugin, enter the following into ''__init__.py'':

def name():
return "Hello World"

def version():
return "Version 1.0"

def description():
return "Prints Hello World to the Viewport."

def authors():
return "Donovan Parks"

def publicationDate():
return "March 1, 2012"

def minimumVersionOfGenGIS():
return "2.0"

def requireR():
return False

@@ Line 46: / Line 46: @@
 Further information about the GenGIS API can be found in the [[The GenGIS Manual | GenGIS manual]]. We also recommend consulting existing plugins in order to see how they function and make use of the GenGIS API.
 = Releasing a Plugin =
 We encourage you to make your plugins available to other GenGIS users. If you wish to have your plugin made available on the GenGIS website please contact Rob Beiko (beiko@cs.dal.ca).

← Older revision		Revision as of 00:25, 4 March 2012
Line 35:		Line 35:

	<pre>		<pre>
		+	import GenGIS

		+	class HelloWorld():
		+	def __init__(self, parent=None):
		+	label = GenGIS.VisualLabel("Hello World!", GenGIS.Colour(0,0,0), 36, GenGIS.LABEL_RENDERING_STYLE.ORTHO)
		+	label.SetScreenPosition(GenGIS.Point3D(10,40,1))
		+	GenGIS.graphics.AddLabel(label)
		+	GenGIS.viewport.Refresh()
	</pre>		</pre>

@@ Line 38: / Line 38: @@
 </pre>
-Further information about the GenGIS API can be found in the [[The GenGIS Manual | GenGIS manual]] and any of the existing plugins examined in order to see how they function.
+Further information about the GenGIS API can be found in the [[The GenGIS Manual | GenGIS manual]]. We also recommend consulting existing plugins in order to see how they function and make use of the GenGIS API.
 = Releasing a Plugin =
 We encourage you to make your plugins available to other GenGIS users. If you wish to have your plugin made available on the GenGIS website please contact Rob Beiko (beiko@cs.dal.ca).

@@ Line 8: / Line 8: @@
 def name():
    return "Hello World"
-−
 def version():
    return "Version 1.0"
-  def description():
+def description():
-    return "Prints Hello World to the Viewport."
+  return "Prints Hello World to the Viewport."
-−
-  def authors():
+def authors():
-    return "Donovan Parks"
+  return "Donovan Parks"
-  def publicationDate():
+def publicationDate():
-    return "March 1, 2012"
+  return "March 1, 2012"
-  def minimumVersionOfGenGIS():
+def minimumVersionOfGenGIS():
-    return "2.0"
+  return "2.0"
-  def requireR():
+def requireR():
-    return False
+  return False
 </pre>

@@ Line 1: / Line 1: @@
 The functionality of GenGIS can be extended by writing a Python plugin. Python plugins reside in the ''plugins'' folder within your GenGIS directory. In this tutorial we will create a simple "Hello World" plugin which writes a simple greeting to the GenGIS viewport.
-= Required Files =
+= Specifying Plugin Details =
-Begin by creating the directory ''HelloWorld'' within the GenGIS ''plugins' directory. Within this directory create a file called ''__init__.py''. This file contains general information about your plugin which is used by GenGIS to load the plugin. For our Hello World plugin, enter the following into ''__init__.py'':
+Begin by creating the directory ''HelloWorld'' within the GenGIS ''plugins' directory. Within this directory create a file called ''__init__.py''. This file contains general information about your plugin which is used by GenGIS. For our Hello World plugin, enter the following into ''__init__.py'':
 <pre>
@@ Line 27: / Line 27: @@
      return False
 </pre>