godot/scene/gui/graph_node.cpp

/*************************************************************************/
/*  graph_node.cpp                                                       */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                    http://www.godotengine.org                         */
/*************************************************************************/
/* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur.                 */
/*                                                                       */
/* 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.                */
/*************************************************************************/
#include "graph_node.h"
#include "method_bind_ext.inc"


bool GraphNode::_set(const StringName& p_name, const Variant& p_value) {

	if (!p_name.operator String().begins_with("slot/"))
		return false;

	int idx=p_name.operator String().get_slice("/",1).to_int();
	String what = p_name.operator String().get_slice("/",2);


	Slot si;
	if (slot_info.has(idx))
		si=slot_info[idx];


	if (what=="left_enabled")
		si.enable_left=p_value;
	else if (what=="left_type")
		si.type_left=p_value;
	else if (what=="left_color")
		si.color_left=p_value;
	else if (what=="right_enabled")
		si.enable_right=p_value;
	else if (what=="right_type")
		si.type_right=p_value;
	else if (what=="right_color")
		si.color_right=p_value;
	else
		return false;

	set_slot(idx,si.enable_left,si.type_left,si.color_left,si.enable_right,si.type_right,si.color_right);
	update();
	return true;
}

bool GraphNode::_get(const StringName& p_name,Variant &r_ret) const{



	if (!p_name.operator String().begins_with("slot/")) {
		return false;
	}

	int idx=p_name.operator String().get_slice("/",1).to_int();
	String what = p_name.operator String().get_slice("/",2);



	Slot si;
	if (slot_info.has(idx))
		si=slot_info[idx];

	if (what=="left_enabled")
		r_ret=si.enable_left;
	else if (what=="left_type")
		r_ret=si.type_left;
	else if (what=="left_color")
		r_ret=si.color_left;
	else if (what=="right_enabled")
		r_ret=si.enable_right;
	else if (what=="right_type")
		r_ret=si.type_right;
	else if (what=="right_color")
		r_ret=si.color_right;
	else
		return false;

	return true;
}
void GraphNode::_get_property_list( List<PropertyInfo> *p_list) const{

	int idx=0;
	for(int i=0;i<get_child_count();i++) {
		Control *c=get_child(i)->cast_to<Control>();
		if (!c || c->is_set_as_toplevel() )
			continue;

		String base="slot/"+itos(idx)+"/";

		p_list->push_back(PropertyInfo(Variant::BOOL,base+"left_enabled"));
		p_list->push_back(PropertyInfo(Variant::INT,base+"left_type"));
		p_list->push_back(PropertyInfo(Variant::COLOR,base+"left_color"));
		p_list->push_back(PropertyInfo(Variant::BOOL,base+"right_enabled"));
		p_list->push_back(PropertyInfo(Variant::INT,base+"right_type"));
		p_list->push_back(PropertyInfo(Variant::COLOR,base+"right_color"));

		idx++;
	}
}


void GraphNode::_resort() {



	int sep=get_constant("separation");
	Ref<StyleBox> sb=get_stylebox("frame");
	bool first=true;

	Size2 minsize;

	for(int i=0;i<get_child_count();i++) {
		Control *c=get_child(i)->cast_to<Control>();
		if (!c)
			continue;
		if (c->is_set_as_toplevel())
			continue;

		Size2i size=c->get_combined_minimum_size();

		minsize.y+=size.y;
		minsize.x=MAX(minsize.x,size.x);

		if (first)
			first=false;
		else
			minsize.y+=sep;

	}


	int vofs=0;
	int w = get_size().x - sb->get_minimum_size().x;


	cache_y.clear();
	for(int i=0;i<get_child_count();i++) {
		Control *c=get_child(i)->cast_to<Control>();
		if (!c)
			continue;
		if (c->is_set_as_toplevel())
			continue;

		Size2i size=c->get_combined_minimum_size();

		Rect2 r(sb->get_margin(MARGIN_LEFT),sb->get_margin(MARGIN_TOP)+vofs,w,size.y);

		fit_child_in_rect(c,r);
		cache_y.push_back(vofs+size.y*0.5);

		if (vofs>0)
			vofs+=sep;
		vofs+=size.y;


	}

	_change_notify();
	update();
	connpos_dirty=true;


}


void GraphNode::_notification(int p_what) {

	if (p_what==NOTIFICATION_DRAW) {

		Ref<StyleBox> sb=get_stylebox(selected ? "selectedframe" : "frame");
		sb=sb->duplicate();
		sb->call("set_modulate",modulate);
		Ref<Texture> port =get_icon("port");
		Ref<Texture> close =get_icon("close");
		int close_offset = get_constant("close_offset");
		Ref<Font> title_font = get_font("title_font");
		int title_offset = get_constant("title_offset");
		Color title_color = get_color("title_color");
		Point2i icofs = -port->get_size()*0.5;
		int edgeofs=get_constant("port_offset");
		icofs.y+=sb->get_margin(MARGIN_TOP);



		draw_style_box(sb,Rect2(Point2(),get_size()));

		switch(overlay) {
			case OVERLAY_DISABLED: {

			} break;
			case OVERLAY_BREAKPOINT: {

				draw_style_box(get_stylebox("breakpoint"),Rect2(Point2(),get_size()));
			} break;
			case OVERLAY_POSITION: {
				draw_style_box(get_stylebox("position"),Rect2(Point2(),get_size()));

			} break;
		}

		int w = get_size().width-sb->get_minimum_size().x;

		if (show_close)
			w-=close->get_width();

		draw_string(title_font,Point2(sb->get_margin(MARGIN_LEFT),-title_font->get_height()+title_font->get_ascent()+title_offset),title,title_color,w);
		if (show_close) {
			Vector2 cpos = Point2(w+sb->get_margin(MARGIN_LEFT),-close->get_height()+close_offset);
			draw_texture(close,cpos);
			close_rect.pos=cpos;
			close_rect.size=close->get_size();
		} else {
			close_rect=Rect2();
		}

		for (Map<int,Slot>::Element *E=slot_info.front();E;E=E->next()) {

			if (E->key() < 0 || E->key()>=cache_y.size())
				continue;
			if (!slot_info.has(E->key()))
				continue;
			const Slot &s=slot_info[E->key()];
			//left
			if (s.enable_left) {
				Ref<Texture> p = port;
				if (s.custom_slot_left.is_valid()) {
					p=s.custom_slot_left;
				}
				p->draw(get_canvas_item(),icofs+Point2(edgeofs,cache_y[E->key()]),s.color_left);
			}
			if (s.enable_right) {
				Ref<Texture> p = port;
				if (s.custom_slot_right.is_valid()) {
					p=s.custom_slot_right;
				}
				p->draw(get_canvas_item(),icofs+Point2(get_size().x-edgeofs,cache_y[E->key()]),s.color_right);
			}

		}
	}

	if (p_what==NOTIFICATION_SORT_CHILDREN) {

		_resort();
	}

}


void GraphNode::set_slot(int p_idx,bool p_enable_left,int p_type_left,const Color& p_color_left, bool p_enable_right,int p_type_right,const Color& p_color_right,const Ref<Texture>& p_custom_left,const Ref<Texture>& p_custom_right) {

	ERR_FAIL_COND(p_idx<0);

	if (!p_enable_left && p_type_left==0 && p_color_left==Color(1,1,1,1) && !p_enable_right && p_type_right==0 && p_color_right==Color(1,1,1,1)) {
		slot_info.erase(p_idx);
		return;
	}

	Slot s;
	s.enable_left=p_enable_left;
	s.type_left=p_type_left;
	s.color_left=p_color_left;
	s.enable_right=p_enable_right;
	s.type_right=p_type_right;
	s.color_right=p_color_right;
	s.custom_slot_left=p_custom_left;
	s.custom_slot_right=p_custom_right;
	slot_info[p_idx]=s;
	update();
	connpos_dirty=true;

}

void GraphNode::clear_slot(int p_idx){

	slot_info.erase(p_idx);
	update();
	connpos_dirty=true;

}
void GraphNode::clear_all_slots(){

	slot_info.clear();
	update();
	connpos_dirty=true;

}
bool GraphNode::is_slot_enabled_left(int p_idx) const{

	if (!slot_info.has(p_idx))
		return false;
	return slot_info[p_idx].enable_left;

}

int GraphNode::get_slot_type_left(int p_idx) const{

	if (!slot_info.has(p_idx))
		return 0;
	return slot_info[p_idx].type_left;

}

Color GraphNode::get_slot_color_left(int p_idx) const{

	if (!slot_info.has(p_idx))
		return Color(1,1,1,1);
	return slot_info[p_idx].color_left;

}

bool GraphNode::is_slot_enabled_right(int p_idx) const{

	if (!slot_info.has(p_idx))
		return false;
	return slot_info[p_idx].enable_right;

}



int GraphNode::get_slot_type_right(int p_idx) const{

	if (!slot_info.has(p_idx))
		return 0;
	return slot_info[p_idx].type_right;

}

Color GraphNode::get_slot_color_right(int p_idx) const{

	if (!slot_info.has(p_idx))
		return Color(1,1,1,1);
	return slot_info[p_idx].color_right;

}

Size2 GraphNode::get_minimum_size() const {

	Ref<Font> title_font = get_font("title_font");

	int sep=get_constant("separation");
	Ref<StyleBox> sb=get_stylebox("frame");
	bool first=true;

	Size2 minsize;
	minsize.x=title_font->get_string_size(title).x;
	if (show_close) {
		Ref<Texture> close =get_icon("close");
		minsize.x+=sep+close->get_width();
	}


	for(int i=0;i<get_child_count();i++) {

		Control *c=get_child(i)->cast_to<Control>();
		if (!c)
			continue;
		if (c->is_set_as_toplevel())
			continue;

		Size2i size=c->get_combined_minimum_size();

		minsize.y+=size.y;
		minsize.x=MAX(minsize.x,size.x);

		if (first)
			first=false;
		else
			minsize.y+=sep;
	}

	return minsize+sb->get_minimum_size();
}

void GraphNode::set_title(const String& p_title) {

	title=p_title;
	minimum_size_changed();
	update();

}

String GraphNode::get_title() const{

	return title;
}

void GraphNode::set_offset(const Vector2& p_offset) {

	offset=p_offset;
	emit_signal("offset_changed");
	update();
}

Vector2 GraphNode::get_offset() const {

	return offset;
}

void GraphNode::set_selected(bool p_selected)
{
	selected = p_selected;
	update();
}

bool GraphNode::is_selected()
{
	return selected;
}

void GraphNode::set_drag(bool p_drag)
{
	if (p_drag)
		drag_from=get_offset();
	else
		emit_signal("dragged",drag_from,get_offset()); //useful for undo/redo
}

Vector2 GraphNode::get_drag_from()
{
	return drag_from;
}


void GraphNode::set_show_close_button(bool p_enable){

	show_close=p_enable;
	update();
}
bool GraphNode::is_close_button_visible() const{

	return show_close;
}

void GraphNode::_connpos_update() {


	int edgeofs=get_constant("port_offset");
	int sep=get_constant("separation");

	Ref<StyleBox> sb=get_stylebox("frame");
	conn_input_cache.clear();
	conn_output_cache.clear();
	int vofs=0;

	int idx=0;

	for(int i=0;i<get_child_count();i++) {
		Control *c=get_child(i)->cast_to<Control>();
		if (!c)
			continue;
		if (c->is_set_as_toplevel())
			continue;

		Size2i size=c->get_combined_minimum_size();

		int y = sb->get_margin(MARGIN_TOP)+vofs;
		int h = size.y;


		if (slot_info.has(idx)) {

			if (slot_info[idx].enable_left) {
				ConnCache cc;
				cc.pos=Point2i(edgeofs,y+h/2);
				cc.type=slot_info[idx].type_left;
				cc.color=slot_info[idx].color_left;
				conn_input_cache.push_back(cc);
			}
			if (slot_info[idx].enable_right) {
				ConnCache cc;
				cc.pos=Point2i(get_size().width-edgeofs,y+h/2);
				cc.type=slot_info[idx].type_right;
				cc.color=slot_info[idx].color_right;
				conn_output_cache.push_back(cc);
			}
		}

		if (vofs>0)
			vofs+=sep;
		vofs+=size.y;
		idx++;

	}


	connpos_dirty=false;
}

int GraphNode::get_connection_input_count()  {

	if (connpos_dirty)
		_connpos_update();

	return conn_input_cache.size();

}
int GraphNode::get_connection_output_count() {

	if (connpos_dirty)
		_connpos_update();

	return conn_output_cache.size();

}


Vector2 GraphNode::get_connection_input_pos(int p_idx) {

	if (connpos_dirty)
		_connpos_update();

	ERR_FAIL_INDEX_V(p_idx,conn_input_cache.size(),Vector2());
	Vector2 pos = conn_input_cache[p_idx].pos;
	pos.x *= get_scale().x;
	pos.y *= get_scale().y;
	return pos;
}

int GraphNode::get_connection_input_type(int p_idx) {

	if (connpos_dirty)
		_connpos_update();

	ERR_FAIL_INDEX_V(p_idx,conn_input_cache.size(),0);
	return conn_input_cache[p_idx].type;
}

Color GraphNode::get_connection_input_color(int p_idx) {

	if (connpos_dirty)
		_connpos_update();

	ERR_FAIL_INDEX_V(p_idx,conn_input_cache.size(),Color());
	return conn_input_cache[p_idx].color;
}

Vector2 GraphNode::get_connection_output_pos(int p_idx){

	if (connpos_dirty)
		_connpos_update();

	ERR_FAIL_INDEX_V(p_idx,conn_output_cache.size(),Vector2());
	Vector2 pos = conn_output_cache[p_idx].pos;
	pos.x *= get_scale().x;
	pos.y *= get_scale().y;
	return pos;
}

int GraphNode::get_connection_output_type(int p_idx) {

	if (connpos_dirty)
		_connpos_update();

	ERR_FAIL_INDEX_V(p_idx,conn_output_cache.size(),0);
	return conn_output_cache[p_idx].type;
}

Color GraphNode::get_connection_output_color(int p_idx) {

	if (connpos_dirty)
		_connpos_update();

	ERR_FAIL_INDEX_V(p_idx,conn_output_cache.size(),Color());
	return conn_output_cache[p_idx].color;
}

void GraphNode::_input_event(const InputEvent& p_ev) {

	if (p_ev.type==InputEvent::MOUSE_BUTTON) {

		ERR_EXPLAIN("GraphNode must be the child of a GraphEdit node.");
		ERR_FAIL_COND(get_parent_control() == NULL);

		get_parent_control()->grab_focus();

		if(p_ev.mouse_button.pressed && p_ev.mouse_button.button_index==BUTTON_LEFT) {

			Vector2 mpos = Vector2(p_ev.mouse_button.x,p_ev.mouse_button.y);
			if (close_rect.size!=Size2() && close_rect.has_point(mpos)) {
				emit_signal("close_request");
				return;
			}
			emit_signal("raise_request");
		}
	}

}

void GraphNode::set_modulate(const Color &p_color) {

	modulate=p_color;
	update();
}

Color GraphNode::get_modulate() const{

	return modulate;
}
void GraphNode::set_overlay(Overlay p_overlay) {

	overlay=p_overlay;
	update();
}

GraphNode::Overlay GraphNode::get_overlay() const{

	return overlay;
}

void GraphNode::_bind_methods() {

	ObjectTypeDB::bind_method(_MD("set_title","title"),&GraphNode::set_title);
	ObjectTypeDB::bind_method(_MD("get_title"),&GraphNode::get_title);
	ObjectTypeDB::bind_method(_MD("_input_event"),&GraphNode::_input_event);

	ObjectTypeDB::bind_method(_MD("set_slot","idx","enable_left","type_left","color_left","enable_right","type_right","color_right","custom_left","custom_right"),&GraphNode::set_slot,DEFVAL(Ref<Texture>()),DEFVAL(Ref<Texture>()));
	ObjectTypeDB::bind_method(_MD("clear_slot","idx"),&GraphNode::clear_slot);
	ObjectTypeDB::bind_method(_MD("clear_all_slots","idx"),&GraphNode::clear_all_slots);
	ObjectTypeDB::bind_method(_MD("is_slot_enabled_left","idx"),&GraphNode::is_slot_enabled_left);
	ObjectTypeDB::bind_method(_MD("get_slot_type_left","idx"),&GraphNode::get_slot_type_left);
	ObjectTypeDB::bind_method(_MD("get_slot_color_left","idx"),&GraphNode::get_slot_color_left);
	ObjectTypeDB::bind_method(_MD("is_slot_enabled_right","idx"),&GraphNode::is_slot_enabled_right);
	ObjectTypeDB::bind_method(_MD("get_slot_type_right","idx"),&GraphNode::get_slot_type_right);
	ObjectTypeDB::bind_method(_MD("get_slot_color_right","idx"),&GraphNode::get_slot_color_right);

	ObjectTypeDB::bind_method(_MD("set_offset","offset"),&GraphNode::set_offset);
	ObjectTypeDB::bind_method(_MD("get_offset"),&GraphNode::get_offset);

	ObjectTypeDB::bind_method(_MD("get_connection_output_count"),&GraphNode::get_connection_output_count);
	ObjectTypeDB::bind_method(_MD("get_connection_input_count"),&GraphNode::get_connection_input_count);

	ObjectTypeDB::bind_method(_MD("get_connection_output_pos","idx"),&GraphNode::get_connection_output_pos);
	ObjectTypeDB::bind_method(_MD("get_connection_output_type","idx"),&GraphNode::get_connection_output_type);
	ObjectTypeDB::bind_method(_MD("get_connection_output_color","idx"),&GraphNode::get_connection_output_color);
	ObjectTypeDB::bind_method(_MD("get_connection_input_pos","idx"),&GraphNode::get_connection_input_pos);
	ObjectTypeDB::bind_method(_MD("get_connection_input_type","idx"),&GraphNode::get_connection_input_type);
	ObjectTypeDB::bind_method(_MD("get_connection_input_color","idx"),&GraphNode::get_connection_input_color);

	ObjectTypeDB::bind_method(_MD("set_modulate","color"),&GraphNode::set_modulate);
	ObjectTypeDB::bind_method(_MD("get_modulate"),&GraphNode::get_modulate);

	ObjectTypeDB::bind_method(_MD("set_show_close_button","show"),&GraphNode::set_show_close_button);
	ObjectTypeDB::bind_method(_MD("is_close_button_visible"),&GraphNode::is_close_button_visible);

	ObjectTypeDB::bind_method(_MD("set_overlay","overlay"),&GraphNode::set_overlay);
	ObjectTypeDB::bind_method(_MD("get_overlay"),&GraphNode::get_overlay);

	ADD_PROPERTY( PropertyInfo(Variant::STRING,"title"),_SCS("set_title"),_SCS("get_title"));
	ADD_PROPERTY( PropertyInfo(Variant::BOOL,"show_close"),_SCS("set_show_close_button"),_SCS("is_close_button_visible"));

	ADD_SIGNAL(MethodInfo("offset_changed"));
	ADD_SIGNAL(MethodInfo("dragged",PropertyInfo(Variant::VECTOR2,"from"),PropertyInfo(Variant::VECTOR2,"to")));
	ADD_SIGNAL(MethodInfo("raise_request"));
	ADD_SIGNAL(MethodInfo("close_request"));

	BIND_CONSTANT( OVERLAY_DISABLED );
	BIND_CONSTANT( OVERLAY_BREAKPOINT );
	BIND_CONSTANT( OVERLAY_POSITION );
}

GraphNode::GraphNode() {

	overlay=OVERLAY_DISABLED;
	show_close=false;
	connpos_dirty=true;
	set_stop_mouse(false);
	modulate=Color(1,1,1,1);
}