2014-02-10 01:10:30 +00:00
/*************************************************************************/
2020-03-26 21:49:16 +00:00
/* node_3d.h */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2018-01-04 23:50:27 +00:00
2020-03-26 21:49:16 +00:00
# ifndef NODE_3D_H
# define NODE_3D_H
2014-02-10 01:10:30 +00:00
# include "scene/main/node.h"
2022-02-12 01:46:22 +00:00
# include "scene/resources/world_3d.h"
2014-02-10 01:10:30 +00:00
2021-06-04 16:03:15 +00:00
class Node3DGizmo : public RefCounted {
GDCLASS ( Node3DGizmo , RefCounted ) ;
2014-02-10 01:10:30 +00:00
public :
virtual void create ( ) = 0 ;
virtual void transform ( ) = 0 ;
2014-09-19 21:39:50 +00:00
virtual void clear ( ) = 0 ;
2014-02-10 01:10:30 +00:00
virtual void redraw ( ) = 0 ;
virtual void free ( ) = 0 ;
2020-03-26 21:49:16 +00:00
Node3DGizmo ( ) ;
virtual ~ Node3DGizmo ( ) { }
2014-02-10 01:10:30 +00:00
} ;
2020-03-26 21:49:16 +00:00
class Node3D : public Node {
GDCLASS ( Node3D , Node ) ;
2016-03-08 23:00:52 +00:00
2021-10-21 16:38:20 +00:00
public :
2022-06-25 09:23:24 +00:00
// Edit mode for the rotation.
// THIS MODE ONLY AFFECTS HOW DATA IS EDITED AND SAVED
// IT DOES _NOT_ AFFECT THE TRANSFORM LOGIC (see comment in TransformDirty).
2021-10-21 16:38:20 +00:00
enum RotationEditMode {
ROTATION_EDIT_MODE_EULER ,
ROTATION_EDIT_MODE_QUATERNION ,
ROTATION_EDIT_MODE_BASIS ,
} ;
private :
2022-10-11 11:58:25 +00:00
// For the sake of ease of use, Node3D can operate with Transforms (Basis+Origin), Quaternion/Scale and Euler Rotation/Scale.
// Transform and Quaternion are stored in data.local_transform Basis (so quaternion is not really stored, but converted back/forth from 3x3 matrix on demand).
2022-06-25 09:23:24 +00:00
// Euler needs to be kept separate because converting to Basis and back may result in a different vector (which is troublesome for users
// editing in the inspector, not only because of the numerical precision loss but because they expect these rotations to be consistent, or support
// "redundant" rotations for animation interpolation, like going from 0 to 720 degrees).
//
// As such, the system works in a way where if the local transform is set (via transform/basis/quaternion), the EULER rotation and scale becomes dirty.
// It will remain dirty until reading back is attempted (for performance reasons). Likewise, if the Euler rotation scale are set, the local transform
// will become dirty (and again, will not become valid again until read).
//
// All this is transparent from outside the Node3D API, which allows everything to works by calling these functions in exchange.
//
// Additionally, setting either transform, quaternion, Euler rotation or scale makes the global transform dirty, which will be updated when read again.
//
// NOTE: Again, RotationEditMode is _independent_ of this mechanism, it is only meant to expose the right set of properties for editing (editor) and saving
// (to scene, in order to keep the same values and avoid data loss on conversions). It has zero influence in the logic described above.
2014-02-10 01:10:30 +00:00
enum TransformDirty {
DIRTY_NONE = 0 ,
2022-06-25 09:23:24 +00:00
DIRTY_EULER_ROTATION_AND_SCALE = 1 ,
DIRTY_LOCAL_TRANSFORM = 2 ,
DIRTY_GLOBAL_TRANSFORM = 4
2014-02-10 01:10:30 +00:00
} ;
mutable SelfList < Node > xform_change ;
2022-10-13 13:30:23 +00:00
// This Data struct is to avoid namespace pollution in derived classes.
2014-02-10 01:10:30 +00:00
struct Data {
2020-10-17 05:08:21 +00:00
mutable Transform3D global_transform ;
mutable Transform3D local_transform ;
2022-10-02 02:53:12 +00:00
mutable EulerOrder euler_rotation_order = EulerOrder : : YXZ ;
2022-06-25 09:23:24 +00:00
mutable Vector3 euler_rotation ;
2020-12-11 14:54:03 +00:00
mutable Vector3 scale = Vector3 ( 1 , 1 , 1 ) ;
2021-10-21 16:38:20 +00:00
mutable RotationEditMode rotation_edit_mode = ROTATION_EDIT_MODE_EULER ;
2014-02-10 01:10:30 +00:00
2020-12-11 14:54:03 +00:00
mutable int dirty = DIRTY_NONE ;
2014-02-10 01:10:30 +00:00
2020-12-11 14:54:03 +00:00
Viewport * viewport = nullptr ;
2014-02-10 01:10:30 +00:00
2020-12-11 14:54:03 +00:00
bool top_level_active = false ;
bool top_level = false ;
bool inside_world = false ;
2016-03-08 23:00:52 +00:00
2021-05-09 16:23:20 +00:00
RID visibility_parent ;
2020-12-11 14:54:03 +00:00
int children_lock = 0 ;
Node3D * parent = nullptr ;
2020-03-26 21:49:16 +00:00
List < Node3D * > children ;
2020-12-11 14:54:03 +00:00
List < Node3D * > : : Element * C = nullptr ;
2016-03-08 23:00:52 +00:00
2020-12-11 14:54:03 +00:00
bool ignore_notification = false ;
bool notify_local_transform = false ;
bool notify_transform = false ;
2014-02-10 01:10:30 +00:00
2020-12-11 14:54:03 +00:00
bool visible = true ;
bool disable_scale = false ;
2014-08-14 13:31:38 +00:00
2014-02-10 01:10:30 +00:00
# ifdef TOOLS_ENABLED
2021-06-23 14:49:50 +00:00
Vector < Ref < Node3DGizmo > > gizmos ;
bool gizmos_disabled = false ;
bool gizmos_dirty = false ;
2021-02-04 08:20:26 +00:00
bool transform_gizmo_visible = true ;
2014-02-10 01:10:30 +00:00
# endif
} data ;
2021-05-09 16:23:20 +00:00
NodePath visibility_parent_path ;
2021-06-23 14:49:50 +00:00
void _update_gizmos ( ) ;
2014-02-10 01:10:30 +00:00
void _notify_dirty ( ) ;
2020-03-26 21:49:16 +00:00
void _propagate_transform_changed ( Node3D * p_origin ) ;
2014-02-10 01:10:30 +00:00
2014-08-14 13:31:38 +00:00
void _propagate_visibility_changed ( ) ;
2021-05-09 16:23:20 +00:00
void _propagate_visibility_parent ( ) ;
void _update_visibility_parent ( bool p_update_root ) ;
2014-02-10 01:10:30 +00:00
protected :
_FORCE_INLINE_ void set_ignore_transform_notification ( bool p_ignore ) { data . ignore_notification = p_ignore ; }
_FORCE_INLINE_ void _update_local_transform ( ) const ;
2022-06-25 09:23:24 +00:00
_FORCE_INLINE_ void _update_rotation_and_scale ( ) const ;
2014-02-10 01:10:30 +00:00
void _notification ( int p_what ) ;
static void _bind_methods ( ) ;
2014-08-14 13:31:38 +00:00
2022-08-12 20:57:11 +00:00
void _validate_property ( PropertyInfo & p_property ) const ;
2021-10-21 16:38:20 +00:00
2022-08-12 18:43:14 +00:00
bool _property_can_revert ( const StringName & p_name ) const ;
bool _property_get_revert ( const StringName & p_name , Variant & r_property ) const ;
2022-01-02 15:33:17 +00:00
2014-02-10 01:10:30 +00:00
public :
enum {
2014-11-06 00:20:42 +00:00
NOTIFICATION_TRANSFORM_CHANGED = SceneTree : : NOTIFICATION_TRANSFORM_CHANGED ,
2014-02-10 01:10:30 +00:00
NOTIFICATION_ENTER_WORLD = 41 ,
NOTIFICATION_EXIT_WORLD = 42 ,
2014-08-14 13:31:38 +00:00
NOTIFICATION_VISIBILITY_CHANGED = 43 ,
2015-09-16 01:07:03 +00:00
NOTIFICATION_LOCAL_TRANSFORM_CHANGED = 44 ,
2014-02-10 01:10:30 +00:00
} ;
2021-06-09 11:06:38 +00:00
Node3D * get_parent_node_3d ( ) const ;
2014-02-10 01:10:30 +00:00
2020-04-18 09:00:51 +00:00
Ref < World3D > get_world_3d ( ) const ;
2014-02-10 01:10:30 +00:00
2020-12-08 17:35:30 +00:00
void set_position ( const Vector3 & p_position ) ;
2021-10-21 16:38:20 +00:00
void set_rotation_edit_mode ( RotationEditMode p_mode ) ;
RotationEditMode get_rotation_edit_mode ( ) const ;
2022-10-02 02:53:46 +00:00
void set_rotation_order ( EulerOrder p_order ) ;
2016-05-06 21:38:08 +00:00
void set_rotation ( const Vector3 & p_euler_rad ) ;
2022-12-18 15:58:19 +00:00
void set_rotation_degrees ( const Vector3 & p_euler_degrees ) ;
2014-02-10 01:10:30 +00:00
void set_scale ( const Vector3 & p_scale ) ;
2021-07-21 04:13:52 +00:00
void set_global_position ( const Vector3 & p_position ) ;
void set_global_rotation ( const Vector3 & p_euler_rad ) ;
2022-12-18 15:58:19 +00:00
void set_global_rotation_degrees ( const Vector3 & p_euler_degrees ) ;
2021-07-21 04:13:52 +00:00
2020-12-08 17:35:30 +00:00
Vector3 get_position ( ) const ;
2021-10-21 16:38:20 +00:00
2022-10-02 02:53:46 +00:00
EulerOrder get_rotation_order ( ) const ;
2014-02-10 01:10:30 +00:00
Vector3 get_rotation ( ) const ;
2022-12-18 15:58:19 +00:00
Vector3 get_rotation_degrees ( ) const ;
2014-02-10 01:10:30 +00:00
Vector3 get_scale ( ) const ;
2021-07-21 04:13:52 +00:00
Vector3 get_global_position ( ) const ;
Vector3 get_global_rotation ( ) const ;
2022-12-18 15:58:19 +00:00
Vector3 get_global_rotation_degrees ( ) const ;
2021-07-21 04:13:52 +00:00
2020-10-17 05:08:21 +00:00
void set_transform ( const Transform3D & p_transform ) ;
2021-10-21 16:38:20 +00:00
void set_basis ( const Basis & p_basis ) ;
void set_quaternion ( const Quaternion & p_quaternion ) ;
2020-10-17 05:08:21 +00:00
void set_global_transform ( const Transform3D & p_transform ) ;
2016-03-08 23:00:52 +00:00
2020-10-17 05:08:21 +00:00
Transform3D get_transform ( ) const ;
2021-10-21 16:38:20 +00:00
Basis get_basis ( ) const ;
Quaternion get_quaternion ( ) const ;
2020-10-17 05:08:21 +00:00
Transform3D get_global_transform ( ) const ;
2014-02-10 01:10:30 +00:00
2017-10-03 16:49:32 +00:00
# ifdef TOOLS_ENABLED
2020-10-17 05:08:21 +00:00
virtual Transform3D get_global_gizmo_transform ( ) const ;
virtual Transform3D get_local_gizmo_transform ( ) const ;
2021-02-04 08:20:26 +00:00
virtual void set_transform_gizmo_visible ( bool p_enabled ) { data . transform_gizmo_visible = p_enabled ; } ;
virtual bool is_transform_gizmo_visible ( ) const { return data . transform_gizmo_visible ; } ;
2017-10-03 16:49:32 +00:00
# endif
2021-06-23 14:49:50 +00:00
void set_disable_gizmos ( bool p_enabled ) ;
void update_gizmos ( ) ;
2021-02-04 08:20:26 +00:00
void set_subgizmo_selection ( Ref < Node3DGizmo > p_gizmo , int p_id , Transform3D p_transform = Transform3D ( ) ) ;
2021-06-23 14:49:50 +00:00
void clear_subgizmo_selection ( ) ;
Vector < Ref < Node3DGizmo > > get_gizmos ( ) const ;
2022-08-05 18:35:08 +00:00
TypedArray < Node3DGizmo > get_gizmos_bind ( ) const ;
2021-06-23 14:49:50 +00:00
void add_gizmo ( Ref < Node3DGizmo > p_gizmo ) ;
void remove_gizmo ( Ref < Node3DGizmo > p_gizmo ) ;
void clear_gizmos ( ) ;
2014-02-10 01:10:30 +00:00
2022-01-04 11:07:36 +00:00
void set_as_top_level ( bool p_enabled ) ;
bool is_set_as_top_level ( ) const ;
void set_disable_scale ( bool p_enabled ) ;
bool is_scale_disabled ( ) const ;
2014-02-10 01:10:30 +00:00
_FORCE_INLINE_ bool is_inside_world ( ) const { return data . inside_world ; }
2020-10-17 05:08:21 +00:00
Transform3D get_relative_transform ( const Node * p_parent ) const ;
2014-02-10 01:10:30 +00:00
2021-01-30 00:55:54 +00:00
void rotate ( const Vector3 & p_axis , real_t p_angle ) ;
void rotate_x ( real_t p_angle ) ;
void rotate_y ( real_t p_angle ) ;
void rotate_z ( real_t p_angle ) ;
2015-03-22 13:33:58 +00:00
void translate ( const Vector3 & p_offset ) ;
void scale ( const Vector3 & p_ratio ) ;
Restore the behavior of Spatial rotations recently changed in c1153f5.
That change was borne out of a confusion regarding the meaning of "local" in #14569.
Affine transformations in Spatial simply correspond to affine operations of its Transform. Such operations take place in a coordinate system that is defined by the parent Spatial. When there is no parent, they correspond to operations in the global coordinate system.
This coordinate system, which is relative to the parent, has been referred to as the local coordinate system in the docs so far, but this sloppy language has apparently confused some users, making them think that the local coordinate system refers to the one whose axes are "painted" on the Spatial node itself.
To avoid such conceptual conflations and misunderstandings in the future, the parent-relative local system is now referred to as "parent-local", and the object-relative local system is called "object-local" in the docs.
This commit adds the functionality "requested" in #14569, not by changing how rotate/scale/translate works, but by adding new rotate_object_local, scale_object_local and translate_object_local functions. Also, for completeness, there is now global_scale.
This commit also updates another part of the docs regarding the rotation property of Spatial, which also leads to confusion among some users.
2017-12-27 00:15:20 +00:00
2021-01-30 00:55:54 +00:00
void rotate_object_local ( const Vector3 & p_axis , real_t p_angle ) ;
Restore the behavior of Spatial rotations recently changed in c1153f5.
That change was borne out of a confusion regarding the meaning of "local" in #14569.
Affine transformations in Spatial simply correspond to affine operations of its Transform. Such operations take place in a coordinate system that is defined by the parent Spatial. When there is no parent, they correspond to operations in the global coordinate system.
This coordinate system, which is relative to the parent, has been referred to as the local coordinate system in the docs so far, but this sloppy language has apparently confused some users, making them think that the local coordinate system refers to the one whose axes are "painted" on the Spatial node itself.
To avoid such conceptual conflations and misunderstandings in the future, the parent-relative local system is now referred to as "parent-local", and the object-relative local system is called "object-local" in the docs.
This commit adds the functionality "requested" in #14569, not by changing how rotate/scale/translate works, but by adding new rotate_object_local, scale_object_local and translate_object_local functions. Also, for completeness, there is now global_scale.
This commit also updates another part of the docs regarding the rotation property of Spatial, which also leads to confusion among some users.
2017-12-27 00:15:20 +00:00
void scale_object_local ( const Vector3 & p_scale ) ;
void translate_object_local ( const Vector3 & p_offset ) ;
2021-01-30 00:55:54 +00:00
void global_rotate ( const Vector3 & p_axis , real_t p_angle ) ;
Restore the behavior of Spatial rotations recently changed in c1153f5.
That change was borne out of a confusion regarding the meaning of "local" in #14569.
Affine transformations in Spatial simply correspond to affine operations of its Transform. Such operations take place in a coordinate system that is defined by the parent Spatial. When there is no parent, they correspond to operations in the global coordinate system.
This coordinate system, which is relative to the parent, has been referred to as the local coordinate system in the docs so far, but this sloppy language has apparently confused some users, making them think that the local coordinate system refers to the one whose axes are "painted" on the Spatial node itself.
To avoid such conceptual conflations and misunderstandings in the future, the parent-relative local system is now referred to as "parent-local", and the object-relative local system is called "object-local" in the docs.
This commit adds the functionality "requested" in #14569, not by changing how rotate/scale/translate works, but by adding new rotate_object_local, scale_object_local and translate_object_local functions. Also, for completeness, there is now global_scale.
This commit also updates another part of the docs regarding the rotation property of Spatial, which also leads to confusion among some users.
2017-12-27 00:15:20 +00:00
void global_scale ( const Vector3 & p_scale ) ;
2015-03-22 13:33:58 +00:00
void global_translate ( const Vector3 & p_offset ) ;
2021-01-30 09:22:20 +00:00
void look_at ( const Vector3 & p_target , const Vector3 & p_up = Vector3 ( 0 , 1 , 0 ) ) ;
void look_at_from_position ( const Vector3 & p_pos , const Vector3 & p_target , const Vector3 & p_up = Vector3 ( 0 , 1 , 0 ) ) ;
2015-03-22 13:33:58 +00:00
2017-07-23 11:37:26 +00:00
Vector3 to_local ( Vector3 p_global ) const ;
Vector3 to_global ( Vector3 p_local ) const ;
2022-01-04 11:07:36 +00:00
void set_notify_transform ( bool p_enabled ) ;
2017-01-12 23:35:46 +00:00
bool is_transform_notification_enabled ( ) const ;
2022-01-04 11:07:36 +00:00
void set_notify_local_transform ( bool p_enabled ) ;
2015-09-16 01:07:03 +00:00
bool is_local_transform_notification_enabled ( ) const ;
2015-03-22 13:33:58 +00:00
void orthonormalize ( ) ;
2015-03-22 14:52:07 +00:00
void set_identity ( ) ;
2015-03-22 13:33:58 +00:00
2017-01-13 13:45:50 +00:00
void set_visible ( bool p_visible ) ;
2014-08-14 13:31:38 +00:00
void show ( ) ;
void hide ( ) ;
2022-01-04 11:07:36 +00:00
bool is_visible ( ) const ;
2017-01-13 13:45:50 +00:00
bool is_visible_in_tree ( ) const ;
2014-08-14 13:31:38 +00:00
2018-09-06 23:38:16 +00:00
void force_update_transform ( ) ;
2021-05-09 16:23:20 +00:00
void set_visibility_parent ( const NodePath & p_path ) ;
NodePath get_visibility_parent ( ) const ;
2020-03-26 21:49:16 +00:00
Node3D ( ) ;
2014-02-10 01:10:30 +00:00
} ;
2021-10-21 16:38:20 +00:00
VARIANT_ENUM_CAST ( Node3D : : RotationEditMode )
2020-03-26 21:49:16 +00:00
# endif // NODE_3D_H