documentation/3.0.0/Sensor_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)

//

// This software is provided 'as-is', without any express or implied warranty.

// In no event will the authors be held liable for any damages arising from the use of this software.

//

// Permission is granted to anyone to use this software for any purpose,

// including commercial applications, and to alter it and redistribute it freely,

// subject to the following restrictions:

//

// 1. The origin of this software must not be misrepresented;

//    you must not claim that you wrote the original software.

//    If you use this software in a product, an acknowledgment

//    in the product documentation would be appreciated but is not required.

//

// 2. Altered source versions must be plainly marked as such,

//    and must not be misrepresented as being the original software.

//

// 3. This notice may not be removed or altered from any source distribution.

//


#pragma once


// Headers

#include <SFML/Window/Export.hpp>


#include <SFML/System/Vector3.hpp>


namespace sf::Sensor

{


enum class Type

{

    Accelerometer,

    Gyroscope,

    Magnetometer,

    Gravity,

    UserAcceleration,

    Orientation

};


// NOLINTNEXTLINE(readability-identifier-naming)

static constexpr unsigned int Count{6};


[[nodiscard]] SFML_WINDOW_API bool isAvailable(Type sensor);


SFML_WINDOW_API void setEnabled(Type sensor, bool enabled);


[[nodiscard]] SFML_WINDOW_API Vector3f getValue(Type sensor);

} // namespace sf::Sensor


Vector3.hpp

Export.hpp

SFML_WINDOW_API
#define SFML_WINDOW_API
Definition Window/Export.hpp:42

sf::Sensor
Give access to the real-time state of the sensors.
Definition Sensor.hpp:39

sf::Sensor::getValue
Vector3f getValue(Type sensor)
Get the current sensor value.

sf::Sensor::Count
static constexpr unsigned int Count
The total number of sensor types.
Definition Sensor.hpp:55

sf::Sensor::Type
Type
Sensor type.
Definition Sensor.hpp:45

sf::Sensor::Type::Gravity
@ Gravity
Measures the direction and intensity of gravity, independent of device acceleration (m/s^2)
Definition Sensor.hpp:49

sf::Sensor::Type::Magnetometer
@ Magnetometer
Measures the ambient magnetic field (micro-teslas)
Definition Sensor.hpp:48

sf::Sensor::Type::Orientation
@ Orientation
Measures the absolute 3D orientation (radians)
Definition Sensor.hpp:51

sf::Sensor::Type::Accelerometer
@ Accelerometer
Measures the raw acceleration (m/s^2)
Definition Sensor.hpp:46

sf::Sensor::Type::Gyroscope
@ Gyroscope
Measures the raw rotation rates (radians/s)
Definition Sensor.hpp:47

sf::Sensor::Type::UserAcceleration
@ UserAcceleration
Measures the direction and intensity of device acceleration, independent of the gravity (m/s^2)
Definition Sensor.hpp:50

sf::Sensor::isAvailable
bool isAvailable(Type sensor)
Check if a sensor is available on the underlying platform.

sf::Sensor::setEnabled
void setEnabled(Type sensor, bool enabled)
Enable or disable a sensor.

sf::Vector3f
Vector3< float > Vector3f
Definition Vector3.hpp:306