Path: blob/master/editor/scene/canvas_item_editor_plugin.h
21547 views
/**************************************************************************/1/* canvas_item_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 "editor/plugins/editor_plugin.h"33#include "scene/gui/box_container.h"3435class AcceptDialog;36class Button;37class ButtonGroup;38class CanvasItemEditorViewport;39class ConfirmationDialog;40class EditorData;41class EditorSelection;42class EditorZoomWidget;43class HScrollBar;44class HSplitContainer;45class MenuButton;46class PanelContainer;47class StyleBoxTexture;48class Timer;49class ViewPanner;50class VScrollBar;51class VSeparator;52class VSplitContainer;5354class CanvasItemEditorSelectedItem : public Object {55GDCLASS(CanvasItemEditorSelectedItem, Object);5657public:58Transform2D prev_xform;59Rect2 prev_rect;60Vector2 prev_pivot;61Vector2 prev_pivot_ratio;62real_t prev_anchors[4] = { (real_t)0.0 };6364Transform2D pre_drag_xform;65Rect2 pre_drag_rect;6667List<real_t> pre_drag_bones_length;68List<Dictionary> pre_drag_bones_undo_state;6970Dictionary undo_state;71};7273class CanvasItemEditor : public VBoxContainer {74GDCLASS(CanvasItemEditor, VBoxContainer);7576public:77enum Tool {78TOOL_SELECT,79TOOL_LIST_SELECT,80TOOL_MOVE,81TOOL_SCALE,82TOOL_ROTATE,83TOOL_EDIT_PIVOT,84TOOL_PAN,85TOOL_RULER,86TOOL_MAX87};8889enum AddNodeOption {90ADD_NODE,91ADD_INSTANCE,92ADD_PASTE,93ADD_MOVE,94};9596private:97enum SnapTarget {98SNAP_TARGET_NONE = 0,99SNAP_TARGET_PARENT,100SNAP_TARGET_SELF_ANCHORS,101SNAP_TARGET_SELF,102SNAP_TARGET_OTHER_NODE,103SNAP_TARGET_GUIDE,104SNAP_TARGET_GRID,105SNAP_TARGET_PIXEL106};107108enum MenuOption {109SNAP_USE,110SNAP_USE_NODE_PARENT,111SNAP_USE_NODE_ANCHORS,112SNAP_USE_NODE_SIDES,113SNAP_USE_NODE_CENTER,114SNAP_USE_OTHER_NODES,115SNAP_USE_GRID,116SNAP_USE_GUIDES,117SNAP_USE_ROTATION,118SNAP_USE_SCALE,119SNAP_RELATIVE,120SNAP_CONFIGURE,121SNAP_USE_PIXEL,122SHOW_HELPERS,123SHOW_RULERS,124SHOW_GUIDES,125SHOW_ORIGIN,126SHOW_VIEWPORT,127SHOW_POSITION_GIZMOS,128SHOW_LOCK_GIZMOS,129SHOW_GROUP_GIZMOS,130SHOW_TRANSFORMATION_GIZMOS,131LOCK_SELECTED,132UNLOCK_SELECTED,133GROUP_SELECTED,134UNGROUP_SELECTED,135ANIM_INSERT_KEY,136ANIM_INSERT_KEY_EXISTING,137ANIM_INSERT_POS,138ANIM_INSERT_ROT,139ANIM_INSERT_SCALE,140ANIM_COPY_POSE,141ANIM_PASTE_POSE,142ANIM_CLEAR_POSE,143CLEAR_GUIDES,144VIEW_CENTER_TO_SELECTION,145VIEW_FRAME_TO_SELECTION,146PREVIEW_CANVAS_SCALE,147SKELETON_MAKE_BONES,148SKELETON_SHOW_BONES,149AUTO_RESAMPLE_CANVAS_ITEMS,150};151152enum DragType {153DRAG_NONE,154DRAG_BOX_SELECTION,155DRAG_LEFT,156DRAG_TOP_LEFT,157DRAG_TOP,158DRAG_TOP_RIGHT,159DRAG_RIGHT,160DRAG_BOTTOM_RIGHT,161DRAG_BOTTOM,162DRAG_BOTTOM_LEFT,163DRAG_ANCHOR_TOP_LEFT,164DRAG_ANCHOR_TOP_RIGHT,165DRAG_ANCHOR_BOTTOM_RIGHT,166DRAG_ANCHOR_BOTTOM_LEFT,167DRAG_ANCHOR_ALL,168DRAG_QUEUED,169DRAG_MOVE,170DRAG_MOVE_X,171DRAG_MOVE_Y,172DRAG_SCALE_X,173DRAG_SCALE_Y,174DRAG_SCALE_BOTH,175DRAG_ROTATE,176DRAG_PIVOT,177DRAG_TEMP_PIVOT,178DRAG_V_GUIDE,179DRAG_H_GUIDE,180DRAG_DOUBLE_GUIDE,181DRAG_KEY_MOVE182};183184enum GridVisibility {185GRID_VISIBILITY_SHOW,186GRID_VISIBILITY_SHOW_WHEN_SNAPPING,187GRID_VISIBILITY_HIDE,188};189190enum TransformType {191POSITION,192ROTATION,193SCALE,194};195196const String locked_transform_warning = TTRC("All selected CanvasItems are either invisible or locked in some way and can't be transformed.");197198bool selection_menu_additive_selection = false;199200Tool tool = TOOL_SELECT;201Control *viewport = nullptr;202Control *viewport_scrollable = nullptr;203204HScrollBar *h_scroll = nullptr;205VScrollBar *v_scroll = nullptr;206207// Used for secondary menu items which are displayed depending on the currently selected node208// (such as MeshInstance's "Mesh" menu).209PanelContainer *context_toolbar_panel = nullptr;210HBoxContainer *context_toolbar_hbox = nullptr;211HashMap<Control *, VSeparator *> context_toolbar_separators;212213void _update_context_toolbar();214215Transform2D transform;216GridVisibility grid_visibility = GRID_VISIBILITY_SHOW_WHEN_SNAPPING;217bool show_rulers = true;218bool show_guides = true;219bool show_origin = true;220bool show_viewport = true;221bool show_helpers = false;222bool show_position_gizmos = true;223bool show_lock_gizmos = true;224bool show_group_gizmos = true;225bool show_transformation_gizmos = true;226227real_t zoom = 1.0;228Point2 view_offset;229Point2 previous_update_view_offset;230231Timer *resample_timer = nullptr;232bool auto_resampling_enabled = true;233real_t resample_delay = 0.3;234235bool selected_from_canvas = false;236237// Defaults are defined in clear().238Point2 grid_offset;239Point2 grid_step;240Vector2i primary_grid_step;241int grid_step_multiplier = 0;242243real_t snap_rotation_step = 0.0;244real_t snap_rotation_offset = 0.0;245real_t snap_scale_step = 0.0;246bool use_local_space = true;247bool smart_snap_active = false;248bool grid_snap_active = false;249250bool snap_node_parent = true;251bool snap_node_anchors = true;252bool snap_node_sides = true;253bool snap_node_center = true;254bool snap_other_nodes = true;255bool snap_guides = true;256bool snap_rotation = false;257bool snap_scale = false;258bool snap_relative = false;259// Enable pixel snapping even if pixel snap rendering is disabled in the Project Settings.260// This results in crisper visuals by preventing 2D nodes from being placed at subpixel coordinates.261bool snap_pixel = true;262263bool key_pos = true;264bool key_rot = true;265bool key_scale = false;266267bool pan_pressed = false;268Vector2 temp_pivot = Vector2(Math::INF, Math::INF);269270bool ruler_tool_active = false;271Point2 ruler_tool_origin;272real_t ruler_width_scaled = 16.0;273int ruler_font_size = 8;274Point2 node_create_position;275real_t grab_distance = 0.0;276bool simple_panning = false;277278MenuOption last_option;279280struct _SelectResult {281CanvasItem *item = nullptr;282real_t z_index = 0;283bool has_z = true;284_FORCE_INLINE_ bool operator<(const _SelectResult &p_rr) const {285return has_z && p_rr.has_z ? p_rr.z_index < z_index : p_rr.has_z;286}287};288Vector<_SelectResult> selection_results;289Vector<_SelectResult> selection_results_menu;290291struct _HoverResult {292Point2 position;293Ref<Texture2D> icon;294String name;295};296Vector<_HoverResult> hovering_results;297298struct BoneList {299Transform2D xform;300real_t length = 0;301uint64_t last_pass = 0;302};303304uint64_t bone_last_frame = 0;305306struct BoneKey {307ObjectID from;308ObjectID to;309_FORCE_INLINE_ bool operator<(const BoneKey &p_key) const {310if (from == p_key.from) {311return to < p_key.to;312} else {313return from < p_key.from;314}315}316};317318HashMap<BoneKey, BoneList> bone_list;319MenuButton *skeleton_menu = nullptr;320321struct PoseClipboard {322Vector2 pos;323Vector2 scale;324real_t rot = 0;325ObjectID id;326};327List<PoseClipboard> pose_clipboard;328329Button *select_button = nullptr;330331Button *move_button = nullptr;332Button *scale_button = nullptr;333Button *rotate_button = nullptr;334335Button *list_select_button = nullptr;336Button *pivot_button = nullptr;337Button *pan_button = nullptr;338339Button *ruler_button = nullptr;340341Button *local_space_button = nullptr;342Button *smart_snap_button = nullptr;343Button *grid_snap_button = nullptr;344MenuButton *snap_config_menu = nullptr;345PopupMenu *smartsnap_config_popup = nullptr;346347Button *lock_button = nullptr;348Button *unlock_button = nullptr;349350Button *group_button = nullptr;351Button *ungroup_button = nullptr;352353MenuButton *view_menu = nullptr;354PopupMenu *grid_menu = nullptr;355PopupMenu *theme_menu = nullptr;356PopupMenu *gizmos_menu = nullptr;357HBoxContainer *animation_hb = nullptr;358MenuButton *animation_menu = nullptr;359360Button *key_loc_button = nullptr;361Button *key_rot_button = nullptr;362Button *key_scale_button = nullptr;363Button *key_insert_button = nullptr;364Button *key_auto_insert_button = nullptr;365366PopupMenu *selection_menu = nullptr;367PopupMenu *add_node_menu = nullptr;368369Control *top_ruler = nullptr;370Control *left_ruler = nullptr;371372Point2 drag_start_origin;373DragType drag_type = DRAG_NONE;374Point2 drag_from;375Point2 drag_to;376Point2 drag_rotation_center;377List<CanvasItem *> drag_selection;378int dragged_guide_index = -1;379Point2 dragged_guide_pos;380bool is_hovering_h_guide = false;381bool is_hovering_v_guide = false;382383bool updating_value_dialog = false;384Transform2D original_transform;385386Point2 box_selecting_to;387CursorShape cursor_shape_override = CURSOR_ARROW;388389Ref<StyleBoxTexture> select_sb;390Ref<Texture2D> select_handle;391Ref<Texture2D> anchor_handle;392393Ref<Shortcut> drag_pivot_shortcut;394Ref<Shortcut> set_pivot_shortcut;395Ref<Shortcut> multiply_grid_step_shortcut;396Ref<Shortcut> divide_grid_step_shortcut;397Ref<Shortcut> reset_transform_position_shortcut;398Ref<Shortcut> reset_transform_rotation_shortcut;399Ref<Shortcut> reset_transform_scale_shortcut;400401Ref<ViewPanner> panner;402void _pan_callback(Vector2 p_scroll_vec, Ref<InputEvent> p_event);403void _zoom_callback(float p_zoom_factor, Vector2 p_origin, Ref<InputEvent> p_event);404405bool _is_node_locked(const Node *p_node) const;406bool _is_node_movable(const Node *p_node, bool p_popup_warning = false);407void _find_canvas_items_at_pos(const Point2 &p_pos, Node *p_node, Vector<_SelectResult> &r_items, const Transform2D &p_parent_xform = Transform2D(), const Transform2D &p_canvas_xform = Transform2D());408void _get_canvas_items_at_pos(const Point2 &p_pos, Vector<_SelectResult> &r_items, bool p_allow_locked = false);409410void _find_canvas_items_in_rect(const Rect2 &p_rect, Node *p_node, List<CanvasItem *> *r_items, const Transform2D &p_parent_xform = Transform2D(), const Transform2D &p_canvas_xform = Transform2D());411bool _select_click_on_item(CanvasItem *item, Point2 p_click_pos, bool p_append);412413ConfirmationDialog *snap_dialog = nullptr;414415CanvasItem *ref_item = nullptr;416417void _save_canvas_item_state(const List<CanvasItem *> &p_canvas_items, bool save_bones = false);418void _restore_canvas_item_state(const List<CanvasItem *> &p_canvas_items, bool restore_bones = false);419void _commit_canvas_item_state(const List<CanvasItem *> &p_canvas_items, const String &action_name, bool commit_bones = false);420421Vector2 _anchor_to_position(const Control *p_control, Vector2 anchor);422Vector2 _position_to_anchor(const Control *p_control, Vector2 position);423424void _prepare_view_menu();425void _popup_callback(int p_op);426bool updating_scroll = false;427void _update_scroll(real_t);428void _update_scrollbars();429void _snap_changed();430void _selection_result_pressed(int);431void _selection_menu_hide();432void _add_node_pressed(int p_result);433void _adjust_new_node_position(Node *p_node);434void _reset_create_position();435void _update_editor_settings();436bool _is_grid_visible() const;437void _prepare_grid_menu();438void _on_grid_menu_id_pressed(int p_id);439void _reset_transform(TransformType p_type);440void _update_oversampling();441442public:443enum ThemePreviewMode {444THEME_PREVIEW_PROJECT,445THEME_PREVIEW_EDITOR,446THEME_PREVIEW_DEFAULT,447448THEME_PREVIEW_MAX // The number of options for enumerating.449};450451private:452ThemePreviewMode theme_preview = THEME_PREVIEW_PROJECT;453void _switch_theme_preview(int p_mode);454455List<CanvasItem *> _get_edited_canvas_items(bool p_retrieve_locked = false, bool p_remove_canvas_item_if_parent_in_selection = true, bool *r_has_locked_items = nullptr) const;456Rect2 _get_encompassing_rect_from_list(const List<CanvasItem *> &p_list);457void _expand_encompassing_rect_using_children(Rect2 &r_rect, const Node *p_node, bool &r_first, const Transform2D &p_parent_xform = Transform2D(), const Transform2D &p_canvas_xform = Transform2D(), bool include_locked_nodes = true);458Rect2 _get_encompassing_rect(const Node *p_node);459460Object *_get_editor_data(Object *p_what);461462void _insert_animation_keys(bool p_location, bool p_rotation, bool p_scale, bool p_on_existing);463464void _keying_changed();465466virtual void shortcut_input(const Ref<InputEvent> &p_ev) override;467468void _draw_text_at_position(Point2 p_position, const String &p_string, Side p_side);469void _draw_margin_at_position(int p_value, Point2 p_position, Side p_side);470void _draw_percentage_at_position(real_t p_value, Point2 p_position, Side p_side);471void _draw_straight_line(Point2 p_from, Point2 p_to, Color p_color);472473void _draw_smart_snapping();474void _draw_rulers();475void _draw_guides();476void _draw_focus();477void _draw_grid();478void _draw_ruler_tool();479void _draw_control_anchors(Control *control);480void _draw_control_helpers(Control *control);481void _draw_selection();482void _draw_axis();483void _draw_invisible_nodes_positions(Node *p_node, const Transform2D &p_parent_xform = Transform2D(), const Transform2D &p_canvas_xform = Transform2D());484void _draw_locks_and_groups(Node *p_node, const Transform2D &p_parent_xform = Transform2D(), const Transform2D &p_canvas_xform = Transform2D());485void _draw_hover();486void _draw_message();487488void _draw_viewport();489490bool _gui_input_anchors(const Ref<InputEvent> &p_event);491bool _gui_input_move(const Ref<InputEvent> &p_event);492bool _gui_input_open_scene_on_double_click(const Ref<InputEvent> &p_event);493bool _gui_input_scale(const Ref<InputEvent> &p_event);494bool _gui_input_pivot(const Ref<InputEvent> &p_event);495bool _gui_input_resize(const Ref<InputEvent> &p_event);496bool _gui_input_rotate(const Ref<InputEvent> &p_event);497bool _gui_input_select(const Ref<InputEvent> &p_event);498bool _gui_input_ruler_tool(const Ref<InputEvent> &p_event);499bool _gui_input_zoom_or_pan(const Ref<InputEvent> &p_event, bool p_already_accepted);500bool _gui_input_rulers_and_guides(const Ref<InputEvent> &p_event);501bool _gui_input_hover(const Ref<InputEvent> &p_event);502503void _commit_drag();504505void _gui_input_viewport(const Ref<InputEvent> &p_event);506void _update_cursor();507void _update_lock_and_group_button();508509void _selection_changed();510void _focus_selection(int p_op);511void _reset_drag();512513void _project_settings_changed();514515SnapTarget snap_target[2];516Transform2D snap_transform;517void _snap_if_closer_float(518const real_t p_value,519real_t &r_current_snap, SnapTarget &r_current_snap_target,520const real_t p_target_value, const SnapTarget p_snap_target,521const real_t p_radius = 10.0);522void _snap_if_closer_point(523Point2 p_value,524Point2 &r_current_snap, SnapTarget (&r_current_snap_target)[2],525Point2 p_target_value, const SnapTarget p_snap_target,526const real_t rotation = 0.0,527const real_t p_radius = 10.0);528void _snap_other_nodes(529const Point2 p_value,530const Transform2D p_transform_to_snap,531Point2 &r_current_snap, SnapTarget (&r_current_snap_target)[2],532const SnapTarget p_snap_target, List<const CanvasItem *> p_exceptions,533const Node *p_current);534535VBoxContainer *controls_vb = nullptr;536Button *button_center_view = nullptr;537EditorZoomWidget *zoom_widget = nullptr;538void _update_zoom(real_t p_zoom);539void _shortcut_zoom_set(real_t p_zoom);540void _zoom_on_position(real_t p_zoom, Point2 p_position = Point2());541void _button_toggle_local_space(bool p_status);542void _button_toggle_smart_snap(bool p_status);543void _button_toggle_grid_snap(bool p_status);544void _button_tool_select(int p_index);545546HSplitContainer *left_panel_split = nullptr;547HSplitContainer *right_panel_split = nullptr;548VSplitContainer *bottom_split = nullptr;549550void _set_owner_for_node_and_children(Node *p_node, Node *p_owner);551552friend class CanvasItemEditorPlugin;553554protected:555void _notification(int p_what);556557static void _bind_methods();558559static CanvasItemEditor *singleton;560561public:562enum SnapMode {563SNAP_GRID = 1 << 0,564SNAP_GUIDES = 1 << 1,565SNAP_PIXEL = 1 << 2,566SNAP_NODE_PARENT = 1 << 3,567SNAP_NODE_ANCHORS = 1 << 4,568SNAP_NODE_SIDES = 1 << 5,569SNAP_NODE_CENTER = 1 << 6,570SNAP_OTHER_NODES = 1 << 7,571572SNAP_DEFAULT = SNAP_GRID | SNAP_GUIDES | SNAP_PIXEL,573};574575String message;576577Point2 snap_point(Point2 p_target, unsigned int p_modes = SNAP_DEFAULT, unsigned int p_forced_modes = 0, const CanvasItem *p_self_canvas_item = nullptr, const List<CanvasItem *> &p_other_nodes_exceptions = List<CanvasItem *>());578real_t snap_angle(real_t p_target, real_t p_start = 0) const;579580Transform2D get_canvas_transform() const { return transform; }581582static CanvasItemEditor *get_singleton() { return singleton; }583Dictionary get_state() const;584void set_state(const Dictionary &p_state);585void clear();586587void add_control_to_menu_panel(Control *p_control);588void remove_control_from_menu_panel(Control *p_control);589590void add_control_to_left_panel(Control *p_control);591void remove_control_from_left_panel(Control *p_control);592593void add_control_to_right_panel(Control *p_control);594void remove_control_from_right_panel(Control *p_control);595596VSplitContainer *get_bottom_split();597598Control *get_viewport_control() { return viewport; }599600Control *get_controls_container() { return controls_vb; }601602void update_viewport();603604Tool get_current_tool() { return tool; }605void set_current_tool(Tool p_tool);606607void edit(CanvasItem *p_canvas_item);608609void focus_selection();610void center_at(const Point2 &p_pos);611612void set_cursor_shape_override(CursorShape p_shape = CURSOR_ARROW);613virtual CursorShape get_cursor_shape(const Point2 &p_pos) const override;614615ThemePreviewMode get_theme_preview() const { return theme_preview; }616617EditorSelection *editor_selection = nullptr;618619CanvasItemEditor();620};621622class CanvasItemEditorPlugin : public EditorPlugin {623GDCLASS(CanvasItemEditorPlugin, EditorPlugin);624625CanvasItemEditor *canvas_item_editor = nullptr;626627protected:628void _notification(int p_what);629630public:631virtual String get_plugin_name() const override { return TTRC("2D"); }632bool has_main_screen() const override { return true; }633virtual void edit(Object *p_object) override;634virtual bool handles(Object *p_object) const override;635virtual void make_visible(bool p_visible) override;636virtual Dictionary get_state() const override;637virtual void set_state(const Dictionary &p_state) override;638virtual void clear() override;639640CanvasItemEditor *get_canvas_item_editor() { return canvas_item_editor; }641642CanvasItemEditorPlugin();643};644645class CanvasItemEditorViewport : public Control {646GDCLASS(CanvasItemEditorViewport, Control);647648// The type of node that will be created when dropping texture into the viewport.649String default_texture_node_type;650// Node types that are available to select from when dropping texture into viewport.651Vector<String> texture_node_types;652653Vector<String> selected_files;654Node *target_node = nullptr;655Point2 drop_pos;656657CanvasItemEditor *canvas_item_editor = nullptr;658Control *preview_node = nullptr;659AcceptDialog *accept = nullptr;660AcceptDialog *texture_node_type_selector = nullptr;661Label *label = nullptr;662Label *label_desc = nullptr;663Ref<ButtonGroup> button_group;664665void _on_mouse_exit();666void _on_select_texture_node_type(Object *selected);667void _on_change_type_confirmed();668void _on_change_type_closed();669670void _create_preview(const Vector<String> &files) const;671void _remove_preview();672673bool _cyclical_dependency_exists(const String &p_target_scene_path, Node *p_desired_node) const;674bool _is_any_texture_selected() const;675void _create_texture_node(Node *p_parent, Node *p_child, const String &p_path, const Point2 &p_point);676void _create_audio_node(Node *p_parent, const String &p_path, const Point2 &p_point);677bool _create_instance(Node *p_parent, const String &p_path, const Point2 &p_point);678void _perform_drop_data();679void _show_texture_node_type_selector();680void _update_theme();681682protected:683void _notification(int p_what);684685public:686virtual bool can_drop_data(const Point2 &p_point, const Variant &p_data) const override;687virtual void drop_data(const Point2 &p_point, const Variant &p_data) override;688689CanvasItemEditorViewport(CanvasItemEditor *p_canvas_item_editor);690~CanvasItemEditorViewport();691};692693694