archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Cycles: OSL metadata support for UI labels and checkboxes

Browse Source 
To improve the presentation of nodes in the node editor. Recognize the
following metadata from the OSL specification:

* [[ string label = "UI Label" ]]
* [[ string widget = "checkBox" ]]
* [[ string widget = "boolean" ]]

Ref T89741

Differential Revision: https://developer.blender.org/D12074
This commit is contained in:
Pedro A
2021-08-11 14:49:48 +02:00
committed by Brecht Van Lommel
parent 6d24017529
commit e6bbbd965a
1 changed files with 81 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
intern/cycles/blender/blender_python.cpp
View File

@@ -487,6 +487,24 @@ static PyObject *osl_update_node_func(PyObject * /*self*/, PyObject *args)
if (param->varlenarray || param->isstruct || param->type.arraylen > 1) if (param->varlenarray || param->isstruct || param->type.arraylen > 1)
continue; continue;
/* Read metadata. */
bool is_bool_param = false;
ustring param_label = param->name;
for (const OSL::OSLQuery::Parameter &metadata : param->metadata) {
if (metadata.type == TypeDesc::STRING) {
if (metadata.name == "widget") {
/* Boolean socket. */
if (metadata.sdefault[0] == "boolean" || metadata.sdefault[0] == "checkBox") {
is_bool_param = true;
}
}
else if (metadata.name == "label") {
/* Socket label. */
param_label = metadata.sdefault[0];
}
}
}
/* determine socket type */ /* determine socket type */
string socket_type; string socket_type;
BL::NodeSocket::type_enum data_type = BL::NodeSocket::type_VALUE; BL::NodeSocket::type_enum data_type = BL::NodeSocket::type_VALUE;
@@ -494,6 +512,7 @@ static PyObject *osl_update_node_func(PyObject * /*self*/, PyObject *args)
float default_float = 0.0f; float default_float = 0.0f;
int default_int = 0; int default_int = 0;
string default_string = ""; string default_string = "";
bool default_boolean = false;
if (param->isclosure) { if (param->isclosure) {
socket_type = "NodeSocketShader"; socket_type = "NodeSocketShader";
@@ -523,10 +542,19 @@ static PyObject *osl_update_node_func(PyObject * /*self*/, PyObject *args)
} }
else if (param->type.aggregate == TypeDesc::SCALAR) { else if (param->type.aggregate == TypeDesc::SCALAR) {
if (param->type.basetype == TypeDesc::INT) { if (param->type.basetype == TypeDesc::INT) {
socket_type = "NodeSocketInt"; if (is_bool_param) {
data_type = BL::NodeSocket::type_INT; socket_type = "NodeSocketBool";
if (param->validdefault) data_type = BL::NodeSocket::type_BOOLEAN;
default_int = param->idefault[0]; if (param->validdefault) {
default_boolean = (bool)param->idefault[0];
}
}
else {
socket_type = "NodeSocketInt";
data_type = BL::NodeSocket::type_INT;
if (param->validdefault)
default_int = param->idefault[0];
}
} }
else if (param->type.basetype == TypeDesc::FLOAT) { else if (param->type.basetype == TypeDesc::FLOAT) {
socket_type = "NodeSocketFloat"; socket_type = "NodeSocketFloat";
@@ -546,33 +574,57 @@ static PyObject *osl_update_node_func(PyObject * /*self*/, PyObject *args)
else else
continue; continue;
/* find socket socket */ /* Update existing socket. */
BL::NodeSocket b_sock(PointerRNA_NULL); bool found_existing = false;
if (param->isoutput) { if (param->isoutput) {
b_sock = b_node.outputs[param->name.string()]; for (BL::NodeSocket &b_sock : b_node.outputs) {
/* remove if type no longer matches */ if (b_sock.identifier() == param->name) {
if (b_sock && b_sock.bl_idname() != socket_type) { if (b_sock.bl_idname() != socket_type) {
b_node.outputs.remove(b_data, b_sock); /* Remove if type no longer matches. */
b_sock = BL::NodeSocket(PointerRNA_NULL); b_node.outputs.remove(b_data, b_sock);
}
else {
/* Reuse and update label. */
if (b_sock.name() != param_label) {
b_sock.name(param_label.string());
}
used_sockets.insert(b_sock.ptr.data);
found_existing = true;
}
break;
}
} }
} }
else { else {
b_sock = b_node.inputs[param->name.string()]; for (BL::NodeSocket &b_sock : b_node.inputs) {
/* remove if type no longer matches */ if (b_sock.identifier() == param->name) {
if (b_sock && b_sock.bl_idname() != socket_type) { if (b_sock.bl_idname() != socket_type) {
b_node.inputs.remove(b_data, b_sock); /* Remove if type no longer matches. */
b_sock = BL::NodeSocket(PointerRNA_NULL); b_node.inputs.remove(b_data, b_sock);
}
else {
/* Reuse and update label. */
if (b_sock.name() != param_label) {
b_sock.name(param_label.string());
}
used_sockets.insert(b_sock.ptr.data);
found_existing = true;
}
break;
}
} }
} }
if (!b_sock) { if (!found_existing) {
/* create new socket */ /* Create new socket. */
if (param->isoutput) BL::NodeSocket b_sock = (param->isoutput) ? b_node.outputs.create(b_data,
b_sock = b_node.outputs.create( socket_type.c_str(),
b_data, socket_type.c_str(), param->name.c_str(), param->name.c_str()); param_label.c_str(),
else param->name.c_str()) :
b_sock = b_node.inputs.create( b_node.inputs.create(b_data,
b_data, socket_type.c_str(), param->name.c_str(), param->name.c_str()); socket_type.c_str(),
param_label.c_str(),
param->name.c_str());
/* set default value */ /* set default value */
if (data_type == BL::NodeSocket::type_VALUE) { if (data_type == BL::NodeSocket::type_VALUE) {
@@ -590,9 +642,12 @@ static PyObject *osl_update_node_func(PyObject * /*self*/, PyObject *args)
else if (data_type == BL::NodeSocket::type_STRING) { else if (data_type == BL::NodeSocket::type_STRING) {
set_string(b_sock.ptr, "default_value", default_string); set_string(b_sock.ptr, "default_value", default_string);
} }
} else if (data_type == BL::NodeSocket::type_BOOLEAN) {
set_boolean(b_sock.ptr, "default_value", default_boolean);
}
used_sockets.insert(b_sock.ptr.data); used_sockets.insert(b_sock.ptr.data);
}
} }
/* remove unused parameters */ /* remove unused parameters */