com.gluonhq.charm.down.plugins.MagnetometerService Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016, Gluon
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 *
 * 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 GLUON 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.gluonhq.charm.down.plugins;

import javafx.beans.property.ReadOnlyObjectProperty;

/**
 * A magnetometer measures the ambient geomagnetic field for all three physical axes (x, y and z).
 *
 * The MagnetometerService provides a read-only {@link #readingProperty() reading property}
 * that is updated at regular intervals by the underlying platform implementation. A user of the
 * MagnetometerService can listen to changes of the magnetic field, by registering a
 * {@link javafx.beans.value.ChangeListener ChangeListener} to the
 * {@link #readingProperty() reading property}.
 *
 * 
Example
 *  * {@code Services.get(MagnetometerService.class).ifPresent(service -> {
 *      MagnetometerReading reading = service.getReading();
 *      System.out.printf("Magnetic field: %.4f, %.4f, %.4f. Magnitude: %.4f",
 *              reading.getX(), reading.getY(), reading.getZ(), reading.getMagnitude());
 *  });}
 *
 * Android Configuration: none
 * iOS Configuration: none
 *
 * @since 3.0.0
 */
public interface MagnetometerService {

    // TODO: Provide API to modify these settings:
    static final int FREQUENCY = 10; // in Hz
    
    /**
     * Returns a single reading from the magnetometer.
     *
     * @return the current magnetometer reading
     */
    MagnetometerReading getReading();

    /**
     * A frequently-updated reading from the magnetometer.
     *
     * @return A property containing a frequently-updated magnetometer reading.
     */
    ReadOnlyObjectProperty readingProperty();
}