KdTreeProcedure.java

/* jCAE stand for Java Computer Aided Engineering. Features are : Small CAD
   modeler, Finite element mesher, Plugin architecture.

    Copyright (C) 2004,2005,2006, by EADS CRC
    Copyright (C) 2007, by EADS France

    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.

    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

package org.jcae.mesh.amibe.metrics;

/**
 * Procedure to apply on all kd-tree cells.
 */
public interface KdTreeProcedure
{
        /**
	 * Continue tree traversal.
	 */
	public static final int OK  = 0;
	/**
	 * Abort tree traversal immediately.
	 **/
	public static final int ABORT = -1;
	/**
	 * Do not process children.
	 **/
	public static final int SKIPCHILD = 1;

	/**
	 * Perform an action on the given kdtree cell.
	 * This method is called by {@link KdTree#walk(KdTreeProcedure)} on
	 * all cells of the kd-tree recursively.
	 *
	 * @param o  kd-tree cell.
	 * @param s  cell size.
	 * @param i0  coordinates of the bottom left corner of this cell.
	 * @return {@link #ABORT} if <code>walk</code> processing must
	 * abort now, {@link #SKIPCHILD} if node children have to be ignored, and
	 * {@link #OK} to process node children recursively.
	 */
	public int action(Object o, int s, final int [] i0);
}