DeviceOpticsInformation.java

/*******************************************************************************
 * Copyright 2011 See AUTHORS file.
 * 
 * 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 com.badlogic.gdx.vr;

/**
 * @author Daniel Holderbaum
 */
public interface DeviceOpticsInformation {

	/**
	 * Returns the eye to lens distance in meters. The distance is measured to
	 * the center of the lens, not its surface.
	 * 
	 * @return The eye to lens distance in meters.
	 */
	float getEyeToLensDistance();

	/**
	 * Returns the interpupillary distance for the device.
	 * 
	 * @return The interpupillary distance in meters.
	 */
	float getInterpupillaryDistance();

	/**
	 * Returns the lens diameter.
	 * 
	 * @return The lens diameter in meters.
	 */
	float getLensDiameter();

	/**
	 * Returns the screen to lens distance.
	 * 
	 * @return The screen to lens distance in meters.
	 */
	float getScreenToLensDistance();

	/**
	 * Returns the vertical distance to the lens center.
	 * 
	 * @return The vertical distance to the lens center from the bottom of the
	 *         inserted device, measured in meters.
	 */
	float getVerticalDistanceToLensCenter();

}