toxiclibs 0.4.0 → 0.8.0

data/src/toxi/geom/mesh/PLYWriter.java

@@ -0,0 +1,167 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * 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.geom.mesh;
+
+import java.io.BufferedOutputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import toxi.geom.Vec3D;
+import toxi.util.FileUtils;
+
+/**
+ * Standard Polygon Format (PLY) mesh exporter for toxiclibs
+ * {@link TriangleMesh} instances. Generates PLY binary format with optional
+ * vertex normal export.
+ */
+public class PLYWriter {
+
+    /**
+     *
+     */
+    protected static final Logger logger = Logger.getLogger(PLYWriter.class
+            .getSimpleName());
+
+    private final byte[] buf = new byte[4];
+
+    private boolean doWriteNormals;
+
+    /**
+     * Creates a little-endian version of the given float.
+     *
+     * @param f
+     * @return
+     */
+    private byte[] le(float f) {
+        return le(Float.floatToRawIntBits(f));
+    }
+
+    /**
+     * Creates a little-endian version of the given int.
+     *
+     * @param i
+     * @return
+     */
+    private byte[] le(int i) {
+        buf[3] = (byte) (i >>> 24);
+        buf[2] = (byte) (i >> 16 & 0xff);
+        buf[1] = (byte) (i >> 8 & 0xff);
+        buf[0] = (byte) (i & 0xff);
+        return buf;
+    }
+
+    /**
+     * Exports the given mesh to the specified {@link OutputStream}, including
+     * required header information. The mesh data itself is stored in binary.
+     * The output stream itself will be wrapped in a buffered version (128KB) in
+     * order to improve write performance.
+     *
+     * @param mesh mesh instance to export
+     * @param stream valid output stream
+     */
+    public void saveMesh(TriangleMesh mesh, OutputStream stream) {
+        try {
+            try (BufferedOutputStream out = new BufferedOutputStream(stream, 0x20000)) {
+                out.write("ply\n".getBytes());
+                out.write("format binary_little_endian 1.0\n".getBytes());
+                out.write(("element vertex " + mesh.getNumVertices() + "\n")
+                        .getBytes());
+                out.write("property float x\n".getBytes());
+                out.write("property float y\n".getBytes());
+                out.write("property float z\n".getBytes());
+                if (doWriteNormals) {
+                    out.write("property float nx\n".getBytes());
+                    out.write("property float ny\n".getBytes());
+                    out.write("property float nz\n".getBytes());
+                }
+                out.write(("element face " + mesh.getNumFaces() + "\n").getBytes());
+                out.write("property list uchar uint vertex_indices\n".getBytes());
+                out.write("end_header\n".getBytes());
+                Vec3D[] verts = new Vec3D[mesh.getNumVertices()];
+                float[] normals = mesh.getNormalsForUniqueVerticesAsArray();
+                int i = 0, j = 0;
+                for (Vec3D v : mesh.getVertices()) {
+                    verts[i++] = v;
+                }
+                for (i = 0, j = 0; i < verts.length; i++, j += 3) {
+                    Vec3D v = verts[i];
+                    out.write(le(v.x));
+                    out.write(le(v.z));
+                    out.write(le(v.y));
+                    if (doWriteNormals) {
+                        out.write(le(normals[j]));
+                        out.write(le(normals[j + 2]));
+                        out.write(le(-normals[j + 1]));
+                    }
+                }
+                for (Face f : mesh.getFaces()) {
+                    out.write((byte) 3);
+                    out.write(le(f.a.id));
+                    out.write(le(f.b.id));
+                    out.write(le(f.c.id));
+                }
+                out.flush();
+            }
+            logger.log(Level.INFO, "{0} faces written", mesh.getNumFaces());
+        } catch (IOException e) {
+            logger.log(Level.SEVERE, "error exporting mesh", e);
+        }
+    }
+
+    /**
+     * Exports the given mesh to the specified file path, including required
+     * header information. The mesh data itself is stored in binary.
+     *
+     * @param mesh mesh instance to export
+     * @param path file path
+     */
+    public void saveMesh(TriangleMesh mesh, String path) {
+        try {
+            saveMesh(mesh, FileUtils.createOutputStream(new File(path)));
+        } catch (IOException e) {
+            logger.log(Level.SEVERE, "error exporting mesh", e);
+        }
+    }
+
+    /**
+     * @return true, if normal export is enabled.
+     */
+    public boolean writeNormals() {
+        return doWriteNormals;
+    }
+
+    /**
+     * Setter enable export of vertex normals (false by default).
+     *
+     * @param doWriteNormals true to enable
+     */
+    public void writeNormals(boolean doWriteNormals) {
+        this.doWriteNormals = doWriteNormals;
+    }
+}

data/src/toxi/geom/mesh/PlaneSelector.java

@@ -0,0 +1,90 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * 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.geom.mesh;
+
+import toxi.geom.Plane;
+import toxi.geom.Plane.Classifier;
+
+/**
+ * A {@link VertexSelector} implementation for selecting vertices in relation to
+ * a given {@link Plane}. Using a plane {@link Classifier} vertices can be
+ * selected either: on the plane, in front or behind. A tolerance for this check
+ * can be given too.
+ * 
+ */
+public class PlaneSelector extends VertexSelector {
+
+    /**
+     *
+     */
+    public Plane plane;
+
+    /**
+     *
+     */
+    public float tolerance;
+
+    /**
+     *
+     */
+    public Classifier classifier;
+
+    /**
+     *
+     * @param mesh
+     * @param plane
+     * @param classifier
+     */
+    public PlaneSelector(Mesh3D mesh, Plane plane, Plane.Classifier classifier) {
+        this(mesh, plane, classifier, 0.0001f);
+    }
+
+    /**
+     *
+     * @param mesh
+     * @param plane
+     * @param classifier
+     * @param tolerance
+     */
+    public PlaneSelector(Mesh3D mesh, Plane plane, Plane.Classifier classifier,
+            float tolerance) {
+        super(mesh);
+        this.plane = plane;
+        this.classifier = classifier;
+        this.tolerance = tolerance;
+    }
+
+    @Override
+    public VertexSelector selectVertices() {
+        clearSelection();
+        mesh.getVertices().stream().filter((v) -> (plane.classifyPoint(v, tolerance) == classifier)).forEach((v) -> {
+            selection.add(v);
+        });
+        return this;
+    }
+}

data/src/toxi/geom/mesh/STLColorModel.java

@@ -0,0 +1,54 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * 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.geom.mesh;
+
+/**
+ *
+ * @author tux
+ */
+public interface STLColorModel {
+
+    /**
+     *
+     * @param header
+     */
+    void formatHeader(byte[] header);
+
+    /**
+     *
+     * @param rgb
+     * @return
+     */
+    int formatRGB(int rgb);
+
+    /**
+     *
+     * @return
+     */
+    int getDefaultRGB();
+}

data/src/toxi/geom/mesh/STLReader.java

@@ -0,0 +1,185 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * 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.geom.mesh;
+
+import java.io.BufferedInputStream;
+import java.io.DataInputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import toxi.geom.Vec3D;
+import toxi.util.FileUtils;
+
+/**
+ * Utility class to read binary STL files and turn them into
+ * {@link TriangleMesh} instances.
+ */
+public class STLReader {
+
+    /**
+     *
+     */
+    public static final Class<? extends Mesh3D> TRIANGLEMESH = TriangleMesh.class;
+
+    /**
+     *
+     */
+    public static final Class<? extends Mesh3D> WEMESH = WETriangleMesh.class;
+
+    private static final int DEFAULT_BUFFER_SIZE = 0x8000;
+
+    private final byte[] buf = new byte[12];
+
+    private float bufferToFloat() {
+        return Float.intBitsToFloat(bufferToInt());
+    }
+
+    private int bufferToInt() {
+        return byteToInt(buf[0]) | (byteToInt(buf[1]) << 8)
+                | (byteToInt(buf[2]) << 16) | (byteToInt(buf[3]) << 24);
+    }
+
+    private int byteToInt(byte b) {
+        return (b < 0 ? 256 + b : b);
+    }
+
+    /**
+     * Attempts to load an STL model from the given {@link InputStream}.
+     * Currently no exceptions are being thrown and the method will return null
+     * if anything goes wrong during parsing the mesh data.
+     * 
+     * @param stream
+     * @param meshName
+     * @param meshClass
+     * @return mesh instance or null if unsuccessful
+     */
+    public Mesh3D loadBinary(InputStream stream, String meshName,
+            Class<? extends Mesh3D> meshClass) {
+        return loadBinary(stream, meshName, DEFAULT_BUFFER_SIZE, meshClass);
+    }
+
+    /**
+     * Attempts to load an STL model from the given {@link InputStream}.
+     * Currently no exceptions are being thrown and the method will return null
+     * if anything goes wrong during parsing the mesh data.
+     * 
+     * @param stream
+     * @param meshName
+     * @param bufSize
+     *            size of the stream buffer
+     * @param meshClass
+     * @return mesh instance or null if unsuccessful
+     */
+    public Mesh3D loadBinary(InputStream stream, String meshName, int bufSize,
+            Class<? extends Mesh3D> meshClass) {
+        Mesh3D mesh = null;
+        try {
+            DataInputStream ds = new DataInputStream(new BufferedInputStream(
+                    stream, bufSize));
+            // read header, ignore color model
+            for (int i = 0; i < 80; i++) {
+                ds.read();
+            }
+            // read num faces
+            ds.read(buf, 0, 4);
+            int numFaces = bufferToInt();
+            mesh = meshClass.newInstance();
+            mesh.init(meshName, numFaces, numFaces);
+            Vec3D a = new Vec3D();
+            Vec3D b = new Vec3D();
+            Vec3D c = new Vec3D();
+            for (int i = 0; i < numFaces; i++) {
+                // ignore face normal
+                ds.read(buf, 0, 12);
+                // face vertices
+                readVector(ds, a);
+                readVector(ds, b);
+                readVector(ds, c);
+                mesh.addFace(a, c, b);
+                // ignore colour
+                ds.read(buf, 0, 2);
+            }
+            mesh.computeVertexNormals();
+        } catch (IOException | InstantiationException | IllegalAccessException e) {
+            Logger.getLogger(STLReader.class.getName()).log(Level.SEVERE, null, e);
+        }
+        return mesh;
+    }
+
+    /**
+     *
+     * @param fileName
+     * @param meshClass
+     * @return
+     */
+    public Mesh3D loadBinary(String fileName, Class<? extends Mesh3D> meshClass) {
+        return loadBinary(fileName, DEFAULT_BUFFER_SIZE, meshClass);
+    }
+
+    /**
+     * Attempts to load an STL model from the given file path. Currently no
+     * exceptions are being thrown and the method will return null if anything
+     * goes wrong during parsing the mesh data.
+     * 
+     * @param fileName
+     *            file path to read model from
+     * @param bufSize
+     * @param meshClass
+     * @return mesh instance or null if unsuccessful
+     */
+    public Mesh3D loadBinary(String fileName, int bufSize,
+            Class<? extends Mesh3D> meshClass) {
+        Mesh3D mesh = null;
+        try {
+            mesh = loadBinary(FileUtils.createInputStream(new File(fileName)),
+                    fileName.substring(fileName.lastIndexOf('/') + 1), bufSize,
+                    meshClass);
+        } catch (IOException ex) {
+            Logger.getLogger(STLReader.class.getName()).log(Level.SEVERE, null, ex);
+        }
+
+        return mesh;
+    }
+
+    private Vec3D readVector(DataInputStream ds, Vec3D result)
+            throws IOException {
+        // x
+        ds.read(buf, 0, 4);
+        result.x = bufferToFloat();
+        // y
+        ds.read(buf, 0, 4);
+        result.y = bufferToFloat();
+        // z
+        ds.read(buf, 0, 4);
+        result.z = bufferToFloat();
+        return result;
+    }
+}