Path: blob/master/editor/scene/3d/node_3d_editor_plugin.h
21337 views
/**************************************************************************/1/* node_3d_editor_plugin.h */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#pragma once3132#include "core/math/dynamic_bvh.h"33#include "editor/plugins/editor_plugin.h"34#include "editor/scene/3d/node_3d_editor_gizmos.h"35#include "editor/themes/editor_scale.h"36#include "scene/gui/box_container.h"37#include "scene/gui/button.h"38#include "scene/gui/spin_box.h"39#include "scene/resources/gradient.h"40#include "scene/resources/immediate_mesh.h"4142class AcceptDialog;43class CheckBox;44class ColorPickerButton;45class ConfirmationDialog;46class DirectionalLight3D;47class EditorData;48class EditorSelection;49class EditorSpinSlider;50class HSplitContainer;51class LineEdit;52class MenuButton;53class Node3DEditor;54class Node3DEditorViewport;55class OptionButton;56class PanelContainer;57class ProceduralSkyMaterial;58class SubViewport;59class SubViewportContainer;60class VSeparator;61class VSplitContainer;62class ViewportNavigationControl;63class WorldEnvironment;64class MeshInstance3D;6566class ViewportRotationControl : public Control {67GDCLASS(ViewportRotationControl, Control);6869struct Axis2D {70Vector2 screen_point;71float z_axis = -99.0;72int axis = -1;73bool is_positive = true;74};7576struct Axis2DCompare {77_FORCE_INLINE_ bool operator()(const Axis2D &l, const Axis2D &r) const {78return l.z_axis < r.z_axis;79}80};8182Node3DEditorViewport *viewport = nullptr;83Vector<Color> axis_colors;84Vector<int> axis_menu_options;85Vector2i orbiting_mouse_start;86Point2 original_mouse_pos;87int orbiting_index = -1;88int focused_axis = -2;89bool gizmo_activated = false;9091const float AXIS_CIRCLE_RADIUS = 8.0f * EDSCALE;9293protected:94void _notification(int p_what);95virtual void gui_input(const Ref<InputEvent> &p_event) override;96void _draw();97void _draw_axis(const Axis2D &p_axis);98void _get_sorted_axis(Vector<Axis2D> &r_axis);99void _update_focus();100void _process_click(int p_index, Vector2 p_position, bool p_pressed);101void _process_drag(Ref<InputEventWithModifiers> p_event, int p_index, Vector2 p_position, Vector2 p_relative_position);102103public:104void set_viewport(Node3DEditorViewport *p_viewport);105};106107class Node3DEditorViewport : public Control {108GDCLASS(Node3DEditorViewport, Control);109friend class Node3DEditor;110friend class ViewportNavigationControl;111friend class ViewportRotationControl;112enum {113VIEW_TOP,114VIEW_BOTTOM,115VIEW_LEFT,116VIEW_RIGHT,117VIEW_FRONT,118VIEW_REAR,119VIEW_CENTER_TO_ORIGIN,120VIEW_CENTER_TO_SELECTION,121VIEW_ALIGN_TRANSFORM_WITH_VIEW,122VIEW_ALIGN_ROTATION_WITH_VIEW,123VIEW_PERSPECTIVE,124VIEW_ENVIRONMENT,125VIEW_ORTHOGONAL,126VIEW_SWITCH_PERSPECTIVE_ORTHOGONAL,127VIEW_HALF_RESOLUTION,128VIEW_AUDIO_LISTENER,129VIEW_AUDIO_DOPPLER,130VIEW_GIZMOS,131VIEW_TRANSFORM_GIZMO,132VIEW_GRID,133VIEW_INFORMATION,134VIEW_FRAME_TIME,135136// < Keep in sync with menu.137VIEW_DISPLAY_NORMAL,138VIEW_DISPLAY_WIREFRAME,139VIEW_DISPLAY_OVERDRAW,140VIEW_DISPLAY_LIGHTING,141VIEW_DISPLAY_UNSHADED,142VIEW_DISPLAY_ADVANCED,143// Advanced menu:144VIEW_DISPLAY_DEBUG_PSSM_SPLITS,145VIEW_DISPLAY_NORMAL_BUFFER,146VIEW_DISPLAY_DEBUG_SHADOW_ATLAS,147VIEW_DISPLAY_DEBUG_DIRECTIONAL_SHADOW_ATLAS,148VIEW_DISPLAY_DEBUG_DECAL_ATLAS,149VIEW_DISPLAY_DEBUG_VOXEL_GI_ALBEDO,150VIEW_DISPLAY_DEBUG_VOXEL_GI_LIGHTING,151VIEW_DISPLAY_DEBUG_VOXEL_GI_EMISSION,152VIEW_DISPLAY_DEBUG_SDFGI,153VIEW_DISPLAY_DEBUG_SDFGI_PROBES,154VIEW_DISPLAY_DEBUG_SCENE_LUMINANCE,155VIEW_DISPLAY_DEBUG_SSAO,156VIEW_DISPLAY_DEBUG_SSIL,157VIEW_DISPLAY_DEBUG_GI_BUFFER,158VIEW_DISPLAY_DEBUG_DISABLE_LOD,159VIEW_DISPLAY_DEBUG_CLUSTER_OMNI_LIGHTS,160VIEW_DISPLAY_DEBUG_CLUSTER_SPOT_LIGHTS,161VIEW_DISPLAY_DEBUG_CLUSTER_DECALS,162VIEW_DISPLAY_DEBUG_CLUSTER_REFLECTION_PROBES,163VIEW_DISPLAY_DEBUG_OCCLUDERS,164VIEW_DISPLAY_MOTION_VECTORS,165VIEW_DISPLAY_INTERNAL_BUFFER,166VIEW_DISPLAY_MAX,167// > Keep in sync with menu.168169VIEW_LOCK_ROTATION,170VIEW_CINEMATIC_PREVIEW,171VIEW_AUTO_ORTHOGONAL,172VIEW_MAX173};174175enum ViewType {176VIEW_TYPE_USER,177VIEW_TYPE_TOP,178VIEW_TYPE_BOTTOM,179VIEW_TYPE_LEFT,180VIEW_TYPE_RIGHT,181VIEW_TYPE_FRONT,182VIEW_TYPE_REAR,183};184185public:186static constexpr int32_t GIZMO_BASE_LAYER = 27;187static constexpr int32_t GIZMO_EDIT_LAYER = 26;188static constexpr int32_t GIZMO_GRID_LAYER = 25;189static constexpr int32_t MISC_TOOL_LAYER = 24;190191static constexpr int32_t FRAME_TIME_HISTORY = 20;192193enum NavigationScheme {194NAVIGATION_GODOT = 0,195NAVIGATION_MAYA = 1,196NAVIGATION_MODO = 2,197NAVIGATION_CUSTOM = 3,198NAVIGATION_TABLET = 4,199};200201enum FreelookNavigationScheme {202FREELOOK_DEFAULT,203FREELOOK_PARTIALLY_AXIS_LOCKED,204FREELOOK_FULLY_AXIS_LOCKED,205};206207enum ViewportNavMouseButton {208NAVIGATION_LEFT_MOUSE,209NAVIGATION_MIDDLE_MOUSE,210NAVIGATION_RIGHT_MOUSE,211NAVIGATION_MOUSE_4,212NAVIGATION_MOUSE_5,213};214215private:216double cpu_time_history[FRAME_TIME_HISTORY];217int cpu_time_history_index;218double gpu_time_history[FRAME_TIME_HISTORY];219int gpu_time_history_index;220221Node *ruler = nullptr;222Node3D *ruler_start_point = nullptr;223Node3D *ruler_end_point = nullptr;224Ref<ImmediateMesh> geometry;225MeshInstance3D *ruler_line = nullptr;226MeshInstance3D *ruler_line_xray = nullptr;227Label *ruler_label = nullptr;228Ref<StandardMaterial3D> ruler_material;229Ref<StandardMaterial3D> ruler_material_xray;230231int index;232ViewType view_type;233void _menu_option(int p_option);234void _set_auto_orthogonal();235Node3D *preview_node = nullptr;236bool update_preview_node = false;237Point2 preview_node_viewport_pos;238Vector3 preview_node_pos;239AABB *preview_bounds = nullptr;240Vector<String> selected_files;241AcceptDialog *accept = nullptr;242243Node *target_node = nullptr;244Point2 drop_pos;245246EditorSelection *editor_selection = nullptr;247248Button *translation_preview_button = nullptr;249CheckBox *preview_camera = nullptr;250SubViewportContainer *subviewport_container = nullptr;251252MenuButton *view_display_menu = nullptr;253PopupMenu *display_submenu = nullptr;254255Control *surface = nullptr;256SubViewport *viewport = nullptr;257Camera3D *camera = nullptr;258bool transforming = false;259bool orthogonal;260bool auto_orthogonal;261bool lock_rotation;262bool transform_gizmo_visible = true;263bool collision_reposition = false;264real_t gizmo_scale;265266bool freelook_active;267real_t freelook_speed;268Vector2 previous_mouse_position;269270PanelContainer *info_panel = nullptr;271Label *info_label = nullptr;272Label *cinema_label = nullptr;273Label *locked_label = nullptr;274Label *zoom_limit_label = nullptr;275276Label *preview_material_label = nullptr;277Label *preview_material_label_desc = nullptr;278279VBoxContainer *top_right_vbox = nullptr;280VBoxContainer *bottom_center_vbox = nullptr;281ViewportNavigationControl *position_control = nullptr;282ViewportNavigationControl *look_control = nullptr;283ViewportRotationControl *rotation_control = nullptr;284Gradient *frame_time_gradient = nullptr;285PanelContainer *frame_time_panel = nullptr;286VBoxContainer *frame_time_vbox = nullptr;287Label *cpu_time_label = nullptr;288Label *gpu_time_label = nullptr;289Label *fps_label = nullptr;290291struct _RayResult {292Node3D *item = nullptr;293real_t depth = 0;294_FORCE_INLINE_ bool operator<(const _RayResult &p_rr) const { return depth < p_rr.depth; }295};296297void _update_name();298void _compute_edit(const Point2 &p_point);299void _clear_selected();300bool _is_rotation_arc_visible() const;301void _select_clicked(bool p_allow_locked);302ObjectID _select_ray(const Point2 &p_pos) const;303void _find_items_at_pos(const Point2 &p_pos, Vector<_RayResult> &r_results, bool p_include_locked);304305Transform3D _get_camera_transform() const;306int get_selected_count() const;307void cancel_transform();308void _update_shrink();309310Vector3 _get_camera_position() const;311Vector3 _get_camera_normal() const;312Vector3 _get_screen_to_space(const Vector3 &p_vector3);313314void _select_region();315bool _transform_gizmo_select(const Vector2 &p_screenpos, bool p_highlight_only = false);316void _transform_gizmo_apply(Node3D *p_node, const Transform3D &p_transform, bool p_local);317318void _nav_pan(Ref<InputEventWithModifiers> p_event, const Vector2 &p_relative);319void _nav_zoom(Ref<InputEventWithModifiers> p_event, const Vector2 &p_relative);320void _nav_orbit(Ref<InputEventWithModifiers> p_event, const Vector2 &p_relative);321void _nav_look(Ref<InputEventWithModifiers> p_event, const Vector2 &p_relative);322323bool _is_shortcut_empty(const String &p_name);324bool _is_nav_modifier_pressed(const String &p_name);325int _get_shortcut_input_count(const String &p_name);326327float get_znear() const;328float get_zfar() const;329float get_fov() const;330331ObjectID clicked;332ObjectID material_target;333Vector<Node3D *> selection_results;334Vector<Node3D *> selection_results_menu;335bool clicked_wants_append = false;336bool selection_in_progress = false;337bool movement_threshold_passed = false;338339PopupMenu *selection_menu = nullptr;340341enum NavigationZoomStyle {342NAVIGATION_ZOOM_VERTICAL,343NAVIGATION_ZOOM_HORIZONTAL344};345346enum NavigationMode {347NAVIGATION_NONE,348NAVIGATION_PAN,349NAVIGATION_ZOOM,350NAVIGATION_ORBIT,351NAVIGATION_LOOK,352NAVIGATION_MOVE353};354enum TransformMode {355TRANSFORM_NONE,356TRANSFORM_ROTATE,357TRANSFORM_TRANSLATE,358TRANSFORM_SCALE359};360enum TransformPlane {361TRANSFORM_VIEW,362TRANSFORM_X_AXIS,363TRANSFORM_Y_AXIS,364TRANSFORM_Z_AXIS,365TRANSFORM_YZ,366TRANSFORM_XZ,367TRANSFORM_XY,368};369enum TransformType {370POSITION,371ROTATION,372SCALE,373};374375struct EditData {376TransformMode mode;377TransformPlane plane;378Transform3D original;379Vector3 click_ray;380Vector3 click_ray_pos;381Vector3 center;382Point2 mouse_pos;383Point2 original_mouse_pos;384bool snap = false;385bool show_rotation_line = false;386bool is_trackball = false;387Ref<EditorNode3DGizmo> gizmo;388int gizmo_handle = 0;389bool gizmo_handle_secondary = false;390Variant gizmo_initial_value;391bool original_local;392bool instant;393394// Numeric blender-style transforms (e.g. 'g5x').395// numeric_input tracks the current input value, e.g. 1.23.396// numeric_negate indicates whether '-' has been pressed to negate the value397// while numeric_next_decimal is 0, numbers are input before the decimal point398// after pressing '.', numeric next decimal changes to -1, and decrements after each press.399double numeric_input = 0.0;400bool numeric_negate = false;401int numeric_next_decimal = 0;402403Vector3 rotation_axis;404Vector3 view_axis_local;405double accumulated_rotation_angle = 0.0;406double display_rotation_angle = 0.0;407Vector3 initial_click_vector;408Vector3 previous_rotation_vector;409bool gizmo_initiated = false;410} _edit;411412struct Cursor {413Vector3 pos;414real_t x_rot, y_rot, distance, fov_scale;415real_t unsnapped_x_rot, unsnapped_y_rot;416Vector3 eye_pos; // Used in freelook mode417bool region_select;418Point2 region_begin, region_end;419420Cursor() {421// These rotations place the camera in +X +Y +Z, aka south east, facing north west.422x_rot = 0.5;423y_rot = -0.5;424unsnapped_x_rot = x_rot;425unsnapped_y_rot = y_rot;426distance = 4;427fov_scale = 1.0;428region_select = false;429}430};431// Viewport camera supports movement smoothing,432// so one cursor is the real cursor, while the other can be an interpolated version.433Cursor cursor; // Immediate cursor434Cursor camera_cursor; // That one may be interpolated (don't modify this one except for smoothing purposes)435Cursor previous_cursor; // Storing previous cursor state for canceling purposes436437void scale_fov(real_t p_fov_offset);438void reset_fov();439void scale_cursor_distance(real_t scale);440441struct ShortcutCheckSet {442bool mod_pressed = false;443bool shortcut_not_empty = true;444int input_count = 0;445ViewportNavMouseButton mouse_preference = NAVIGATION_LEFT_MOUSE;446NavigationMode result_nav_mode = NAVIGATION_NONE;447448ShortcutCheckSet() {}449450ShortcutCheckSet(bool p_mod_pressed, bool p_shortcut_not_empty, int p_input_count, const ViewportNavMouseButton &p_mouse_preference, const NavigationMode &p_result_nav_mode) :451mod_pressed(p_mod_pressed), shortcut_not_empty(p_shortcut_not_empty), input_count(p_input_count), mouse_preference(p_mouse_preference), result_nav_mode(p_result_nav_mode) {452}453};454455struct ShortcutCheckSetComparator {456_FORCE_INLINE_ bool operator()(const ShortcutCheckSet &A, const ShortcutCheckSet &B) const {457return A.input_count > B.input_count;458}459};460461NavigationMode _get_nav_mode_from_shortcut_check(ViewportNavMouseButton p_mouse_button, Vector<ShortcutCheckSet> p_shortcut_check_sets, bool p_use_not_empty);462463void set_freelook_active(bool active_now);464void scale_freelook_speed(real_t scale);465466real_t zoom_indicator_delay;467int zoom_failed_attempts_count = 0;468469RID move_gizmo_instance[3], move_plane_gizmo_instance[3], rotate_gizmo_instance[4], scale_gizmo_instance[3], scale_plane_gizmo_instance[3], axis_gizmo_instance[3];470RID trackball_sphere_instance;471472String last_message;473String message;474double message_time;475476void set_message(const String &p_message, float p_time = 5);477478void _view_settings_confirmed(real_t p_interp_delta);479void _update_camera(real_t p_interp_delta);480void _update_navigation_controls_visibility();481Transform3D to_camera_transform(const Cursor &p_cursor) const;482void _draw();483484// These allow tool scripts to set the 3D cursor location by updating the camera transform.485Transform3D last_camera_transform;486bool _camera_moved_externally();487void _apply_camera_transform_to_cursor();488489void _surface_mouse_enter();490void _surface_mouse_exit();491void _surface_focus_enter();492void _surface_focus_exit();493494void input(const Ref<InputEvent> &p_event) override;495void _sinput(const Ref<InputEvent> &p_event);496void _update_freelook(real_t delta);497Node3DEditor *spatial_editor = nullptr;498499Camera3D *previewing = nullptr;500Camera3D *preview = nullptr;501502bool previewing_camera = false;503bool previewing_cinema = false;504bool _is_node_locked(const Node *p_node) const;505void _preview_exited_scene();506void _preview_camera_property_changed();507void _update_centered_labels();508void _toggle_camera_preview(bool);509void _toggle_cinema_preview(bool);510void _init_gizmo_instance(int p_idx);511void _finish_gizmo_instances();512void _selection_result_pressed(int);513void _selection_menu_hide();514void _list_select(Ref<InputEventMouseButton> b);515Point2 _get_warped_mouse_motion(const Ref<InputEventMouseMotion> &p_ev_mouse_motion) const;516517Vector3 _get_instance_position(const Point2 &p_pos, Node3D *p_node) const;518static AABB _calculate_spatial_bounds(const Node3D *p_parent, bool p_omit_top_level = false, const Transform3D *p_bounds_orientation = nullptr);519520Node *_sanitize_preview_node(Node *p_node) const;521522void _create_preview_node(const Vector<String> &files) const;523void _remove_preview_node();524bool _apply_preview_material(ObjectID p_target, const Point2 &p_point) const;525void _reset_preview_material() const;526void _remove_preview_material();527bool _cyclical_dependency_exists(const String &p_target_scene_path, Node *p_desired_node) const;528bool _create_instance(Node *p_parent, const String &p_path, const Point2 &p_point);529bool _create_audio_node(Node *p_parent, const String &p_path, const Point2 &p_point);530void _perform_drop_data();531532bool can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from);533void drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from);534535void _project_settings_changed();536537Transform3D _compute_transform(TransformMode p_mode, const Transform3D &p_original, const Transform3D &p_original_local, Vector3 p_motion, double p_extra, bool p_local, bool p_orthogonal, bool p_view_axis);538539void _reset_transform(TransformType p_type);540541void begin_transform(TransformMode p_mode, bool instant);542void commit_transform();543void apply_transform(Vector3 p_motion, double p_snap);544void update_transform(bool p_shift);545void update_transform_numeric();546void finish_transform();547548void register_shortcut_action(const String &p_path, const String &p_name, Key p_keycode, bool p_physical = false);549void shortcut_changed_callback(const Ref<Shortcut> p_shortcut, const String &p_shortcut_path);550551// Supported rendering methods for advanced debug draw mode items.552enum SupportedRenderingMethods {553ALL,554FORWARD_PLUS,555FORWARD_PLUS_MOBILE,556};557558void _set_lock_view_rotation(bool p_lock_rotation);559void _add_advanced_debug_draw_mode_item(PopupMenu *p_popup, const String &p_name, int p_value, SupportedRenderingMethods p_rendering_methods = SupportedRenderingMethods::ALL, const String &p_tooltip = "");560561protected:562void _notification(int p_what);563static void _bind_methods();564565public:566void update_surface() { surface->queue_redraw(); }567void update_transform_gizmo_view();568569void set_can_preview(Camera3D *p_preview);570void set_state(const Dictionary &p_state);571Dictionary get_state() const;572void reset();573bool is_freelook_active() const { return freelook_active; }574575Vector3 get_ray_pos(const Vector2 &p_pos) const;576Vector3 get_ray(const Vector2 &p_pos) const;577Point2 point_to_screen(const Vector3 &p_point);578579void focus_selection();580581void assign_pending_data_pointers(582Node3D *p_preview_node,583AABB *p_preview_bounds,584AcceptDialog *p_accept);585586SubViewport *get_viewport_node() { return viewport; }587Camera3D *get_camera_3d() { return camera; } // return the default camera object.588Control *get_surface() { return surface; }589590Node3DEditorViewport(Node3DEditor *p_spatial_editor, int p_index);591~Node3DEditorViewport();592};593594class Node3DEditorSelectedItem : public Object {595GDCLASS(Node3DEditorSelectedItem, Object);596597public:598AABB aabb;599Transform3D original; // original location when moving600Transform3D original_local;601Transform3D last_xform; // last transform602bool last_xform_dirty;603Node3D *sp = nullptr;604RID sbox_instance;605RID sbox_instance_offset;606RID sbox_instance_xray;607RID sbox_instance_xray_offset;608Ref<EditorNode3DGizmo> gizmo;609HashMap<int, Transform3D> subgizmos; // Key: Subgizmo ID, Value: Initial subgizmo transform.610611Node3DEditorSelectedItem() {612sp = nullptr;613last_xform_dirty = true;614}615~Node3DEditorSelectedItem();616};617618class Node3DEditorViewportContainer : public Container {619GDCLASS(Node3DEditorViewportContainer, Container);620621public:622enum View {623VIEW_USE_1_VIEWPORT,624VIEW_USE_2_VIEWPORTS,625VIEW_USE_2_VIEWPORTS_ALT,626VIEW_USE_3_VIEWPORTS,627VIEW_USE_3_VIEWPORTS_ALT,628VIEW_USE_4_VIEWPORTS,629};630631private:632View view;633bool mouseover;634real_t ratio_h;635real_t ratio_v;636637bool hovering_v;638bool hovering_h;639640bool dragging_v;641bool dragging_h;642Vector2 drag_begin_pos;643Vector2 drag_begin_ratio;644645virtual void gui_input(const Ref<InputEvent> &p_event) override;646647protected:648void _notification(int p_what);649650public:651void set_view(View p_view);652View get_view();653654Node3DEditorViewportContainer();655};656657class Node3DEditor : public VBoxContainer {658GDCLASS(Node3DEditor, VBoxContainer);659660public:661static const unsigned int VIEWPORTS_COUNT = 4;662663enum ToolMode {664TOOL_MODE_TRANSFORM,665TOOL_MODE_MOVE,666TOOL_MODE_ROTATE,667TOOL_MODE_SCALE,668TOOL_MODE_SELECT,669TOOL_MODE_LIST_SELECT,670TOOL_LOCK_SELECTED,671TOOL_UNLOCK_SELECTED,672TOOL_GROUP_SELECTED,673TOOL_UNGROUP_SELECTED,674TOOL_RULER,675TOOL_MAX676};677678enum ToolOptions {679TOOL_OPT_LOCAL_COORDS,680TOOL_OPT_USE_SNAP,681TOOL_OPT_USE_TRACKBALL,682TOOL_OPT_MAX683};684685enum TransformMode {686TRANSFORM_MODE_GLOBAL = 1,687TRANSFORM_MODE_LOCAL = 2,688};689690real_t gizmo_view_rotation_scale = 1.0;691real_t gizmo_view_rotation_shrink = 1.0;692693private:694EditorSelection *editor_selection = nullptr;695696Node3DEditorViewportContainer *viewport_base = nullptr;697Node3DEditorViewport *viewports[VIEWPORTS_COUNT];698int last_used_viewport = 0;699700VSplitContainer *shader_split = nullptr;701HSplitContainer *left_panel_split = nullptr;702HSplitContainer *right_panel_split = nullptr;703704/////705706ToolMode tool_mode = TOOL_MODE_TRANSFORM;707708RID origin_mesh;709RID origin_multimesh;710RID origin_instance;711bool origin_enabled = false;712RID grid[3];713RID grid_instance[3];714bool grid_visible[3] = { false, false, false }; //currently visible715bool grid_enable[3] = { false, false, false }; //should be always visible if true716bool grid_enabled = false;717bool grid_init_draw = false;718Camera3D::ProjectionType grid_camera_last_update_perspective = Camera3D::PROJECTION_PERSPECTIVE;719Vector3 grid_camera_last_update_position;720721Ref<ArrayMesh> move_gizmo[3], move_plane_gizmo[3], rotate_gizmo[4], scale_gizmo[3], scale_plane_gizmo[3], axis_gizmo[3];722Ref<ArrayMesh> trackball_sphere_gizmo;723Ref<StandardMaterial3D> gizmo_color[3];724Ref<StandardMaterial3D> plane_gizmo_color[3];725Ref<ShaderMaterial> rotate_gizmo_color[4];726Ref<StandardMaterial3D> gizmo_color_hl[3];727Ref<StandardMaterial3D> plane_gizmo_color_hl[3];728Ref<ShaderMaterial> rotate_gizmo_color_hl[4];729Ref<StandardMaterial3D> trackball_sphere_material;730Ref<StandardMaterial3D> trackball_sphere_material_hl;731732Ref<Node3DGizmo> current_hover_gizmo;733int current_hover_gizmo_handle;734bool current_hover_gizmo_handle_secondary;735736DynamicBVH gizmo_bvh;737738real_t snap_translate_value;739real_t snap_rotate_value;740real_t snap_scale_value;741742Ref<ArrayMesh> active_selection_box_xray;743Ref<ArrayMesh> active_selection_box;744Ref<ArrayMesh> selection_box_xray;745Ref<ArrayMesh> selection_box;746747Ref<StandardMaterial3D> selection_box_mat = memnew(StandardMaterial3D);748Ref<StandardMaterial3D> selection_box_mat_xray = memnew(StandardMaterial3D);749Ref<StandardMaterial3D> active_selection_box_mat = memnew(StandardMaterial3D);750Ref<StandardMaterial3D> active_selection_box_mat_xray = memnew(StandardMaterial3D);751752RID indicators;753RID indicators_instance;754RID cursor_mesh;755RID cursor_instance;756Ref<ShaderMaterial> origin_mat;757Ref<ShaderMaterial> grid_mat[3];758Ref<StandardMaterial3D> cursor_material;759760// Scene drag and drop support761Node3D *preview_node = nullptr;762AABB preview_bounds;763764Ref<Material> preview_material;765Ref<Material> preview_reset_material;766ObjectID preview_material_target;767int preview_material_surface = -1;768769struct Gizmo {770bool visible = false;771real_t scale = 0;772Transform3D transform;773} gizmo;774775enum MenuOption {776MENU_TOOL_TRANSFORM,777MENU_TOOL_MOVE,778MENU_TOOL_ROTATE,779MENU_TOOL_SCALE,780MENU_TOOL_SELECT,781MENU_TOOL_LIST_SELECT,782MENU_TOOL_LOCAL_COORDS,783MENU_TOOL_USE_SNAP,784MENU_TOOL_USE_TRACKBALL,785MENU_TRANSFORM_CONFIGURE_SNAP,786MENU_TRANSFORM_DIALOG,787MENU_VIEW_USE_1_VIEWPORT,788MENU_VIEW_USE_2_VIEWPORTS,789MENU_VIEW_USE_2_VIEWPORTS_ALT,790MENU_VIEW_USE_3_VIEWPORTS,791MENU_VIEW_USE_3_VIEWPORTS_ALT,792MENU_VIEW_USE_4_VIEWPORTS,793MENU_VIEW_ORIGIN,794MENU_VIEW_GRID,795MENU_VIEW_GIZMOS_3D_ICONS,796MENU_VIEW_CAMERA_SETTINGS,797MENU_LOCK_SELECTED,798MENU_UNLOCK_SELECTED,799MENU_GROUP_SELECTED,800MENU_UNGROUP_SELECTED,801MENU_SNAP_TO_FLOOR,802MENU_RULER,803};804805Button *tool_button[TOOL_MAX];806Button *tool_option_button[TOOL_OPT_MAX];807808MenuButton *transform_menu = nullptr;809PopupMenu *gizmos_menu = nullptr;810MenuButton *view_layout_menu = nullptr;811812AcceptDialog *accept = nullptr;813814ConfirmationDialog *snap_dialog = nullptr;815ConfirmationDialog *xform_dialog = nullptr;816ConfirmationDialog *settings_dialog = nullptr;817818bool snap_enabled = false;819bool snap_key_enabled = false;820EditorSpinSlider *snap_translate = nullptr;821EditorSpinSlider *snap_rotate = nullptr;822EditorSpinSlider *snap_scale = nullptr;823824bool trackball_enabled = false;825826LineEdit *xform_translate[3];827LineEdit *xform_rotate[3];828LineEdit *xform_scale[3];829OptionButton *xform_type = nullptr;830831VBoxContainer *settings_vbc = nullptr;832SpinBox *settings_fov = nullptr;833SpinBox *settings_znear = nullptr;834SpinBox *settings_zfar = nullptr;835836void _snap_changed();837void _snap_update();838void _xform_dialog_action();839void _menu_item_pressed(int p_option);840void _menu_item_toggled(bool pressed, int p_option);841void _menu_gizmo_toggled(int p_option);842// Used for secondary menu items which are displayed depending on the currently selected node843// (such as MeshInstance's "Mesh" menu).844PanelContainer *context_toolbar_panel = nullptr;845HBoxContainer *context_toolbar_hbox = nullptr;846HashMap<Control *, VSeparator *> context_toolbar_separators;847848void _update_context_toolbar();849850void _generate_selection_boxes();851852void _init_indicators();853void _update_gizmos_menu();854void _update_gizmos_menu_theme();855void _init_grid();856void _finish_indicators();857void _finish_grid();858859void _toggle_maximize_view(Object *p_viewport);860void _viewport_clicked(int p_viewport_idx);861862Node *custom_camera = nullptr;863864Object *_get_editor_data(Object *p_what);865866Ref<Environment> viewport_environment;867868Node3D *selected = nullptr;869870Node3DEditorViewport *freelook_viewport = nullptr;871872void _request_gizmo(Object *p_obj);873void _request_gizmo_for_id(ObjectID p_id);874void _set_subgizmo_selection(Object *p_obj, Ref<Node3DGizmo> p_gizmo, int p_id, Transform3D p_transform = Transform3D());875void _clear_subgizmo_selection(Object *p_obj = nullptr);876877bool gizmos_dirty = false;878879static Node3DEditor *singleton;880881void _node_added(Node *p_node);882void _node_removed(Node *p_node);883Vector<Ref<EditorNode3DGizmoPlugin>> gizmo_plugins_by_priority;884Vector<Ref<EditorNode3DGizmoPlugin>> gizmo_plugins_by_name;885886void _register_all_gizmos();887888void _selection_changed();889void _refresh_menu_icons();890891bool do_snap_selected_nodes_to_floor = false;892void _snap_selected_nodes_to_floor();893894// Preview Sun and Environment895896class PreviewSunEnvPopup : public PopupPanel {897GDCLASS(PreviewSunEnvPopup, PopupPanel);898899protected:900virtual void shortcut_input(const Ref<InputEvent> &p_event) override;901};902903uint32_t world_env_count = 0;904uint32_t directional_light_count = 0;905906Button *sun_button = nullptr;907Label *sun_state = nullptr;908Label *sun_title = nullptr;909VBoxContainer *sun_vb = nullptr;910Popup *sun_environ_popup = nullptr;911Control *sun_direction = nullptr;912EditorSpinSlider *sun_angle_altitude = nullptr;913EditorSpinSlider *sun_angle_azimuth = nullptr;914ColorPickerButton *sun_color = nullptr;915EditorSpinSlider *sun_energy = nullptr;916EditorSpinSlider *sun_shadow_max_distance = nullptr;917Button *sun_add_to_scene = nullptr;918919Vector2 sun_rotation;920921Ref<Shader> sun_direction_shader;922Ref<ShaderMaterial> sun_direction_material;923924Button *environ_button = nullptr;925Label *environ_state = nullptr;926Label *environ_title = nullptr;927VBoxContainer *environ_vb = nullptr;928ColorPickerButton *environ_sky_color = nullptr;929ColorPickerButton *environ_ground_color = nullptr;930EditorSpinSlider *environ_energy = nullptr;931Button *environ_ao_button = nullptr;932Button *environ_glow_button = nullptr;933Button *environ_tonemap_button = nullptr;934Button *environ_gi_button = nullptr;935Button *environ_add_to_scene = nullptr;936937Button *sun_environ_settings = nullptr;938939DirectionalLight3D *preview_sun = nullptr;940bool preview_sun_dangling = false;941WorldEnvironment *preview_environment = nullptr;942bool preview_env_dangling = false;943Ref<Environment> environment;944Ref<CameraAttributesPractical> camera_attributes;945Ref<ProceduralSkyMaterial> sky_material;946947bool sun_environ_updating = false;948949void _sun_direction_draw();950void _sun_direction_input(const Ref<InputEvent> &p_event);951void _sun_direction_set_altitude(float p_altitude);952void _sun_direction_set_azimuth(float p_azimuth);953void _sun_set_color(const Color &p_color);954void _sun_set_energy(float p_energy);955void _sun_set_shadow_max_distance(float p_shadow_max_distance);956957void _environ_set_sky_color(const Color &p_color);958void _environ_set_ground_color(const Color &p_color);959void _environ_set_sky_energy(float p_energy);960void _environ_set_ao();961void _environ_set_glow();962void _environ_set_tonemap();963void _environ_set_gi();964965void _load_default_preview_settings();966void _update_preview_environment();967968void _preview_settings_changed();969void _sun_environ_settings_pressed();970971void _add_sun_to_scene(bool p_already_added_environment = false);972void _add_environment_to_scene(bool p_already_added_sun = false);973974void _update_theme();975976protected:977void _notification(int p_what);978//void _gui_input(InputEvent p_event);979virtual void shortcut_input(const Ref<InputEvent> &p_event) override;980981static void _bind_methods();982983public:984static Node3DEditor *get_singleton() { return singleton; }985986static Size2i get_camera_viewport_size(Camera3D *p_camera);987988Vector3 snap_point(Vector3 p_target, Vector3 p_start = Vector3(0, 0, 0)) const;989990float get_znear() const { return settings_znear->get_value(); }991float get_zfar() const { return settings_zfar->get_value(); }992float get_fov() const { return settings_fov->get_value(); }993994Transform3D get_gizmo_transform() const { return gizmo.transform; }995bool is_gizmo_visible() const;996997ToolMode get_tool_mode() const { return tool_mode; }998bool are_local_coords_enabled() const { return tool_option_button[Node3DEditor::TOOL_OPT_LOCAL_COORDS]->is_pressed(); }999void set_local_coords_enabled(bool on) const { tool_option_button[Node3DEditor::TOOL_OPT_LOCAL_COORDS]->set_pressed(on); }1000bool is_snap_enabled() const { return snap_enabled ^ snap_key_enabled; }1001real_t get_translate_snap() const;1002real_t get_rotate_snap() const;1003real_t get_scale_snap() const;10041005bool is_trackball_enabled() const { return trackball_enabled; }10061007Ref<ArrayMesh> get_move_gizmo(int idx) const { return move_gizmo[idx]; }1008Ref<ArrayMesh> get_axis_gizmo(int idx) const { return axis_gizmo[idx]; }1009Ref<ArrayMesh> get_move_plane_gizmo(int idx) const { return move_plane_gizmo[idx]; }1010Ref<ArrayMesh> get_rotate_gizmo(int idx) const { return rotate_gizmo[idx]; }1011Ref<ArrayMesh> get_scale_gizmo(int idx) const { return scale_gizmo[idx]; }1012Ref<ArrayMesh> get_scale_plane_gizmo(int idx) const { return scale_plane_gizmo[idx]; }1013Ref<ArrayMesh> get_trackball_sphere_gizmo() const { return trackball_sphere_gizmo; }10141015void update_grid();1016void update_transform_gizmo();1017void update_all_gizmos(Node *p_node = nullptr);1018void update_gizmo_opacity();1019void snap_selected_nodes_to_floor();1020void select_gizmo_highlight_axis(int p_axis);1021void set_custom_camera(Node *p_camera) { custom_camera = p_camera; }10221023Dictionary get_state() const;1024void set_state(const Dictionary &p_state);10251026Ref<Environment> get_viewport_environment() { return viewport_environment; }10271028void add_control_to_menu_panel(Control *p_control);1029void remove_control_from_menu_panel(Control *p_control);10301031void add_control_to_left_panel(Control *p_control);1032void remove_control_from_left_panel(Control *p_control);10331034void add_control_to_right_panel(Control *p_control);1035void remove_control_from_right_panel(Control *p_control);10361037void move_control_to_left_panel(Control *p_control);1038void move_control_to_right_panel(Control *p_control);10391040VSplitContainer *get_shader_split();10411042Node3D *get_single_selected_node() { return selected; }1043bool is_current_selected_gizmo(const EditorNode3DGizmo *p_gizmo);1044bool is_subgizmo_selected(int p_id);1045Vector<int> get_subgizmo_selection();1046void clear_subgizmo_selection(Object *p_obj = nullptr);1047void refresh_dirty_gizmos();10481049Ref<EditorNode3DGizmo> get_current_hover_gizmo() const { return current_hover_gizmo; }1050void set_current_hover_gizmo(Ref<EditorNode3DGizmo> p_gizmo) { current_hover_gizmo = p_gizmo; }10511052void set_current_hover_gizmo_handle(int p_id, bool p_secondary) {1053current_hover_gizmo_handle = p_id;1054current_hover_gizmo_handle_secondary = p_secondary;1055}10561057int get_current_hover_gizmo_handle(bool &r_secondary) const {1058r_secondary = current_hover_gizmo_handle_secondary;1059return current_hover_gizmo_handle;1060}10611062void set_can_preview(Camera3D *p_preview);10631064void set_preview_material(Ref<Material> p_material) { preview_material = p_material; }1065Ref<Material> get_preview_material() { return preview_material; }1066void set_preview_reset_material(Ref<Material> p_material) { preview_reset_material = p_material; }1067Ref<Material> get_preview_reset_material() const { return preview_reset_material; }1068void set_preview_material_target(ObjectID p_object_id) { preview_material_target = p_object_id; }1069ObjectID get_preview_material_target() const { return preview_material_target; }1070void set_preview_material_surface(int p_surface) { preview_material_surface = p_surface; }1071int get_preview_material_surface() const { return preview_material_surface; }10721073Node3DEditorViewport *get_editor_viewport(int p_idx) {1074ERR_FAIL_INDEX_V(p_idx, static_cast<int>(VIEWPORTS_COUNT), nullptr);1075return viewports[p_idx];1076}1077Node3DEditorViewport *get_last_used_viewport();10781079void set_freelook_viewport(Node3DEditorViewport *p_viewport) { freelook_viewport = p_viewport; }1080Node3DEditorViewport *get_freelook_viewport() const { return freelook_viewport; }10811082void add_gizmo_plugin(Ref<EditorNode3DGizmoPlugin> p_plugin);1083void remove_gizmo_plugin(Ref<EditorNode3DGizmoPlugin> p_plugin);10841085DynamicBVH::ID insert_gizmo_bvh_node(Node3D *p_node, const AABB &p_aabb);1086void update_gizmo_bvh_node(DynamicBVH::ID p_id, const AABB &p_aabb);1087void remove_gizmo_bvh_node(DynamicBVH::ID p_id);1088Vector<Node3D *> gizmo_bvh_ray_query(const Vector3 &p_ray_start, const Vector3 &p_ray_end);1089Vector<Node3D *> gizmo_bvh_frustum_query(const Vector<Plane> &p_frustum);10901091void edit(Node3D *p_spatial);1092void clear();10931094Node3DEditor();1095~Node3DEditor();1096};10971098class Node3DEditorPlugin : public EditorPlugin {1099GDCLASS(Node3DEditorPlugin, EditorPlugin);11001101Node3DEditor *spatial_editor = nullptr;11021103public:1104Node3DEditor *get_spatial_editor() { return spatial_editor; }1105virtual String get_plugin_name() const override { return TTRC("3D"); }1106bool has_main_screen() const override { return true; }1107virtual void make_visible(bool p_visible) override;1108virtual void edit(Object *p_object) override;1109virtual bool handles(Object *p_object) const override;11101111virtual Dictionary get_state() const override;1112virtual void set_state(const Dictionary &p_state) override;1113virtual void clear() override { spatial_editor->clear(); }11141115virtual void edited_scene_changed() override;11161117Node3DEditorPlugin();1118};11191120class ViewportNavigationControl : public Control {1121GDCLASS(ViewportNavigationControl, Control);11221123Node3DEditorViewport *viewport = nullptr;1124Vector2i focused_mouse_start;1125Vector2 focused_pos;1126bool hovered = false;1127int focused_index = -1;1128Node3DEditorViewport::NavigationMode nav_mode = Node3DEditorViewport::NavigationMode::NAVIGATION_NONE;11291130const float AXIS_CIRCLE_RADIUS = 30.0f * EDSCALE;11311132protected:1133void _notification(int p_what);1134virtual void gui_input(const Ref<InputEvent> &p_event) override;1135void _draw();1136void _process_click(int p_index, Vector2 p_position, bool p_pressed);1137void _process_drag(int p_index, Vector2 p_position, Vector2 p_relative_position);1138void _update_navigation();11391140public:1141void set_navigation_mode(Node3DEditorViewport::NavigationMode p_nav_mode);1142void set_viewport(Node3DEditorViewport *p_viewport);1143};114411451146