update processing mode code with comments

hx2A · hx2A · commit 62d0b62d1fde · 2023-04-26T22:30:53.000-04:00
diff --git a/processing-mode/example1/example1.py b/processing-mode/example1/example1.py
@@ -15,7 +15,9 @@ def alter_image(msg: str, img: py5.Py5Image):
     return img
 
 
+# register processing mode keys so the Java `callPython()` method can find them
 py5_tools.register_processing_mode_key('test_transfer', alter_image)
 py5_tools.register_processing_mode_key('np', np)
 
+# run the sketch in processing mode, specifying the Java class to instantiate
 py5.run_sketch(jclassname='test.Example1Sketch')
diff --git a/processing-mode/example1/java/src/main/java/test/Example1Sketch.java b/processing-mode/example1/java/src/main/java/test/Example1Sketch.java
@@ -10,14 +10,14 @@ public void settings() {
   }
 
   public void setup() {
-    rectMode(CENTER);
-
     String msg = "Hello from Java!";
     PImage img = createImage(200, 200, RGB);
 
+    // call Python function `alter_image(msg, img)` and get back a PImage
     PImage imgResponse = (PImage) callPython("test_transfer", msg, img);
     image(imgResponse, 100, 100);
 
+    // call numpy `random.randint()` function
     long randomNumber = (long) callPython("np.random.randint", 0, 100);
     py5Println("JAVA: Random number from numpy: " + randomNumber);
   }
diff --git a/processing-mode/example2/example2.py b/processing-mode/example2/example2.py
@@ -38,6 +38,8 @@ def passImage(self, message, pimage):
             return JClass('java.lang.RuntimeException')(str(e))
 
 
+# register processing mode keys so the Java `callPython()` method can find them
 py5_tools.register_processing_mode_key('setup_test_interface', lambda: Test())
 
+# run the sketch in processing mode, specifying the Java class to instantiate
 py5.run_sketch(jclassname='test.Example2Sketch')
diff --git a/processing-mode/example2/java/src/main/java/test/Example2Sketch.java b/processing-mode/example2/java/src/main/java/test/Example2Sketch.java
@@ -12,17 +12,19 @@ public void settings() {
   }
 
   public void setup() {
-    rectMode(CENTER);
-
+    // call Python to obtain a Python object that implements the Java
+    // Interface `TestInterface`
     test = (TestInterface) callPython("setup_test_interface");
 
     String message = "Hello from Java!";
     PImage pimage = createImage(150, 150, RGB);
+
+    // make calls to Python through the Java interface `TestInterface`
     PImage imageResponse = test.passImage(message, pimage);
+
     if (imageResponse != null) {
       image(imageResponse, 100, 100);
     }
-
   }
 
   public void draw() {

Original file line number	Diff line number	Diff line change
`@@ -10,14 +10,14 @@ public void settings() {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`public void setup() {`
`13`		`- rectMode(CENTER);`
`14`		`-`
`15`	`13`	`String msg = "Hello from Java!";`
`16`	`14`	`PImage img = createImage(200, 200, RGB);`
`17`	`15`
	`16`	+ // call Python function `alter_image(msg, img)` and get back a PImage
`18`	`17`	`PImage imgResponse = (PImage) callPython("test_transfer", msg, img);`
`19`	`18`	`image(imgResponse, 100, 100);`
`20`	`19`
	`20`	+ // call numpy `random.randint()` function
`21`	`21`	`long randomNumber = (long) callPython("np.random.randint", 0, 100);`
`22`	`22`	`py5Println("JAVA: Random number from numpy: " + randomNumber);`
`23`	`23`	`}`