Merge pull request #7549 from RandomShaper/cp-usability-2.1

Cherry-pick node creation usability enhancements (2.1)
This commit is contained in:
Rémi Verschelde 2017-01-16 18:05:56 +01:00 committed by GitHub
commit 5aac8eeb0f
6 changed files with 501 additions and 46 deletions

View file

@ -42,11 +42,84 @@
void CreateDialog::popup(bool p_dontclear) {
recent->clear();
FileAccess *f = FileAccess::open( EditorSettings::get_singleton()->get_project_settings_path().plus_file("create_recent."+base_type), FileAccess::READ );
if (f) {
TreeItem *root = recent->create_item();
while(!f->eof_reached()) {
String l = f->get_line().strip_edges();
if (l!=String()) {
TreeItem *ti = recent->create_item(root);
ti->set_text(0,l);
if (has_icon(l,"EditorIcons")) {
ti->set_icon(0,get_icon(l,"EditorIcons"));
} else {
ti->set_icon(0,get_icon("Object","EditorIcons"));
}
}
}
memdelete(f);
}
favorites->clear();
f = FileAccess::open( EditorSettings::get_singleton()->get_project_settings_path().plus_file("favorites."+base_type), FileAccess::READ );
favorite_list.clear();
if (f) {
while(!f->eof_reached()) {
String l = f->get_line().strip_edges();
if (l!=String()) {
favorite_list.push_back(l);
}
}
memdelete(f);
} else {
#if 0
// I think this was way too confusing
if (base_type=="Node") {
//harcode some favorites :D
favorite_list.push_back("Panel");
favorite_list.push_back("Button");
favorite_list.push_back("Label");
favorite_list.push_back("LineEdit");
favorite_list.push_back("Node2D");
favorite_list.push_back("Sprite");
favorite_list.push_back("Camera2D");
favorite_list.push_back("Area2D");
favorite_list.push_back("CollisionShape2D");
favorite_list.push_back("Spatial");
favorite_list.push_back("Camera");
favorite_list.push_back("Area");
favorite_list.push_back("CollisionShape");
favorite_list.push_back("TestCube");
favorite_list.push_back("AnimationPlayer");
}
#endif
}
_update_favorite_list();
popup_centered_ratio();
if (p_dontclear)
search_box->select_all();
else
else {
search_box->clear();
}
search_box->grab_focus();
_update_search();
@ -104,7 +177,7 @@ void CreateDialog::add_type(const String& p_type,HashMap<String,TreeItem*>& p_ty
item->set_selectable(0,false);
} else {
if (!*to_select && (search_box->get_text().is_subsequence_ofi(p_type))) {
if ((!*to_select && (search_box->get_text().is_subsequence_ofi(p_type))) || search_box->get_text()==p_type) {
*to_select=item;
}
@ -140,7 +213,9 @@ void CreateDialog::_update_search() {
search_options->clear();
favorite->set_disabled(true);
help_bit->set_text("");
/*
TreeItem *root = search_options->create_item();
_parse_fs(EditorFileSystem::get_singleton()->get_filesystem());
@ -225,7 +300,7 @@ void CreateDialog::_update_search() {
}
if (!to_select) {
if (!to_select || ct[i].name==search_box->get_text()) {
to_select=item;
}
@ -234,8 +309,11 @@ void CreateDialog::_update_search() {
}
}
if (to_select)
if (to_select) {
to_select->select(0);
favorite->set_disabled(false);
favorite->set_pressed(favorite_list.find(to_select->get_text(0))!=-1);
}
get_ok()->set_disabled(root->get_children()==NULL);
@ -246,6 +324,32 @@ void CreateDialog::_confirmed() {
TreeItem *ti = search_options->get_selected();
if (!ti)
return;
FileAccess *f = FileAccess::open( EditorSettings::get_singleton()->get_project_settings_path().plus_file("create_recent."+base_type), FileAccess::WRITE );
if (f) {
f->store_line(get_selected_type());
TreeItem *t = recent->get_root();
if (t)
t=t->get_children();
int count=0;
while(t) {
if (t->get_text(0)!=get_selected_type()) {
f->store_line(t->get_text(0));
}
if (count>32) {
//limit it to 32 entries..
break;
}
t=t->get_next();
count++;
}
memdelete(f);
}
emit_signal("create");
hide();
}
@ -255,6 +359,7 @@ void CreateDialog::_notification(int p_what) {
if (p_what==NOTIFICATION_ENTER_TREE) {
connect("confirmed",this,"_confirmed");
favorite->set_icon(get_icon("Favorites","EditorIcons"));
}
if (p_what==NOTIFICATION_EXIT_TREE) {
@ -332,11 +437,200 @@ String CreateDialog::get_base_type() const {
return base_type;
}
void CreateDialog::_item_selected() {
TreeItem *item = search_options->get_selected();
if (!item)
return;
String name = item->get_text(0);
favorite->set_disabled(false);
favorite->set_pressed(favorite_list.find(name)!=-1);
if (!EditorHelp::get_doc_data()->class_list.has(name))
return;
help_bit->set_text(EditorHelp::get_doc_data()->class_list[name].brief_description);
}
void CreateDialog::_favorite_toggled() {
TreeItem *item = search_options->get_selected();
if (!item)
return;
String name = item->get_text(0);
if (favorite_list.find(name)==-1) {
favorite_list.push_back(name);
favorite->set_pressed(true);
} else {
favorite_list.erase(name);
favorite->set_pressed(false);
}
_save_favorite_list();
_update_favorite_list();
}
void CreateDialog::_save_favorite_list() {
FileAccess *f = FileAccess::open( EditorSettings::get_singleton()->get_project_settings_path().plus_file("favorites."+base_type), FileAccess::WRITE );
if (f) {
for(int i=0;i<favorite_list.size();i++) {
f->store_line(favorite_list[i]);
}
memdelete(f);
}
}
void CreateDialog::_update_favorite_list() {
favorites->clear();
TreeItem *root = favorites->create_item();
for(int i=0;i<favorite_list.size();i++) {
TreeItem *ti = favorites->create_item(root);
String l = favorite_list[i];
ti->set_text(0,l);
if (has_icon(l,"EditorIcons")) {
ti->set_icon(0,get_icon(l,"EditorIcons"));
} else {
ti->set_icon(0,get_icon("Object","EditorIcons"));
}
}
}
void CreateDialog::_history_selected() {
TreeItem *item = recent->get_selected();
if (!item)
return;
search_box->set_text(item->get_text(0));
_update_search();
}
void CreateDialog::_favorite_selected(){
TreeItem *item = favorites->get_selected();
if (!item)
return;
search_box->set_text(item->get_text(0));
_update_search();
}
void CreateDialog::_history_activated() {
_confirmed();
}
void CreateDialog::_favorite_activated(){
_confirmed();
}
Variant CreateDialog::get_drag_data_fw(const Point2& p_point,Control* p_from) {
TreeItem *ti = favorites->get_item_at_pos(p_point);
if (ti) {
Dictionary d;
d["type"]="create_favorite_drag";
d["class"]=ti->get_text(0);
ToolButton *tb = memnew( ToolButton );
tb->set_icon(ti->get_icon(0));
tb->set_text(ti->get_text(0));
set_drag_preview(tb);
return d;
}
return Variant();
}
bool CreateDialog::can_drop_data_fw(const Point2& p_point,const Variant& p_data,Control* p_from) const{
Dictionary d = p_data;
if (d.has("type") && String(d["type"])=="create_favorite_drag") {
favorites->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN);
return true;
}
return false;
}
void CreateDialog::drop_data_fw(const Point2& p_point,const Variant& p_data,Control* p_from){
Dictionary d = p_data;
TreeItem *ti = favorites->get_item_at_pos(p_point);
if (!ti)
return;
String drop_at = ti->get_text(0);
int ds = favorites->get_drop_section_at_pos(p_point);
int drop_idx = favorite_list.find(drop_at);
if (drop_idx<0)
return;
String type = d["class"];
int from_idx = favorite_list.find(type);
if (from_idx<0)
return;
if (drop_idx==from_idx) {
ds=-1; //cause it will be gone
} else if (drop_idx>from_idx) {
drop_idx--;
}
favorite_list.remove(from_idx);
if (ds<0) {
favorite_list.insert(drop_idx,type);
} else {
if (drop_idx>=favorite_list.size()-1) {
favorite_list.push_back(type);
} else {
favorite_list.insert(drop_idx+1,type);
}
}
_save_favorite_list();
_update_favorite_list();
}
void CreateDialog::_bind_methods() {
ObjectTypeDB::bind_method(_MD("_text_changed"),&CreateDialog::_text_changed);
ObjectTypeDB::bind_method(_MD("_confirmed"),&CreateDialog::_confirmed);
ObjectTypeDB::bind_method(_MD("_sbox_input"),&CreateDialog::_sbox_input);
ObjectTypeDB::bind_method(_MD("_item_selected"),&CreateDialog::_item_selected);
ObjectTypeDB::bind_method(_MD("_favorite_toggled"),&CreateDialog::_favorite_toggled);
ObjectTypeDB::bind_method(_MD("_history_selected"),&CreateDialog::_history_selected);
ObjectTypeDB::bind_method(_MD("_favorite_selected"),&CreateDialog::_favorite_selected);
ObjectTypeDB::bind_method(_MD("_history_activated"),&CreateDialog::_history_activated);
ObjectTypeDB::bind_method(_MD("_favorite_activated"),&CreateDialog::_favorite_activated);
ObjectTypeDB::bind_method("get_drag_data_fw",&CreateDialog::get_drag_data_fw);
ObjectTypeDB::bind_method("can_drop_data_fw",&CreateDialog::can_drop_data_fw);
ObjectTypeDB::bind_method("drop_data_fw",&CreateDialog::drop_data_fw);
ADD_SIGNAL(MethodInfo("create"));
@ -345,12 +639,44 @@ void CreateDialog::_bind_methods() {
CreateDialog::CreateDialog() {
HSplitContainer *hbc = memnew( HSplitContainer );
add_child(hbc);
set_child_rect(hbc);
VBoxContainer *lvbc = memnew( VBoxContainer);
hbc->add_child(lvbc);
lvbc->set_custom_minimum_size(Size2(150,0)*EDSCALE);
favorites = memnew (Tree );
lvbc->add_margin_child(TTR("Favorites:"),favorites,true);
favorites->set_hide_root(true);
favorites->set_hide_folding(true);
favorites->connect("cell_selected",this,"_favorite_selected");
favorites->connect("item_activated",this,"_favorite_activated");
favorites->set_drag_forwarding(this);
recent = memnew (Tree );
lvbc->add_margin_child(TTR("Recent:"),recent,true);
recent->set_hide_root(true);
recent->set_hide_folding(true);
recent->connect("cell_selected",this,"_history_selected");
recent->connect("item_activated",this,"_history_activated");
VBoxContainer *vbc = memnew( VBoxContainer );
add_child(vbc);
set_child_rect(vbc);
hbc->add_child(vbc);
vbc->set_h_size_flags(SIZE_EXPAND_FILL);
HBoxContainer *search_hb = memnew( HBoxContainer );
search_box = memnew( LineEdit );
vbc->add_margin_child(TTR("Search:"),search_box);
search_box->set_h_size_flags(SIZE_EXPAND_FILL);
search_hb->add_child(search_box);
favorite = memnew( Button );
favorite->set_toggle_mode(true);
search_hb->add_child(favorite);
favorite->connect("pressed",this,"_favorite_toggled");
vbc->add_margin_child(TTR("Search:"),search_hb);
search_box->connect("text_changed",this,"_text_changed");
search_box->connect("input_event",this,"_sbox_input");
search_options = memnew( Tree );
@ -360,9 +686,14 @@ CreateDialog::CreateDialog() {
register_text_enter(search_box);
set_hide_on_ok(false);
search_options->connect("item_activated",this,"_confirmed");
search_options->connect("cell_selected",this,"_item_selected");
// search_options->set_hide_root(true);
base_type="Object";
help_bit = memnew( EditorHelpBit );
vbc->add_margin_child(TTR("Description:"),help_bit);
help_bit->connect("request_hide",this,"_closed");
}

View file

@ -32,8 +32,10 @@
#include "scene/gui/dialogs.h"
#include "scene/gui/button.h"
#include "scene/gui/tree.h"
#include "scene/gui/item_list.h"
#include "scene/gui/line_edit.h"
#include "scene/gui/label.h"
#include "editor_help.h"
/**
@author Juan Linietsky <reduzio@gmail.com>
*/
@ -45,11 +47,30 @@ class CreateDialog : public ConfirmationDialog {
OBJ_TYPE(CreateDialog,ConfirmationDialog )
Vector<String> favorite_list;
Tree *favorites;
Tree *recent;
Button *favorite;
LineEdit *search_box;
Tree *search_options;
String base_type;
EditorHelpBit *help_bit;
void _item_selected();
void _update_search();
void _update_favorite_list();
void _save_favorite_list();
void _favorite_toggled();
void _history_selected();
void _favorite_selected();
void _history_activated();
void _favorite_activated();
void _sbox_input(const InputEvent& p_ie);
@ -58,6 +79,9 @@ class CreateDialog : public ConfirmationDialog {
void add_type(const String& p_type,HashMap<String,TreeItem*>& p_types,TreeItem *p_root,TreeItem **to_select);
Variant get_drag_data_fw(const Point2& p_point,Control* p_from);
bool can_drop_data_fw(const Point2& p_point,const Variant& p_data,Control* p_from) const;
void drop_data_fw(const Point2& p_point,const Variant& p_data,Control* p_from);
protected:

View file

@ -31,7 +31,7 @@
#include "editor_settings.h"
#include "os/keyboard.h"
#include "doc_data_compressed.h"
#include "tools/editor/plugins/script_editor_plugin.h"
#include "os/keyboard.h"
@ -1256,16 +1256,20 @@ void EditorHelp::_help_callback(const String& p_topic) {
}
void EditorHelp::_add_text(const String& p_bbcode) {
/*class_desc->push_color(EditorSettings::get_singleton()->get("text_editor/text_color"));
class_desc->push_font( get_font("normal","Fonts") );
class_desc->push_indent(1);*/
static void _add_text_to_rt(const String& p_bbcode,RichTextLabel *p_rt) {
DocData *doc = EditorHelp::get_doc_data();
String base_path;
/*p_rt->push_color(EditorSettings::get_singleton()->get("text_editor/text_color"));
p_rt->push_font( get_font("normal","Fonts") );
p_rt->push_indent(1);*/
int pos = 0;
Ref<Font> doc_font = get_font("doc","EditorFonts");
Ref<Font> doc_code_font = get_font("doc_source","EditorFonts");
Ref<Font> doc_font = p_rt->get_font("doc","EditorFonts");
Ref<Font> doc_code_font = p_rt->get_font("doc_source","EditorFonts");
String bbcode=p_bbcode.replace("\t"," ").replace("\r"," ").strip_edges();
@ -1333,7 +1337,7 @@ void EditorHelp::_add_text(const String& p_bbcode) {
brk_pos=bbcode.length();
if (brk_pos > pos) {
class_desc->add_text(bbcode.substr(pos,brk_pos-pos));
p_rt->add_text(bbcode.substr(pos,brk_pos-pos));
}
@ -1344,7 +1348,7 @@ void EditorHelp::_add_text(const String& p_bbcode) {
if (brk_end==-1) {
//no close, add the rest
class_desc->add_text(bbcode.substr(brk_pos,bbcode.length()-brk_pos));
p_rt->add_text(bbcode.substr(brk_pos,bbcode.length()-brk_pos));
break;
}
@ -1362,7 +1366,7 @@ void EditorHelp::_add_text(const String& p_bbcode) {
}
if (!tag_ok) {
class_desc->add_text("[");
p_rt->add_text("[");
pos++;
continue;
}
@ -1370,32 +1374,32 @@ void EditorHelp::_add_text(const String& p_bbcode) {
tag_stack.pop_front();
pos=brk_end+1;
if (tag!="/img")
class_desc->pop();
p_rt->pop();
} else if (tag.begins_with("method ")) {
String m = tag.substr(7,tag.length());
class_desc->push_color(EditorSettings::get_singleton()->get("text_editor/keyword_color"));
class_desc->push_meta("@"+m);
class_desc->add_text(m+"()");
class_desc->pop();
class_desc->pop();
p_rt->push_color(EditorSettings::get_singleton()->get("text_editor/keyword_color"));
p_rt->push_meta("@"+m);
p_rt->add_text(m+"()");
p_rt->pop();
p_rt->pop();
pos=brk_end+1;
} else if (doc->class_list.has(tag)) {
class_desc->push_color(EditorSettings::get_singleton()->get("text_editor/keyword_color"));
class_desc->push_meta("#"+tag);
class_desc->add_text(tag);
class_desc->pop();
class_desc->pop();
p_rt->push_color(EditorSettings::get_singleton()->get("text_editor/keyword_color"));
p_rt->push_meta("#"+tag);
p_rt->add_text(tag);
p_rt->pop();
p_rt->pop();
pos=brk_end+1;
} else if (tag=="b") {
//use bold font
class_desc->push_font(doc_code_font);
p_rt->push_font(doc_code_font);
pos=brk_end+1;
tag_stack.push_front(tag);
} else if (tag=="i") {
@ -1406,37 +1410,37 @@ void EditorHelp::_add_text(const String& p_bbcode) {
text_color.r*=1.1;
text_color.g*=1.1;
text_color.b*=1.1;
class_desc->push_color(text_color);
//class_desc->push_font(get_font("italic","Fonts"));
p_rt->push_color(text_color);
//p_rt->push_font(get_font("italic","Fonts"));
pos=brk_end+1;
tag_stack.push_front(tag);
} else if (tag=="code" || tag=="codeblock") {
//use monospace font
class_desc->push_font(doc_code_font);
p_rt->push_font(doc_code_font);
pos=brk_end+1;
tag_stack.push_front(tag);
} else if (tag=="center") {
//use monospace font
class_desc->push_align(RichTextLabel::ALIGN_CENTER);
p_rt->push_align(RichTextLabel::ALIGN_CENTER);
pos=brk_end+1;
tag_stack.push_front(tag);
} else if (tag=="br") {
//use monospace font
class_desc->add_newline();
p_rt->add_newline();
pos=brk_end+1;
} else if (tag=="u") {
//use underline
class_desc->push_underline();
p_rt->push_underline();
pos=brk_end+1;
tag_stack.push_front(tag);
} else if (tag=="s") {
//use strikethrough (not supported underline instead)
class_desc->push_underline();
p_rt->push_underline();
pos=brk_end+1;
tag_stack.push_front(tag);
@ -1447,14 +1451,14 @@ void EditorHelp::_add_text(const String& p_bbcode) {
if (end==-1)
end=bbcode.length();
String url = bbcode.substr(brk_end+1,end-brk_end-1);
class_desc->push_meta(url);
p_rt->push_meta(url);
pos=brk_end+1;
tag_stack.push_front(tag);
} else if (tag.begins_with("url=")) {
String url = tag.substr(4,tag.length());
class_desc->push_meta(url);
p_rt->push_meta(url);
pos=brk_end+1;
tag_stack.push_front("url");
} else if (tag=="img") {
@ -1467,7 +1471,7 @@ void EditorHelp::_add_text(const String& p_bbcode) {
Ref<Texture> texture = ResourceLoader::load(base_path+"/"+image,"Texture");
if (texture.is_valid())
class_desc->add_image(texture);
p_rt->add_image(texture);
pos=end;
tag_stack.push_front(tag);
@ -1515,7 +1519,7 @@ void EditorHelp::_add_text(const String& p_bbcode) {
class_desc->push_color(color);
p_rt->push_color(color);
pos=brk_end+1;
tag_stack.push_front("color");
@ -1526,9 +1530,9 @@ void EditorHelp::_add_text(const String& p_bbcode) {
Ref<Font> font = ResourceLoader::load(base_path+"/"+fnt,"Font");
if (font.is_valid())
class_desc->push_font(font);
p_rt->push_font(font);
else {
class_desc->push_font(doc_font);
p_rt->push_font(doc_font);
}
pos=brk_end+1;
@ -1537,15 +1541,23 @@ void EditorHelp::_add_text(const String& p_bbcode) {
} else {
class_desc->add_text("["); //ignore
p_rt->add_text("["); //ignore
pos=brk_pos+1;
}
}
/*class_desc->pop();
class_desc->pop();
class_desc->pop();*/
/*p_rt->pop();
p_rt->pop();
p_rt->pop();*/
}
void EditorHelp::_add_text(const String& p_bbcode) {
_add_text_to_rt(p_bbcode,class_desc);
}
@ -1703,3 +1715,71 @@ EditorHelp::~EditorHelp() {
}
/////////////
void EditorHelpBit::_go_to_help(String p_what) {
EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT);
ScriptEditor::get_singleton()->goto_help(p_what);
emit_signal("request_hide");
}
void EditorHelpBit::_meta_clicked(String p_select) {
// print_line("LINK: "+p_select);
if (p_select.begins_with("#")) {
//_goto_desc(p_select.substr(1,p_select.length()));
_go_to_help("class_name:"+p_select.substr(1,p_select.length()));
return;
} else if (p_select.begins_with("@")) {
String m = p_select.substr(1,p_select.length());
if (m.find(".")!=-1) {
//must go somewhere else
_go_to_help("class_method:"+m.get_slice(".",0)+":"+m.get_slice(".",0));
} else {
//
// if (!method_line.has(m))
// return;
//class_desc->scroll_to_line(method_line[m]);
}
}
}
void EditorHelpBit::_bind_methods() {
ObjectTypeDB::bind_method("_meta_clicked",&EditorHelpBit::_meta_clicked);
ADD_SIGNAL(MethodInfo("request_hide"));
}
void EditorHelpBit::_notification(int p_what){
if (p_what==NOTIFICATION_ENTER_TREE) {
add_style_override("panel",get_stylebox("normal","TextEdit"));
}
}
void EditorHelpBit::set_text(const String& p_text) {
rich_text->clear();
_add_text_to_rt(p_text,rich_text);
}
EditorHelpBit::EditorHelpBit() {
rich_text = memnew( RichTextLabel );
add_child(rich_text);
rich_text->set_area_as_parent_rect(8*EDSCALE);
rich_text->connect("meta_clicked",this,"_meta_clicked");
set_custom_minimum_size(Size2(0,70*EDSCALE));
}

View file

@ -200,6 +200,23 @@ public:
class EditorHelpBit : public Panel {
OBJ_TYPE( EditorHelpBit, Panel);
RichTextLabel *rich_text;
void _go_to_help(String p_what);
void _meta_clicked(String p_what);
protected:
static void _bind_methods();
void _notification(int p_what);
public:
void set_text(const String& p_text);
EditorHelpBit();
};
#endif // EDITOR_HELP_H

View file

@ -587,6 +587,7 @@ public:
EDITOR_SCRIPT
};
void set_visible_editor(EditorTable p_table) { _editor_select(p_table); }
static EditorNode* get_singleton() { return singleton; }

View file

@ -339,6 +339,8 @@ public:
void close_builtin_scripts_from_scene(const String& p_scene);
void goto_help(const String& p_desc) { _help_class_goto(p_desc); }
ScriptEditorDebugger *get_debugger() { return debugger; }
void set_live_auto_reload_running_scripts(bool p_enabled);