com.github.stephengold.garrett.CameraSignal Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of Garrett Show documentation

a camera-controller library for jMonkeyEngine

There is a newer version: 0.5.3

/*
 Copyright (c) 2020-2021, Stephen Gold
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 1. Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.

 3. Neither the name of the copyright holder nor the names of its
    contributors may be used to endorse or promote products derived from
    this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.github.stephengold.garrett;

/**
 * Enumerate the OrbitCamera functions that can be controlled by signals.
 *
 * @author Stephen Gold [email protected]
 */
public enum CameraSignal {
    // *************************************************************************
    // values

    /**
     * translate backward (camera's -Z direction)
     */
    Back,
    /**
     * activate drag-to-orbit
     */
    DragToOrbit,
    /**
     * translate forward (camera's look or +Z direction)
     */
    Forward,
    /**
     * orbit counter-clockwise (world +Y axis), moving to the camera's right
     */
    OrbitCcw,
    /**
     * orbit clockwise (world -Y axis), moving to the camera's left
     */
    OrbitCw,
    /**
     * orbit in the camera's actual "down" direction
     */
    OrbitDown,
    /**
     * orbit in the camera's actual "up" direction
     */
    OrbitUp,
    /**
     * use X-ray vision (no line-of-sight constraint)
     */
    Xray,
    /**
     * magnify the scene
     */
    ZoomIn,
    /**
     * de-magnify the scene
     */
    ZoomOut
}