org.scijava.ops.image.geom.geom3d.UpdateablePointSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-ops-image Show documentation
Image processing operations for SciJava Ops.
The newest version!
/*
 * #%L
 * Image processing operations for SciJava Ops.
 * %%
 * Copyright (C) 2014 - 2024 SciJava developers.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 * 
 * 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 HOLDERS 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.
 * #L%
 */

package org.scijava.ops.image.geom.geom3d;

import java.util.List;

/**
 * An {@link UpdateablePointSet} consists of vertices and neighbors.
 *
 * @author Tim-Oliver Buchholz (University of Konstanz)
 */
abstract class UpdateablePointSet {

	/**
	 * The vertices of this facet in counter clock wise orientation.
	 */
	protected List vertices;

	/**
	 * The neighboring facets of this facet.
	 * 
	 * Neighbor 0 is the neighbor which is adjacent to this facet at the edge from
	 * {@link TriangularFacet#getLastVertex()} to
	 * {@link TriangularFacet#getVertex(int) TriangularFacet#getVertex(0)}.
	 * 
	 */
	protected List neighbors;

	/**
	 * The list of vertices.
	 *
	 * @return all vertices
	 */
	public List getVertices() {
		return vertices;
	}

	/**
	 * Returns the index of the first occurrence of vertex.
	 *
	 * @param vertex the vertex
	 * @return index of vertex or -1 if this vertex is not contained
	 */
	public int indexOfVertex(final Vertex vertex) {
		return vertices.indexOf(vertex);
	}

	/**
	 * Get the vertex at index i.
	 *
	 * @param i the position
	 * @return the vertex
	 */
	public Vertex getVertex(final int i) {
		return vertices.get(i);
	}

	/**
	 * Get the number of vertices.
	 *
	 * @return number of vertices
	 */
	public int size() {
		return vertices.size();
	}

	/**
	 * Get the last vertex.
	 *
	 * @return the last vertex
	 */
	public Vertex getLastVertex() {
		return vertices.get(vertices.size() - 1);
	}

	/**
	 * Returns true if all vertices are part of this polygon
	 *
	 * @param vertexList to check
	 * @return true if all vertices are contained
	 */
	public boolean containsAll(final List vertexList) {
		return vertices.containsAll(vertexList);
	}

	/**
	 * Returns true if this facet has the edge from tail to head.
	 *
	 * @param tail vertex of the edge
	 * @param head vertex of the edge
	 * @return has edge tail to head
	 */
	public boolean hasEdge(final Vertex tail, final Vertex head) {
		int start = vertices.indexOf(tail);
		int end = vertices.indexOf(head);
		if (start == -1 || end == -1) {
			return false;
		}
		return (start + 1) % vertices.size() == end;
	}

	/**
	 * Sets the n-th neighbor of this facet.
	 *
	 * @param position of the neighbor
	 * @param n the neighbor
	 */
	public void setNeighbor(final int position, final T n) {
		neighbors.add(position, n);
	}

	/**
	 * Get the neighbor at position.
	 *
	 * @param position the position
	 * @return the neighbor
	 */
	public T getNeighbor(final int position) {
		return neighbors.get(position);
	}

	/**
	 * Get all neighbors.
	 *
	 * @return all neighbors
	 */
	public List getNeighbors() {
		return neighbors;
	}

	/**
	 * Replaces a neighbor.
	 *
	 * @param i index of the neighbor to replace
	 * @param f the new neighbor
	 */
	public void replaceNeighbor(final int i, final T f) {
		neighbors.remove(i);
		neighbors.add(i, f);
	}

	/**
	 * Get index of a neighbor.
	 *
	 * @param facet the neighboring facet
	 * @return the index or -1 if facet is not a neighbor
	 */
	public int indexOfNeighbor(final T facet) {
		return neighbors.indexOf(facet);
	}
}