/*
 *   __               .__       .__  ._____.           
 * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
 * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
 *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
 *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
 *                   \/       \/             \/     \/ 
 *
 * 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.volume;

import java.util.logging.Level;
import java.util.logging.Logger;

import toxi.geom.Vec3D;
import toxi.math.MathUtils;

/**
 *
 * @author tux
 */
public abstract class VolumetricSpace {

    /**
     *
     */
    protected static final Logger logger = Logger
            .getLogger(VolumetricSpace.class.getName());

    public final int resX,

    /**
     *
     */

    /**
     *
     */
    resY,

    /**
     *
     */
    resZ;
    public final int resX1,

    /**
     *
     */
    resY1, resZ1;

    /**
     *
     */
    public final int sliceRes;

    /**
     *
     */
    public final Vec3D scale = new Vec3D();

    /**
     *
     */
    public final Vec3D halfScale = new Vec3D();

    /**
     *
     */
    public final Vec3D voxelSize = new Vec3D();

    /**
     *
     */
    public final int numCells;

    /**
     *
     * @param scale
     * @param resX
     * @param resY
     * @param resZ
     */
    public VolumetricSpace(Vec3D scale, int resX, int resY, int resZ) {
        this.resX = resX;
        this.resY = resY;
        this.resZ = resZ;
        resX1 = resX - 1;
        resY1 = resY - 1;
        resZ1 = resZ - 1;
        sliceRes = resX * resY;
        numCells = sliceRes * resZ;
        setScale(scale);
        logger.log(Level.INFO, "new space of {0}x{1}x{2} cells: {3}", new Object[]{resX, resY, resZ, numCells});
    }

    /**
     *
     */
    public abstract void clear();

    /**
     *
     */
    public void closeSides() {
        throw new UnsupportedOperationException(
                "This VolumetricSpace implementation does not support closeSides()");
    }

    /**
     *
     * @param x
     * @param y
     * @param z
     * @return
     */
    public final int getIndexFor(int x, int y, int z) {
        x = MathUtils.clip(x, 0, resX1);
        y = MathUtils.clip(y, 0, resY1);
        z = MathUtils.clip(z, 0, resZ1);
        return x + y * resX + z * sliceRes;
    }

    /**
     *
     * @return
     */
    public final Vec3D getResolution() {
        return new Vec3D(resX, resY, resZ);
    }

    /**
     * @return the scale
     */
    public final Vec3D getScale() {
        return scale.copy();
    }

    /**
     *
     * @param index
     * @return
     */
    public abstract float getVoxelAt(int index);

    /**
     * @param scale
     *            the scale to set
     */
    public final void setScale(Vec3D scale) {
        this.scale.set(scale);
        this.halfScale.set(scale.scale(0.5f));
        voxelSize.set(scale.x / resX, scale.y / resY, scale.z / resZ);
    }

    /**
     *
     * @param index
     * @param value
     */
    public void setVoxelAt(int index, float value) {
        throw new UnsupportedOperationException(
                "This VolumetricSpace implementation does not support setVoxelAt()");
    }

    /**
     *
     * @param x
     * @param y
     * @param z
     * @param value
     */
    public void setVoxelAt(int x, int y, int z, float value) {
        throw new UnsupportedOperationException(
                "This VolumetricSpace implementation does not support setVoxelAt()");
    }
}