1/**************************************************************************/
2/* xr_pose.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef XR_POSE_H
32#define XR_POSE_H
33
34#include "core/object/ref_counted.h"
35
36class XRPose : public RefCounted {
37 GDCLASS(XRPose, RefCounted);
38
39public:
40 // TrackingConfidence gives an indication of how reliable our transform data is.
41 enum TrackingConfidence {
42 XR_TRACKING_CONFIDENCE_NONE, // No tracking information is available for this pose.
43 XR_TRACKING_CONFIDENCE_LOW, // Tracking information may be inaccurate or estimated.
44 XR_TRACKING_CONFIDENCE_HIGH // Tracking information is deemed accurate and up to date.
45 };
46
47private:
48 bool has_tracking_data = false;
49 StringName name;
50 Transform3D transform;
51 Vector3 linear_velocity;
52 Vector3 angular_velocity;
53 TrackingConfidence tracking_confidence = XR_TRACKING_CONFIDENCE_NONE;
54
55protected:
56 static void _bind_methods();
57
58public:
59 void set_has_tracking_data(const bool p_has_tracking_data);
60 bool get_has_tracking_data() const;
61
62 void set_name(const StringName &p_name);
63 StringName get_name() const;
64
65 void set_transform(const Transform3D p_transform);
66 Transform3D get_transform() const;
67 Transform3D get_adjusted_transform() const;
68
69 void set_linear_velocity(const Vector3 p_velocity);
70 Vector3 get_linear_velocity() const;
71
72 void set_angular_velocity(const Vector3 p_velocity);
73 Vector3 get_angular_velocity() const;
74
75 void set_tracking_confidence(const TrackingConfidence p_tracking_confidence);
76 TrackingConfidence get_tracking_confidence() const;
77};
78
79VARIANT_ENUM_CAST(XRPose::TrackingConfidence);
80
81#endif // XR_POSE_H
82