botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add property editor for blackboard parameters

This commit is contained in:
Serhii Snitsaruk 2023-12-08 21:56:14 +01:00
parent b94428b35b
commit b4bef31df5
8 changed files with 404 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
blackboard/bb_param/bb_param.h
View File

@ -41,8 +41,6 @@ private:
protected:
static void _bind_methods();
virtual Variant::Type get_type() const { return Variant::NIL; }
_FORCE_INLINE_ void _assign_default_value() {
Callable::CallError err;
Variant::construct(get_type(), saved_value, nullptr, 0, err);
@ -51,6 +49,8 @@ protected:
void _get_property_list(List<PropertyInfo> *p_list) const;
public:
virtual Variant::Type get_type() const { return Variant::NIL; }
void set_value_source(ValueSource p_value);
ValueSource get_value_source() const { return value_source; }

1
demo/ai/tasks/arrive_pos.gd
View File

@ -11,7 +11,6 @@
@tool
@icon("res://icon.png")
class_name ArrivePos
extends BTAction
@export var target_position_var := "target_position"

1
demo/project.godot
View File

@ -11,6 +11,7 @@ config_version=5
[application]
config/name="LimboAI Test"
config/tags=PackedStringArray("demo")
run/main_scene="res://examples/waypoints/example_waypoints.tscn"
config/features=PackedStringArray("4.2")
config/icon="res://icon.png"

37
demo/tests/blackboard_parameters/test_bb_params.gd Normal file
View File

@ -0,0 +1,37 @@
@tool
class_name TestBBParams
extends Resource
@export var bool_param: BBBool
@export var int_param: BBInt
@export var float_param: BBFloat
@export var string_param: BBString
@export var vec2_param: BBVector2
@export var vec2i_param: BBVector2i
@export var rect2_param: BBRect2
@export var rect2i_param: BBRect2i
@export var vector3_param: BBVector3
@export var vector3i_param: BBVector3i
@export var vector4_param: BBVector4
@export var vector4i_param: BBVector4i
@export var transform2d_param: BBTransform2D
@export var plane_param: BBPlane
@export var quaternion_param: BBQuaternion
@export var aabb_param: BBAabb
@export var basis_param: BBBasis
@export var transform3d_param: BBTransform3D
#@export var projection_param: BBProjection
@export var color_param: BBColor
@export var stringname_param: BBStringName
@export var node_param: BBNode
@export var dictionary_param: BBDictionary
@export var array_param: BBArray
@export var byte_array_param: BBByteArray
@export var int_array_param: BBIntArray
@export var float_array_param: BBFloatArray
@export var string_array_param: BBStringArray
@export var vector2_array_param: BBVector2Array
@export var vector3_array_param: BBVector2Array
@export var color_array_param: BBColorArray
@export var variant_param: BBVariant

301
editor/editor_property_bb_param.cpp Normal file
View File

@ -0,0 +1,301 @@
/**
* editor_property_bb_param.cpp
* =============================================================================
* Copyright 2021-2023 Serhii Snitsaruk
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE file or at
* https://opensource.org/licenses/MIT.
* =============================================================================
*/
#include "editor_property_bb_param.h"
#include "modules/limboai/blackboard/bb_param/bb_param.h"
#include "core/error/error_macros.h"
#include "core/object/class_db.h"
#include "core/os/memory.h"
#include "core/string/print_string.h"
#include "editor/editor_inspector.h"
#include "editor/editor_properties.h"
#include "editor/editor_properties_array_dict.h"
#include "editor/editor_properties_vector.h"
#include "editor/editor_settings.h"
#include "scene/gui/base_button.h"
#include "scene/gui/box_container.h"
#include "scene/gui/button.h"
#include "scene/gui/line_edit.h"
Ref<BBParam> EditorPropertyBBParam::_get_edited_param() {
Ref<BBParam> param = get_edited_property_value();
if (param.is_null()) {
// Create parameter resource if null.
param = ClassDB::instantiate(param_type);
get_edited_object()->set(get_edited_property(), param);
}
return param;
}
void EditorPropertyBBParam::_create_value_editor(Variant::Type p_type) {
if (value_editor) {
if (value_editor->get_meta(SNAME("_param_type")) == Variant(p_type)) {
return;
}
_remove_value_editor();
}
switch (p_type) {
case Variant::BOOL: {
value_editor = memnew(EditorPropertyCheck);
} break;
case Variant::INT: {
EditorPropertyInteger *editor = memnew(EditorPropertyInteger);
editor->setup(-100000, 100000, 1, false, true, true);
value_editor = editor;
} break;
case Variant::FLOAT: {
EditorPropertyFloat *editor = memnew(EditorPropertyFloat);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true, false, true, true);
value_editor = editor;
} break;
case Variant::STRING: {
if (property_hint == PROPERTY_HINT_MULTILINE_TEXT) {
value_editor = memnew(EditorPropertyMultilineText);
} else {
value_editor = memnew(EditorPropertyText);
}
} break;
case Variant::VECTOR2: {
EditorPropertyVector2 *editor = memnew(EditorPropertyVector2);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::VECTOR2I: {
EditorPropertyVector2i *editor = memnew(EditorPropertyVector2i);
editor->setup(-100000, 100000);
value_editor = editor;
} break;
case Variant::RECT2: {
EditorPropertyRect2 *editor = memnew(EditorPropertyRect2);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::RECT2I: {
EditorPropertyRect2i *editor = memnew(EditorPropertyRect2i);
editor->setup(-100000, 100000);
value_editor = editor;
} break;
case Variant::VECTOR3: {
EditorPropertyVector3 *editor = memnew(EditorPropertyVector3);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::VECTOR3I: {
EditorPropertyVector3i *editor = memnew(EditorPropertyVector3i);
editor->setup(-100000, 100000);
value_editor = editor;
} break;
case Variant::VECTOR4: {
EditorPropertyVector4 *editor = memnew(EditorPropertyVector4);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::VECTOR4I: {
EditorPropertyVector4i *editor = memnew(EditorPropertyVector4i);
editor->setup(-100000, 100000);
value_editor = editor;
} break;
case Variant::TRANSFORM2D: {
EditorPropertyTransform2D *editor = memnew(EditorPropertyTransform2D);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::PLANE: {
EditorPropertyPlane *editor = memnew(EditorPropertyPlane);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::QUATERNION: {
EditorPropertyQuaternion *editor = memnew(EditorPropertyQuaternion);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::AABB: {
EditorPropertyAABB *editor = memnew(EditorPropertyAABB);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::BASIS: {
EditorPropertyBasis *editor = memnew(EditorPropertyBasis);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::TRANSFORM3D: {
EditorPropertyTransform3D *editor = memnew(EditorPropertyTransform3D);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::PROJECTION: {
EditorPropertyProjection *editor = memnew(EditorPropertyProjection);
editor->setup(-100000, 100000, EDITOR_GET("interface/inspector/default_float_step"), true);
value_editor = editor;
} break;
case Variant::COLOR: {
value_editor = memnew(EditorPropertyColor);
} break;
case Variant::STRING_NAME: {
EditorPropertyText *editor = memnew(EditorPropertyText);
editor->set_string_name(true);
value_editor = editor;
} break;
case Variant::NODE_PATH: {
value_editor = memnew(EditorPropertyNodePath);
} break;
// case Variant::RID: {
// } break;
// case Variant::SIGNAL: {
// } break;
// case Variant::CALLABLE: {
// } break;
// case Variant::OBJECT: {
// } break;
case Variant::DICTIONARY: {
value_editor = memnew(EditorPropertyDictionary);
} break;
case Variant::ARRAY:
case Variant::PACKED_BYTE_ARRAY:
case Variant::PACKED_INT32_ARRAY:
case Variant::PACKED_FLOAT32_ARRAY:
case Variant::PACKED_INT64_ARRAY:
case Variant::PACKED_FLOAT64_ARRAY:
case Variant::PACKED_STRING_ARRAY:
case Variant::PACKED_VECTOR2_ARRAY:
case Variant::PACKED_VECTOR3_ARRAY:
case Variant::PACKED_COLOR_ARRAY: {
EditorPropertyArray *editor = memnew(EditorPropertyArray);
editor->setup(p_type);
value_editor = editor;
} break;
default: {
ERR_PRINT("Unexpected variant type!");
value_editor = memnew(EditorPropertyNil);
}
}
value_editor->set_name_split_ratio(0.0);
hbox->add_child(value_editor);
value_editor->set_h_size_flags(SIZE_EXPAND_FILL);
value_editor->set_meta(SNAME("_param_type"), p_type);
value_editor->connect(SNAME("property_changed"), callable_mp(this, &EditorPropertyBBParam::_value_edited));
}
void EditorPropertyBBParam::_remove_value_editor() {
if (value_editor) {
hbox->remove_child(value_editor);
value_editor->queue_free();
value_editor = nullptr;
}
}
void EditorPropertyBBParam::_value_edited(const String &p_property, Variant p_value, const String &p_name, bool p_changing) {
_get_edited_param()->set_saved_value(p_value);
}
void EditorPropertyBBParam::_mode_changed() {
_get_edited_param()->set_value_source(value_mode->is_pressed() ? BBParam::SAVED_VALUE : BBParam::BLACKBOARD_VAR);
update_property();
}
void EditorPropertyBBParam::_variable_edited(const String &p_text) {
_get_edited_param()->set_variable(p_text);
}
void EditorPropertyBBParam::update_property() {
Ref<BBParam> param = _get_edited_param();
if (param->get_value_source() == BBParam::BLACKBOARD_VAR) {
_remove_value_editor();
variable_edit->set_text(param->get_variable());
variable_edit->set_editable(true);
variable_edit->show();
variable_mode->set_pressed_no_signal(true);
value_mode->set_pressed_no_signal(false);
} else {
variable_edit->hide();
_create_value_editor(param->get_type());
value_editor->show();
value_editor->set_object_and_property(param.ptr(), SNAME("saved_value"));
value_mode->set_pressed_no_signal(true);
variable_mode->set_pressed_no_signal(false);
value_editor->update_property();
}
}
void EditorPropertyBBParam::setup(PropertyHint p_hint, const String &p_hint_text) {
param_type = p_hint_text;
property_hint = p_hint;
}
void EditorPropertyBBParam::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_ENTER_TREE:
case NOTIFICATION_THEME_CHANGED: {
value_mode->set_icon(get_editor_theme_icon(SNAME("LimboSpecifyValue")));
variable_mode->set_icon(get_editor_theme_icon(SNAME("BTSetVar")));
} break;
}
}
EditorPropertyBBParam::EditorPropertyBBParam() {
hbox = memnew(HBoxContainer);
add_child(hbox);
HBoxContainer *modes = memnew(HBoxContainer);
hbox->add_child(modes);
modes->add_theme_constant_override("separation", 0);
Ref<ButtonGroup> modes_group;
modes_group.instantiate();
value_mode = memnew(Button);
modes->add_child(value_mode);
value_mode->set_focus_mode(FOCUS_NONE);
value_mode->set_button_group(modes_group);
value_mode->set_toggle_mode(true);
value_mode->set_tooltip_text(TTR("Specify value"));
value_mode->connect(SNAME("pressed"), callable_mp(this, &EditorPropertyBBParam::_mode_changed));
variable_mode = memnew(Button);
modes->add_child(variable_mode);
variable_mode->set_focus_mode(FOCUS_NONE);
variable_mode->set_button_group(modes_group);
variable_mode->set_toggle_mode(true);
variable_mode->set_tooltip_text(TTR("Bind to a blackboard variable"));
variable_mode->connect(SNAME("pressed"), callable_mp(this, &EditorPropertyBBParam::_mode_changed));
variable_edit = memnew(LineEdit);
hbox->add_child(variable_edit);
variable_edit->set_placeholder(TTR("Variable"));
variable_edit->set_h_size_flags(SIZE_EXPAND_FILL);
variable_edit->connect(SNAME("text_changed"), callable_mp(this, &EditorPropertyBBParam::_variable_edited));
param_type = SNAME("BBString");
}
//***** EditorInspectorPluginBBParam
bool EditorInspectorPluginBBParam::can_handle(Object *p_object) {
return true; // Handles everything.
}
bool EditorInspectorPluginBBParam::parse_property(Object *p_object, const Variant::Type p_type, const String &p_path, const PropertyHint p_hint, const String &p_hint_text, const BitField<PropertyUsageFlags> p_usage, const bool p_wide) {
if (p_hint == PROPERTY_HINT_RESOURCE_TYPE && p_hint_text.begins_with("BB")) {
// TODO: Add more rigid hint check.
EditorPropertyBBParam *editor = memnew(EditorPropertyBBParam());
editor->setup(p_hint, p_hint_text);
add_property_editor(p_path, editor);
return true;
}
return false;
}

60
editor/editor_property_bb_param.h Normal file
View File

@ -0,0 +1,60 @@
/**
* editor_property_bb_param.h
* =============================================================================
* Copyright 2021-2023 Serhii Snitsaruk
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE file or at
* https://opensource.org/licenses/MIT.
* =============================================================================
*/
#ifndef EDITOR_PROPERTY_BB_PARAM_H
#define EDITOR_PROPERTY_BB_PARAM_H
#include "core/object/object.h"
#include "editor/editor_inspector.h"
#include "modules/limboai/blackboard/bb_param/bb_param.h"
class EditorPropertyBBParam : public EditorProperty {
GDCLASS(EditorPropertyBBParam, EditorProperty);
private:
StringName param_type;
PropertyHint property_hint = PROPERTY_HINT_NONE;
HBoxContainer *hbox = nullptr;
Button *value_mode = nullptr;
Button *variable_mode = nullptr;
EditorProperty *value_editor = nullptr;
LineEdit *variable_edit = nullptr;
Ref<BBParam> _get_edited_param();
void _create_value_editor(Variant::Type p_type);
void _remove_value_editor();
void _value_edited(const String &p_property, Variant p_value, const String &p_name = "", bool p_changing = false);
void _variable_edited(const String &p_text);
void _mode_changed();
protected:
void _notification(int p_what);
public:
virtual void update_property() override;
void setup(PropertyHint p_hint, const String &p_hint_text);
EditorPropertyBBParam();
};
class EditorInspectorPluginBBParam : public EditorInspectorPlugin {
GDCLASS(EditorInspectorPluginBBParam, EditorInspectorPlugin);
public:
virtual bool can_handle(Object *p_object) override;
virtual bool parse_property(Object *p_object, const Variant::Type p_type, const String &p_path, const PropertyHint p_hint, const String &p_hint_text, const BitField<PropertyUsageFlags> p_usage, const bool p_wide = false) override;
};
#endif // EDITOR_PROPERTY_BB_PARAM_H

2
editor/limbo_ai_editor_plugin.cpp
View File

@ -18,6 +18,7 @@
#include "modules/limboai/bt/tasks/composites/bt_probability_selector.h"
#include "modules/limboai/bt/tasks/composites/bt_selector.h"
#include "modules/limboai/editor/debugger/limbo_debugger_plugin.h"
#include "modules/limboai/editor/editor_property_bb_param.h"
#include "modules/limboai/util/limbo_utility.h"
#include "core/config/project_settings.h"
@ -1157,6 +1158,7 @@ LimboAIEditorPlugin::LimboAIEditorPlugin() {
EditorNode::get_singleton()->get_main_screen_control()->add_child(limbo_ai_editor);
limbo_ai_editor->hide();
add_debugger_plugin(memnew(LimboDebuggerPlugin));
add_inspector_plugin(memnew(EditorInspectorPluginBBParam));
}
LimboAIEditorPlugin::~LimboAIEditorPlugin() {

1
icons/LimboSpecifyValue.svg Normal file
View File

@ -0,0 +1 @@
<svg clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><path d="m0 0h16v16h-16z" fill="none"/><g fill="#e0e0e0"><path d="m1397.93 4.142v6.609c0 .94-.763 1.703-1.703 1.703h-6.609c-.94 0-1.703-.763-1.703-1.703v-6.609c0-.94.763-1.703 1.703-1.703h6.609c.94 0 1.703.763 1.703 1.703zm-.668 0c0-.572-.464-1.035-1.035-1.035h-6.609c-.572 0-1.035.463-1.035 1.035v6.609c0 .571.463 1.035 1.035 1.035h6.609c.571 0 1.035-.464 1.035-1.035z" transform="matrix(1.4978 0 0 1.4978 -2078.316 -3.15325)"/><path d="m1360.05 1.642c-1.019 0-1.932-.298-2.738-.892-.806-.595-1.44-1.459-1.903-2.592-.462-1.133-.693-2.504-.693-4.113 0-1.608.231-2.979.693-4.113.463-1.133 1.097-1.997 1.903-2.591.806-.595 1.719-.892 2.738-.892 1.032 0 1.947.297 2.748.892.8.594 1.431 1.458 1.893 2.591.463 1.134.694 2.505.694 4.113 0 1.609-.231 2.98-.694 4.113-.462 1.133-1.093 1.997-1.893 2.592-.801.594-1.716.892-2.748.892zm0-2.875c.486 0 .91-.161 1.272-.483.361-.322.646-.832.853-1.532.208-.699.311-1.601.311-2.707 0-1.105-.103-2.007-.311-2.707-.207-.699-.492-1.21-.853-1.531-.362-.322-.786-.483-1.272-.483-.474 0-.892.161-1.253.483-.362.321-.646.832-.854 1.531-.207.7-.311 1.602-.311 2.707 0 1.106.104 2.008.311 2.707.208.7.492 1.21.854 1.532.361.322.779.483 1.253.483z" fill-rule="nonzero" transform="matrix(.337428 0 0 .285928 -453.917 6.80259)"/><path d="m1373.24-10.571h-2.489v-2.728h5.37v14.689h-2.881z" transform="matrix(.337428 0 0 .285928 -452.885 6.80259)"/><path d="m1356.6 9.714h-2.49v-2.728h5.37v14.689h-2.88z" transform="matrix(.337428 0 0 .285928 -452.819 6.80259)"/><path d="m1371.59 21.927c-1.02 0-1.933-.298-2.739-.892-.806-.595-1.44-1.459-1.902-2.592-.463-1.133-.694-2.504-.694-4.113s.231-2.98.694-4.113c.462-1.133 1.096-1.997 1.902-2.591.806-.595 1.719-.892 2.739-.892 1.031 0 1.947.297 2.747.892.8.594 1.431 1.458 1.894 2.591.462 1.133.693 2.504.693 4.113s-.231 2.98-.693 4.113c-.463 1.133-1.094 1.997-1.894 2.592-.8.594-1.716.892-2.747.892zm0-2.875c.486 0 .909-.161 1.271-.483.361-.322.646-.832.853-1.532.208-.699.312-1.602.312-2.707s-.104-2.007-.312-2.707c-.207-.699-.492-1.21-.853-1.532-.362-.321-.785-.482-1.271-.482-.475 0-.892.161-1.254.482-.362.322-.646.833-.854 1.532-.207.7-.311 1.602-.311 2.707s.104 2.008.311 2.707c.208.7.492 1.21.854 1.532s.779.483 1.254.483z" fill-rule="nonzero" transform="matrix(.337428 0 0 .285928 -451.815 6.80259)"/></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 2.4 KiB