boofcv.alg.fiducial.calib.squares.SquareEdge Maven / Gradle / Ivy

/*
 * Copyright (c) 2021, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.alg.fiducial.calib.squares;

/**
 * Edge in the graph which connects square shapes
 *
 * @author Peter Abeles
 */
@SuppressWarnings({"NullAway.Init"})
public class SquareEdge {
	// destinations
	public SquareNode a;
	public SquareNode b;

	// which index in the shape this edge belongs to
	public int sideA;
	public int sideB;

	// the distance between the square's centers
	public double distance;

	public SquareEdge() {}

	public SquareEdge( SquareNode a, SquareNode b, int sideA, int sideB ) {
		this.a = a;
		this.b = b;
		this.sideA = sideA;
		this.sideB = sideB;
	}

	/**
	 * Returns the destination node.
	 */
	public  T destination( SquareNode src ) {
		if (a == src)
			return (T)b;
		else if (b == src)
			return (T)a;
		else
			throw new IllegalArgumentException("BUG! src is not a or b");
	}

	public int destinationSide( SquareNode src ) {
		if (a == src)
			return sideB;
		else if (b == src)
			return sideA;
		else
			throw new IllegalArgumentException("BUG! src is not a or b");
	}

	public boolean isEndPoint( SquareNode target ) {
		return a == target || b == target;
	}

	/**
	 * Discards previous settings.
	 */
	@SuppressWarnings("NullAway")
	public void reset() {
		a = b = null;
		sideA = sideB = -1;
		distance = -1;
	}
}