376 lines
11 KiB
C++
376 lines
11 KiB
C++
/*************************************************************************/
|
|
/* editor_inspector.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md) */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef EDITOR_INSPECTOR_H
|
|
#define EDITOR_INSPECTOR_H
|
|
|
|
#include "scene/gui/box_container.h"
|
|
#include "scene/gui/line_edit.h"
|
|
#include "scene/gui/scroll_container.h"
|
|
|
|
class UndoRedo;
|
|
|
|
class EditorProperty : public Container {
|
|
|
|
GDCLASS(EditorProperty, Container)
|
|
private:
|
|
String label;
|
|
int text_size;
|
|
friend class EditorInspector;
|
|
Object *object;
|
|
StringName property;
|
|
|
|
int property_usage;
|
|
|
|
bool read_only;
|
|
bool checkable;
|
|
bool checked;
|
|
bool draw_red;
|
|
bool keying;
|
|
|
|
Rect2 right_child_rect;
|
|
Rect2 bottom_child_rect;
|
|
|
|
Rect2 keying_rect;
|
|
bool keying_hover;
|
|
Rect2 revert_rect;
|
|
bool revert_hover;
|
|
Rect2 check_rect;
|
|
bool check_hover;
|
|
|
|
bool can_revert;
|
|
|
|
bool use_folding;
|
|
bool draw_top_bg;
|
|
|
|
bool _might_be_in_instance();
|
|
bool _is_property_different(const Variant &p_current, const Variant &p_orig);
|
|
bool _get_instanced_node_original_property(const StringName &p_prop, Variant &value);
|
|
void _focusable_focused(int p_index);
|
|
|
|
bool selectable;
|
|
bool selected;
|
|
int selected_focusable;
|
|
|
|
float split_ratio;
|
|
|
|
Vector<Control *> focusables;
|
|
Control *label_reference;
|
|
Control *bottom_editor;
|
|
|
|
mutable String tooltip_text;
|
|
|
|
protected:
|
|
void _notification(int p_what);
|
|
static void _bind_methods();
|
|
|
|
void _gui_input(const Ref<InputEvent> &p_event);
|
|
|
|
public:
|
|
virtual Size2 get_minimum_size() const;
|
|
|
|
void set_label(const String &p_label);
|
|
String get_label() const;
|
|
|
|
void set_read_only(bool p_read_only);
|
|
bool is_read_only() const;
|
|
|
|
Object *get_edited_object();
|
|
StringName get_edited_property();
|
|
|
|
virtual void update_property();
|
|
void update_reload_status();
|
|
|
|
virtual bool use_keying_next() const;
|
|
|
|
void set_checkable(bool p_checkable);
|
|
bool is_checkable() const;
|
|
|
|
void set_checked(bool p_checked);
|
|
bool is_checked() const;
|
|
|
|
void set_draw_red(bool p_draw_red);
|
|
bool is_draw_red() const;
|
|
|
|
void set_keying(bool p_keying);
|
|
bool is_keying() const;
|
|
|
|
void add_focusable(Control *p_control);
|
|
void select(int p_focusable = -1);
|
|
void deselect();
|
|
bool is_selected() const;
|
|
|
|
void set_label_reference(Control *p_control);
|
|
void set_bottom_editor(Control *p_editor);
|
|
|
|
void set_use_folding(bool p_use_folding);
|
|
bool is_using_folding() const;
|
|
|
|
virtual void expand_all_folding();
|
|
virtual void collapse_all_folding();
|
|
|
|
virtual Variant get_drag_data(const Point2 &p_point);
|
|
|
|
void set_selectable(bool p_selectable);
|
|
bool is_selectable() const;
|
|
|
|
void set_name_split_ratio(float p_ratio);
|
|
float get_name_split_ratio() const;
|
|
|
|
void set_object_and_property(Object *p_object, const StringName &p_property);
|
|
virtual Control *make_custom_tooltip(const String &p_text) const;
|
|
|
|
String get_tooltip_text() const;
|
|
|
|
void set_draw_top_bg(bool p_draw) { draw_top_bg = p_draw; }
|
|
|
|
bool can_revert_to_default() const { return can_revert; }
|
|
|
|
EditorProperty();
|
|
};
|
|
|
|
class EditorInspectorPlugin : public Reference {
|
|
GDCLASS(EditorInspectorPlugin, Reference)
|
|
|
|
friend class EditorInspector;
|
|
struct AddedEditor {
|
|
Control *property_editor;
|
|
Vector<String> properties;
|
|
String label;
|
|
};
|
|
|
|
List<AddedEditor> added_editors;
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void add_custom_control(Control *control);
|
|
void add_property_editor(const String &p_for_property, Control *p_prop);
|
|
void add_property_editor_for_multiple_properties(const String &p_label, const Vector<String> &p_properties, Control *p_prop);
|
|
|
|
virtual bool can_handle(Object *p_object);
|
|
virtual void parse_begin(Object *p_object);
|
|
virtual void parse_category(Object *p_object, const String &p_parse_category);
|
|
virtual bool parse_property(Object *p_object, Variant::Type p_type, const String &p_path, PropertyHint p_hint, const String &p_hint_text, int p_usage);
|
|
virtual void parse_end();
|
|
};
|
|
|
|
class EditorInspectorCategory : public Control {
|
|
GDCLASS(EditorInspectorCategory, Control);
|
|
|
|
friend class EditorInspector;
|
|
Ref<Texture> icon;
|
|
String label;
|
|
Color bg_color;
|
|
mutable String tooltip_text;
|
|
|
|
protected:
|
|
void _notification(int p_what);
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
virtual Size2 get_minimum_size() const;
|
|
virtual Control *make_custom_tooltip(const String &p_text) const;
|
|
|
|
String get_tooltip_text() const;
|
|
|
|
EditorInspectorCategory();
|
|
};
|
|
|
|
class EditorInspectorSection : public Container {
|
|
GDCLASS(EditorInspectorSection, Container);
|
|
|
|
String label;
|
|
String section;
|
|
Object *object;
|
|
VBoxContainer *vbox;
|
|
bool vbox_added; //optimization
|
|
Color bg_color;
|
|
bool foldable;
|
|
|
|
void _test_unfold();
|
|
|
|
protected:
|
|
void _notification(int p_what);
|
|
static void _bind_methods();
|
|
void _gui_input(const Ref<InputEvent> &p_event);
|
|
|
|
public:
|
|
virtual Size2 get_minimum_size() const;
|
|
|
|
void setup(const String &p_section, const String &p_label, Object *p_object, const Color &p_bg_color, bool p_foldable);
|
|
VBoxContainer *get_vbox();
|
|
void unfold();
|
|
void fold();
|
|
|
|
Object *get_edited_object();
|
|
|
|
EditorInspectorSection();
|
|
~EditorInspectorSection();
|
|
};
|
|
|
|
class EditorInspector : public ScrollContainer {
|
|
GDCLASS(EditorInspector, ScrollContainer);
|
|
|
|
UndoRedo *undo_redo;
|
|
enum {
|
|
MAX_PLUGINS = 1024
|
|
};
|
|
static Ref<EditorInspectorPlugin> inspector_plugins[MAX_PLUGINS];
|
|
static int inspector_plugin_count;
|
|
|
|
VBoxContainer *main_vbox;
|
|
|
|
//map use to cache the instanced editors
|
|
Map<StringName, List<EditorProperty *> > editor_property_map;
|
|
List<EditorInspectorSection *> sections;
|
|
Set<StringName> pending;
|
|
|
|
void _clear();
|
|
Object *object;
|
|
|
|
//
|
|
|
|
LineEdit *search_box;
|
|
bool show_categories;
|
|
bool hide_script;
|
|
bool use_doc_hints;
|
|
bool capitalize_paths;
|
|
bool use_filter;
|
|
bool autoclear;
|
|
bool use_folding;
|
|
int changing;
|
|
bool update_all_pending;
|
|
bool read_only;
|
|
bool keying;
|
|
bool use_sub_inspector_bg;
|
|
bool auto_unfold_edited;
|
|
|
|
float refresh_countdown;
|
|
bool update_tree_pending;
|
|
StringName _prop_edited;
|
|
StringName property_selected;
|
|
int property_focusable;
|
|
int update_scroll_request;
|
|
|
|
Map<StringName, Map<StringName, String> > descr_cache;
|
|
Map<StringName, String> class_descr_cache;
|
|
Set<StringName> restart_request_props;
|
|
|
|
Map<ObjectID, int> scroll_cache;
|
|
|
|
String property_prefix; //used for sectioned inspector
|
|
String object_class;
|
|
|
|
void _edit_set(const String &p_name, const Variant &p_value, bool p_refresh_all, const String &p_changed_field);
|
|
|
|
void _property_changed(const String &p_path, const Variant &p_value, bool changing = false);
|
|
void _property_changed_update_all(const String &p_path, const Variant &p_value);
|
|
void _multiple_properties_changed(Vector<String> p_paths, Array p_values);
|
|
void _property_keyed(const String &p_path, bool p_advance);
|
|
void _property_keyed_with_value(const String &p_path, const Variant &p_value, bool p_advance);
|
|
|
|
void _property_checked(const String &p_path, bool p_checked);
|
|
|
|
void _resource_selected(const String &p_path, RES p_resource);
|
|
void _property_selected(const String &p_path, int p_focusable);
|
|
void _object_id_selected(const String &p_path, ObjectID p_id);
|
|
|
|
void _node_removed(Node *p_node);
|
|
|
|
void _changed_callback(Object *p_changed, const char *p_prop);
|
|
void _edit_request_change(Object *p_changed, const String &p_prop);
|
|
|
|
void _filter_changed(const String &p_text);
|
|
void _parse_added_editors(VBoxContainer *current_vbox, Ref<EditorInspectorPlugin> ped);
|
|
|
|
void _vscroll_changed(double);
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
void _notification(int p_what);
|
|
|
|
public:
|
|
static void add_inspector_plugin(const Ref<EditorInspectorPlugin> &p_plugin);
|
|
static void remove_inspector_plugin(const Ref<EditorInspectorPlugin> &p_plugin);
|
|
static void cleanup_plugins();
|
|
|
|
static EditorProperty *instantiate_property_editor(Object *p_object, Variant::Type p_type, const String &p_path, PropertyHint p_hint, const String &p_hint_text, int p_usage);
|
|
|
|
void set_undo_redo(UndoRedo *p_undo_redo);
|
|
|
|
String get_selected_path() const;
|
|
|
|
void update_tree();
|
|
void update_property(const String &p_prop);
|
|
|
|
void refresh();
|
|
|
|
void edit(Object *p_object);
|
|
Object *get_edited_object();
|
|
|
|
void set_keying(bool p_active);
|
|
void set_read_only(bool p_read_only);
|
|
|
|
bool is_capitalize_paths_enabled() const;
|
|
void set_enable_capitalize_paths(bool p_capitalize);
|
|
void set_autoclear(bool p_enable);
|
|
|
|
void set_show_categories(bool p_show);
|
|
void set_use_doc_hints(bool p_enable);
|
|
void set_hide_script(bool p_hide);
|
|
|
|
void set_use_filter(bool p_use);
|
|
void register_text_enter(Node *p_line_edit);
|
|
|
|
void set_use_folding(bool p_enable);
|
|
bool is_using_folding();
|
|
|
|
void collapse_all_folding();
|
|
void expand_all_folding();
|
|
|
|
void set_scroll_offset(int p_offset);
|
|
int get_scroll_offset() const;
|
|
|
|
void set_property_prefix(const String &p_prefix);
|
|
String get_property_prefix() const;
|
|
|
|
void set_object_class(const String &p_class);
|
|
String get_object_class() const;
|
|
|
|
void set_use_sub_inspector_bg(bool p_enable);
|
|
void set_auto_unfold_edited(bool p_enable);
|
|
|
|
EditorInspector();
|
|
};
|
|
|
|
#endif // INSPECTOR_H
|