SFML - Simple and Fast Multimedia Library

SFML 2.6.2
Loading...
Searching...
No Matches
Sensor.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_SENSOR_HPP
26#define SFML_SENSOR_HPP
27
29// Headers
31#include <SFML/Window/Export.hpp>
32#include <SFML/System/Vector3.hpp>
33#include <SFML/System/Time.hpp>
34
35
36namespace sf
37{
42 class SFML_WINDOW_API Sensor
43{
44public:
45
50 enum Type
51 {
52 Accelerometer,
53 Gyroscope,
54 Magnetometer,
55 Gravity,
56 UserAcceleration,
57 Orientation,
58
59 Count
60 };
61
70 static bool isAvailable(Type sensor);
71
85 static void setEnabled(Type sensor, bool enabled);
86
95 static Vector3f getValue(Type sensor);
96};
97
98} // namespace sf
99
100
101#endif // SFML_SENSOR_HPP
102
103
Time.hpp
Vector3.hpp
Export.hpp
SFML_WINDOW_API
#define SFML_WINDOW_API
Definition Window/Export.hpp:43
sf::Sensor
Give access to the real-time state of the sensors.
Definition Sensor.hpp:43
sf::Sensor::Type
Type
Sensor type.
Definition Sensor.hpp:51
sf::Sensor::Accelerometer
@ Accelerometer
Measures the raw acceleration (m/s^2)
Definition Sensor.hpp:52
sf::Sensor::Gyroscope
@ Gyroscope
Measures the raw rotation rates (degrees/s)
Definition Sensor.hpp:53
sf::Sensor::Orientation
@ Orientation
Measures the absolute 3D orientation (degrees)
Definition Sensor.hpp:57
sf::Sensor::UserAcceleration
@ UserAcceleration
Measures the direction and intensity of device acceleration, independent of the gravity (m/s^2)
Definition Sensor.hpp:56
sf::Sensor::Magnetometer
@ Magnetometer
Measures the ambient magnetic field (micro-teslas)
Definition Sensor.hpp:54
sf::Sensor::Gravity
@ Gravity
Measures the direction and intensity of gravity, independent of device acceleration (m/s^2)
Definition Sensor.hpp:55
sf::Sensor::Count
@ Count
Keep last – the total number of sensor types.
Definition Sensor.hpp:59
sf::Sensor::isAvailable
static bool isAvailable(Type sensor)
Check if a sensor is available on the underlying platform.
sf::Sensor::getValue
static Vector3f getValue(Type sensor)
Get the current sensor value.
sf::Sensor::setEnabled
static void setEnabled(Type sensor, bool enabled)
Enable or disable a sensor.
sf
Definition AlResource.hpp:35
sf::Vector3f
Vector3< float > Vector3f
Definition Vector3.hpp:256