solve issue #2167 (incomplete serialization of PosterizationFilter) #2170 (#2171)

* solve issue #2167 (incomplete serialization of PosterizationFilter)

* test PosterizationFilter serialization

jme3-effects/src/main/java/com/jme3/post/filters/PosterizationFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2021 jMonkeyEngine
+ * Copyright (c) 2009-2023 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -32,10 +32,15 @@
 package com.jme3.post.filters;
 
 import com.jme3.asset.AssetManager;
+import com.jme3.export.InputCapsule;
+import com.jme3.export.JmeExporter;
+import com.jme3.export.JmeImporter;
+import com.jme3.export.OutputCapsule;
 import com.jme3.material.Material;
 import com.jme3.post.Filter;
 import com.jme3.renderer.RenderManager;
 import com.jme3.renderer.ViewPort;
+import java.io.IOException;
 
 /**
  * A Post Processing filter to change colors appear with sharp edges as if the
@@ -158,4 +163,38 @@ public class PosterizationFilter extends Filter {
     public float getStrength() {
         return strength;
     }
-}
+
+    /**
+     * Load properties when the filter is de-serialized, for example when
+     * loading from a J3O file.
+     *
+     * @param importer the importer to use (not null)
+     * @throws IOException from the importer
+     */
+    @Override
+    public void read(JmeImporter importer) throws IOException {
+        super.read(importer);
+        InputCapsule capsule = importer.getCapsule(this);
+
+        this.gamma = capsule.readFloat("gamma", 0.6f);
+        this.numColors = capsule.readInt("numColors", 8);
+        this.strength = capsule.readFloat("strength", 1f);
+    }
+
+    /**
+     * Save properties when the filter is serialized, for example when saving to
+     * a J3O file.
+     *
+     * @param exporter the exporter to use (not null)
+     * @throws IOException from the exporter
+     */
+    @Override
+    public void write(JmeExporter exporter) throws IOException {
+        super.write(exporter);
+        OutputCapsule capsule = exporter.getCapsule(this);
+
+        capsule.write(gamma, "gamma", 0.6f);
+        capsule.write(numColors, "numColors", 8);
+        capsule.write(strength, "strength", 1f);
+    }
+}

jme3-effects/src/test/java/com/jme3/post/filters/PosterizationFilterTest.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2023 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.jme3.post.filters;
+
+import com.jme3.asset.AssetManager;
+import com.jme3.asset.DesktopAssetManager;
+import com.jme3.export.binary.BinaryExporter;
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ * Automated tests for the {@code PosterizationFilter} class.
+ *
+ * @author sgold
+ */
+public class PosterizationFilterTest {
+    /**
+     * Tests serialization and de-serialization of a
+     * {@code PosterizationFilter}. This test would've detected JME issue #2167,
+     * for instance.
+     */
+    @Test
+    public void testSaveAndLoad() {
+        PosterizationFilter filter = new PosterizationFilter();
+
+        // Verify the default parameter values:
+        verifyDefaults(filter);
+
+        // Set parameters to new values:
+        filter.setEnabled(false);
+        filter.setGamma(0.7f);
+        filter.setNumColors(4);
+        filter.setStrength(0.8f);
+
+        // Create a duplicate filter using serialization:
+        AssetManager assetManager = new DesktopAssetManager();
+        PosterizationFilter copy
+                = BinaryExporter.saveAndLoad(assetManager, filter);
+
+        // Verify the parameter values of the duplicate:
+        Assert.assertEquals(0.7f, copy.getGamma(), 0f);
+        Assert.assertEquals(4, copy.getNumColors(), 0f);
+        Assert.assertEquals(0.8f, copy.getStrength(), 0f);
+        Assert.assertFalse(copy.isEnabled());
+    }
+
+    /**
+     * Verify some default values of a newly instantiated
+     * {@code PosterizationFilter}.
+     *
+     * @param filter (not null, unaffected)
+     */
+    private void verifyDefaults(PosterizationFilter filter) {
+        Assert.assertEquals(0.6f, filter.getGamma(), 0f);
+        Assert.assertEquals(8, filter.getNumColors(), 0f);
+        Assert.assertEquals(1f, filter.getStrength(), 0f);
+        Assert.assertTrue(filter.isEnabled());
+    }
+}