1/**************************************************************************/
2/* spring_arm_3d.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 SPRING_ARM_3D_H
32#define SPRING_ARM_3D_H
33
34#include "scene/3d/node_3d.h"
35
36class SpringArm3D : public Node3D {
37 GDCLASS(SpringArm3D, Node3D);
38
39 Ref<Shape3D> shape;
40 HashSet<RID> excluded_objects;
41 real_t spring_length = 1.0;
42 real_t current_spring_length = 0.0;
43 bool keep_child_basis = false;
44 uint32_t mask = 1;
45 real_t margin = 0.01;
46
47protected:
48 void _notification(int p_what);
49 static void _bind_methods();
50
51public:
52 void set_length(real_t p_length);
53 real_t get_length() const;
54 void set_shape(Ref<Shape3D> p_shape);
55 Ref<Shape3D> get_shape() const;
56 void set_mask(uint32_t p_mask);
57 uint32_t get_mask();
58 void add_excluded_object(RID p_rid);
59 bool remove_excluded_object(RID p_rid);
60 void clear_excluded_objects();
61 real_t get_hit_length();
62 void set_margin(real_t p_margin);
63 real_t get_margin();
64
65 SpringArm3D() {}
66
67private:
68 void process_spring();
69};
70
71#endif // SPRING_ARM_3D_H
72