gov.nasa.worldwind.StereoSceneController Maven / Gradle / Ivy
/*
* Copyright 2006-2009, 2017, 2020 United States Government, as represented by the
* Administrator of the National Aeronautics and Space Administration.
* All rights reserved.
*
* The NASA World Wind Java (WWJ) platform is 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.
*
* NASA World Wind Java (WWJ) also contains the following 3rd party Open Source
* software:
*
* Jackson Parser – Licensed under Apache 2.0
* GDAL – Licensed under MIT
* JOGL – Licensed under Berkeley Software Distribution (BSD)
* Gluegen – Licensed under Berkeley Software Distribution (BSD)
*
* A complete listing of 3rd Party software notices and licenses included in
* NASA World Wind Java (WWJ) can be found in the WorldWindJava-v2.2 3rd-party
* notices and licenses PDF found in code directory.
*/
package gov.nasa.worldwind;
import gov.nasa.worldwind.geom.Angle;
/**
* An interface for scene controllers that provide stereo.
*
* Note: The {@link WorldWindow} instance must support stereo display in order to use device-supported stereo. See
* {@link gov.nasa.worldwind.awt.WorldWindowGLCanvas} to learn how to select a stereo device.
*
* @author Tom Gaskins
* @version $Id: StereoSceneController.java 1171 2013-02-11 21:45:02Z dcollins $
*/
public interface StereoSceneController extends SceneController
{
/**
* Specifies the technique used to provide a stereo effect. Defined options are {@link
* gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_DEVICE} to request device supported stereo, {@link
* gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_RED_BLUE} to request red-blue anaglyph stereo implemented in
* software, or {@link gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_NONE} (the default) to request no stereo effect.
*
* If STEREO_MODE_DEVICE is requested but the display device does not support stereo, stereo is not
* applied.
*
* See the implementing class to determine how it detects the initial stereo mode.
*
* @param mode the technique used to provide the stereo effect. If null, the mode is set to {@link
* gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_NONE}.
*/
public void setStereoMode(String mode);
/**
* Indicates the current stereo mode of this controller.
*
* @return the current stereo mode. See this class' description for the possible modes. This method does not return
* null. If a null mode was passed to {@link #setStereoMode(String)}, this instance's mode was set to {@link
* gov.nasa.worldwind.avlist.AVKey#STEREO_MODE_NONE}.
*/
public String getStereoMode();
/**
* Specifies the angle difference between the left and right eye direction. Larger angles increase the stereo
* effect.
*
* @param a the left-right eye direction difference. If null, the angle is set to 0.
*/
public void setFocusAngle(Angle a);
/**
* Returns this controller's focus angle, the angle difference between the left and right eye direction.
*
* @return this controller's focus angle.
*/
public Angle getFocusAngle();
/**
* Specifies whether to draw the right eye image in the left eye's position and the left eye's image in the right
* eye's position.
*
* @param swapEyes true to switch the left/right stereo images, otherwise false.
*/
public void setSwapEyes(boolean swapEyes);
/**
* Indicates whether to switch the left/right stereo images.
*
* @return true to switch the images, otherwise false
*/
public boolean isSwapEyes();
/**
* Indicates whether stereo is being implemented directly by the display device rather than software.
*
* @return true if if stereo is being implemented by the display device, otherwise false.
*/
public boolean isHardwareStereo();
/**
* Indicates whether stereo is being applied, either directly by the display device or simulated via software.
*
* @return true if stereo is being applied.
*/
public boolean isInStereo();
}