IStereoViewDelegate.java

/*******************************************************************************
 * Copyright 2012 Geoscience Australia
 * 
 * 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 au.gov.ga.earthsci.worldwind.common.view.stereo;

import au.gov.ga.earthsci.worldwind.common.view.delegate.IViewDelegate;

/**
 * Interface which stereoscopic capable View subclasses must implement.
 * 
 * @author Michael de Hoog (michael.dehoog@ga.gov.au)
 */
public interface IStereoViewDelegate extends IViewDelegate
{
	/**
	 * Represents an eye.
	 */
	public enum Eye
	{
		LEFT,
		RIGHT
	}

	/**
	 * Setup this view, ready for applying.
	 * 
	 * @param stereo
	 *            Enable stereo?
	 * @param eye
	 *            Eye to draw from if stereo enabled
	 */
	void setup(boolean stereo, Eye eye);

	/**
	 * @return Eye this view is drawing
	 */
	Eye getEye();

	/**
	 * @return Is this view currently drawing stereo?
	 */
	boolean isStereo();

	/**
	 * @return Parameters used to draw this view.
	 */
	StereoViewParameters getParameters();

	/**
	 * Set the parameters used to draw this view.
	 * 
	 * @param parameters
	 */
	void setParameters(StereoViewParameters parameters);

	/**
	 * @return Focal length used in the last call to doApply()
	 */
	double getCurrentFocalLength();

	/**
	 * @return Eye separation used in the last call to doApply()
	 */
	double getCurrentEyeSeparation();
}