[Pixelle-commit] SF.net SVN: pixelle: [91] trunk/pixelle/src/com/mebigfatguy/pixelle/ PixelleTransformer.java

[<dbr...@us...>]

Revision: 91
          http://pixelle.svn.sourceforge.net/pixelle/?rev=91&view=rev
Author:   dbrosius
Date:     2008-06-27 17:58:51 -0700 (Fri, 27 Jun 2008)

Log Message:
-----------
javadoc

Modified Paths:
--------------
    trunk/pixelle/src/com/mebigfatguy/pixelle/PixelleTransformer.java

Modified: trunk/pixelle/src/com/mebigfatguy/pixelle/PixelleTransformer.java
===================================================================
--- trunk/pixelle/src/com/mebigfatguy/pixelle/PixelleTransformer.java	2008-06-27 04:25:39 UTC (rev 90)
+++ trunk/pixelle/src/com/mebigfatguy/pixelle/PixelleTransformer.java	2008-06-28 00:58:51 UTC (rev 91)
@@ -34,16 +34,33 @@
 import com.mebigfatguy.pixelle.antlr.PixelleParser;
 import com.mebigfatguy.pixelle.eval.PixelleEval3ByteABGR;
 
+/**
+ * transforms one bitmap into another based on the algorithms defined by the user.
+ */
 public class PixelleTransformer {
 	
 	private PixelleImage srcImage;
 	private Map<PixelleComponent, String> algorithms = null;
 	
+	/**
+	 * constructions a transformer given a source bitmap and algorithms
+	 * @param image the source image
+	 * @param algos the algorithms for the color components
+	 */
 	public PixelleTransformer(PixelleImage image, Map<PixelleComponent, String> algos) {
 		srcImage = image;
 		algorithms = algos;
 	}
 	
+	/**
+	 * transforms the image into a destination image based on the algorithms supplied.
+	 * It does this by generating classes that implement the PixelleExpr interface, and 
+	 * dynamically loads them to create the new pixel values.
+	 * 
+	 * @return the destination bitmap
+	 * @throws PixelleTransformException if a failure occurs reading, writing or transforming
+	 * a bitmap
+	 */
 	public PixelleImage transform() throws PixelleTransformException {
 		
 		String currentComponent = "";


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.