toxiclibs 0.4.0 → 0.8.0

data/src/toxi/color/ProximityComparator.java

@@ -0,0 +1,70 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.color;
+
+import java.util.Comparator;
+
+/**
+ * Compares two colors by their distance to the given target color.
+ */
+public class ProximityComparator implements Comparator<ReadonlyTColor> {
+
+    /**
+     *
+     */
+    protected ReadonlyTColor col;
+
+    /**
+     *
+     */
+    protected DistanceProxy proxy;
+
+    /**
+     *
+     * @param col
+     * @param proxy
+     */
+    public ProximityComparator(ReadonlyTColor col, DistanceProxy proxy) {
+        this.col = col;
+        this.proxy = proxy;
+    }
+
+    /**
+     *
+     * @param a
+     * @param b
+     * @return
+     */
+    @Override
+    public int compare(ReadonlyTColor a, ReadonlyTColor b) {
+        float da = proxy.distanceBetween(col, a);
+        float db = proxy.distanceBetween(col, b);
+        return da < db ? -1 : da > db ? 1 : 0;
+    }
+
+}

data/src/toxi/color/RGBAccessor.java

@@ -0,0 +1,113 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.color;
+
+/**
+ * Compares 2 colors by one of their RGB component values.
+ */
+public class RGBAccessor extends AccessCriteria {
+
+    private final int component;
+
+    /**
+     *
+     * @param comp
+     */
+    public RGBAccessor(int comp) {
+        component = comp;
+    }
+
+    /**
+     *
+     * @param a
+     * @param b
+     * @return
+     */
+    @Override
+    public int compare(ReadonlyTColor a, ReadonlyTColor b) {
+        float ca, cb;
+        switch (component) {
+            case 0:
+                ca = a.red();
+                cb = b.red();
+                break;
+            case 1:
+                ca = a.green();
+                cb = b.green();
+                break;
+            case 2:
+            default:
+                ca = a.blue();
+                cb = b.blue();
+        }
+        return Float.compare(ca, cb);
+    }
+
+    /**
+     *
+     * @param col
+     * @return
+     */
+    @Override
+    public float getComponentValueFor(ReadonlyTColor col) {
+        float comp;
+        switch (component) {
+            case 0:
+                comp = col.red();
+                break;
+            case 1:
+                comp = col.green();
+                break;
+            case 2:
+            default:
+                comp = col.blue();
+        }
+        return comp;
+    }
+
+    /**
+     *
+     * @param col
+     * @param val
+     */
+    @Override
+    public void setComponentValueFor(TColor col, float val) {
+        switch (component) {
+            case 0:
+                col.setRed(val);
+                break;
+            case 1:
+                col.setGreen(val);
+                break;
+            case 2:
+            default:
+                col.setBlue(val);
+        }
+    }
+
+}

data/src/toxi/color/RGBDistanceProxy.java

@@ -0,0 +1,41 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.color;
+
+/**
+ * Implements the {@link DistanceProxy} interface to sort colors by RGB distance
+ * (used by {@link ColorList#sortByDistance(DistanceProxy, boolean)}).
+ */
+public class RGBDistanceProxy implements DistanceProxy {
+
+    @Override
+    public float distanceBetween(ReadonlyTColor a, ReadonlyTColor b) {
+        return a.distanceToRGB(b);
+    }
+
+}

data/src/toxi/color/ReadonlyTColor.java

@@ -0,0 +1,296 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.color;
+
+/**
+ * Defines an immutable API for the TColor class. This is used to define the
+ * preset color constants in {@link NamedColor}, but also throughout other parts
+ * of this package wherever immutable behaviour is required or encouraged.
+ */
+public interface ReadonlyTColor {
+
+    /**
+     * @return the color's alpha component
+     */
+    public float alpha();
+
+    /**
+     * @return the color's black component
+     */
+    public float black();
+
+    /**
+     * @return the color's blue component
+     */
+    public float blue();
+
+    /**
+     * @return color HSV brightness (not luminance!)
+     */
+    public float brightness();
+
+    /**
+     * @return a mutable copy of the current color
+     */
+    public TColor copy();
+
+    /**
+     * @return the color's cyan component
+     */
+    public float cyan();
+
+    /**
+     * Calculates the CMYK distance to the given color.
+     * 
+     * @param c
+     *            target color
+     * @return distance
+     */
+    public float distanceToCMYK(ReadonlyTColor c);
+
+    /**
+     * Calculates the HSV distance to the given color.
+     * 
+     * @param c
+     *            target color
+     * @return distance
+     */
+    public float distanceToHSV(ReadonlyTColor c);
+
+    /**
+     * Calculates the RGB distance to the given color.
+     * 
+     * @param c
+     *            target color
+     * @return distance
+     */
+    public float distanceToRGB(ReadonlyTColor c);
+
+    /**
+     *
+     * @param theta
+     * @param delta
+     * @return
+     */
+    public TColor getAnalog(float theta, float delta);
+
+    /**
+     *
+     * @param angle
+     * @param delta
+     * @return
+     */
+    public TColor getAnalog(int angle, float delta);
+
+    /**
+     *
+     * @param c
+     * @param t
+     * @return
+     */
+    public TColor getBlended(ReadonlyTColor c, float t);
+
+    /**
+     * @return an instance of the closest named hue to this color.
+     */
+    public Hue getClosestHue();
+
+    /**
+     * @param primaryOnly
+     *            if true, only primary color hues are considered
+     * @return an instance of the closest named (primary) hue to this color.
+     */
+    public Hue getClosestHue(boolean primaryOnly);
+
+    /**
+     *
+     * @return
+     */
+    public TColor getComplement();
+
+    /**
+     *
+     * @param criteria
+     * @return
+     */
+    public float getComponentValue(AccessCriteria criteria);
+
+    /**
+     * @param step
+     * @return a darkened copy
+     */
+    public TColor getDarkened(float step);
+
+    /**
+     * @param step
+     * @return a desaturated copy
+     */
+    public TColor getDesaturated(float step);
+
+    /**
+     * @return an inverted copy
+     */
+    public TColor getInverted();
+
+    /**
+     * @param step
+     * @return a lightened copy
+     */
+    public TColor getLightened(float step);
+
+    /**
+     * @param theta
+     *            rotation angle in radians
+     * @return a RYB rotated copy
+     */
+    public TColor getRotatedRYB(float theta);
+
+    /**
+     * @param angle
+     *            rotation angle in degrees
+     * @return a RYB rotated copy
+     */
+    public TColor getRotatedRYB(int angle);
+
+    /**
+     * @param step
+     * @return a saturated copy
+     */
+    public TColor getSaturated(float step);
+
+    /**
+     * @return the color's green component
+     */
+
+    public float green();
+
+    /**
+     * @return the color's hue
+     */
+    public float hue();
+
+    /**
+     * @return true, if all rgb component values are equal and less than
+     *         {@link TColor#BLACK_POINT}
+     */
+    public boolean isBlack();
+
+    /**
+     * @return true, if the saturation component value is less than
+     *         {@link TColor#GREY_THRESHOLD}
+     */
+    public boolean isGrey();
+
+    /**
+     * @return true, if this colors hue is matching one of the 7 defined primary
+     *         hues.
+     */
+    public boolean isPrimary();
+
+    /**
+     * @return true, if all rgb component values are equal and greater than
+     *         {@link TColor#WHITE_POINT}
+     */
+    public boolean isWhite();
+
+    /**
+     * Computes the color's luminance using this formula: lum=0.299*red +
+     * 0.587*green + 0.114 *blue
+     * 
+     * @return luminance
+     */
+    public float luminance();
+
+    /**
+     * @return the color's magenta component
+     */
+
+    public float magenta();
+
+    /**
+     * @return the color's red component
+     */
+    public float red();
+
+    /**
+     * @return the color's saturation
+     */
+    public float saturation();
+
+    /**
+     * Converts the color into a packed ARGB int.
+     * 
+     * @return color as int
+     */
+    public int toARGB();
+
+    /**
+     * Copies the current CMYKA values into the given array (or constucts a new
+     * one with these values).
+     * 
+     * @param cmyka
+     *            result array (or null)
+     * @return array in this order: c,m,y,k,a
+     */
+    public float[] toCMYKAArray(float[] cmyka);
+
+    /**
+     * @return Copies the the current HSV values into the given array (or
+     *         constucts a new one with these values).
+     * @param hsva
+     *            result array (or null)
+     */
+    public float[] toHSVAArray(float[] hsva);
+
+    /**
+     * Copies the current RGBA value into the given array (or constucts a new
+     * one with these values).
+     * 
+     * @param rgba
+     *            result array (or null)
+     * @return array in this order: r,g,b,a (OpenGL format)
+     */
+    public float[] toRGBAArray(float[] rgba);
+
+    /**
+     * Copies the current RGBA value into the given array starting the given
+     * offset. If the array is null, the method constucts a new one with these
+     * values and the offset value is ignored (set to zero).
+     * 
+     * @param rgba
+     * @param offset
+     * @return float array
+     */
+    public float[] toRGBAArray(float[] rgba, int offset);
+
+    /**
+     * @return the color's yellow component
+     */
+    public float yellow();
+
+}