VoiceSpacing.java

package com.xenoage.zong.musiclayout.spacing;

import java.util.List;

import com.xenoage.zong.core.music.Voice;
import com.xenoage.zong.core.music.VoiceElement;

/**
 * This class contains the spacing of one voice
 * of a measure of a single staff.
 *
 * @author Andreas Wenger
 */
public final class VoiceSpacing {

	/** The {@link Voice} this spacing belongs to. */
	public final Voice voice;
	/** The interline space in mm of this voice. */
	public final float interlineSpace;
	/** The {@link ElementSpacing}s of this voice. */
	public final List<ElementSpacing> elements;
	
	/** The parent measure. */
	public MeasureSpacing measure;
	
	
	public VoiceSpacing(Voice voice, float interlineSpace, List<ElementSpacing> elements) {
		this.voice = voice;
		this.interlineSpace = interlineSpace;
		this.elements = elements;
		//set backward references
		for (ElementSpacing element : elements)
			element.voice = this;
	}
	
	
	public ElementSpacing getLast() {
		return elements.get(elements.size() - 1);
	}
	
	/**
	 * Gets the spacing for the given element, or throws an
	 * {@link IllegalArgumentException} if it is not in this voice.
	 */
	public ElementSpacing getElement(VoiceElement element) {
		for (ElementSpacing e : elements) {
			if (e.getElement() == element)
				return e;
		}
		throw new IllegalArgumentException("unknown element");
	}
	
}