Upgrade nodes to include object. Add documnetation

This commit is contained in:
QuantumCoderQC 2021-06-14 13:32:00 +02:00
parent 39922bc0f3
commit 15da6ccf58
3 changed files with 54 additions and 32 deletions

View file

@ -1,36 +1,43 @@
from arm.logicnode.arm_nodes import *
class SetMaterialImageParamNode(ArmLogicTreeNode):
"""Set a image or texture value material parameter to the specified object. If `per object` is disabled, value will be set to all objects with this material"""
"""Set an image value material parameter to the specified object.
@seeNode Get Scene Root
@input Object: Object whose material parameter should change. Use `Get Scene Root` node to set paramter globally.
@input Per Object:
- `Enabled`: Set material parameter specific to this object. Global parameter will be ignored.
- `Disabled`: Set parameter globally, including this object.
@input Material: Material whose parameter to be set.
@input Node: Name of the parameter.
@input Image: Name of the image.
"""
bl_idname = 'LNSetMaterialImageParamNode'
bl_label = 'Set Material Image Param'
arm_section = 'params'
arm_version = 2
property0: BoolProperty(
name="Per Object",
description="Set property per object",
default=False
)
def init(self, context):
super(SetMaterialImageParamNode, self).init(context)
self.add_input('ArmNodeSocketAction', 'In')
self.add_input('ArmNodeSocketObject', 'Object')
self.add_input('NodeSocketBool', 'Per Object')
self.add_input('NodeSocketShader', 'Material')
self.add_input('NodeSocketString', 'Node')
self.add_input('NodeSocketString', 'Image')
self.add_output('ArmNodeSocketAction', 'Out')
def draw_buttons(self, context, layout):
layout.prop(self, 'property0')
def get_replacement_node(self, node_tree: bpy.types.NodeTree):
if self.arm_version not in (0, 1):
raise LookupError()
return NodeReplacement(
'LNSetMaterialImageParamNode', self.arm_version, 'LNSetMaterialImageParamNode', 2,
in_socket_mapping={0:0, 1:2, 2:3, 3:4}, out_socket_mapping={0:0}
in_socket_mapping={0:0, 1:3, 2:4, 3:5}, out_socket_mapping={0:0}
)

View file

@ -1,36 +1,43 @@
from arm.logicnode.arm_nodes import *
class SetMaterialRgbParamNode(ArmLogicTreeNode):
"""Set a color or vector value material parameter to the specified object. If `per object` is disabled, value will be set to all objects with this material"""
"""Set a color or vector value material parameter to the specified object.
@seeNode Get Scene Root
@input Object: Object whose material parameter should change. Use `Get Scene Root` node to set paramter globally.
@input Per Object:
- `Enabled`: Set material parameter specific to this object. Global parameter will be ignored.
- `Disabled`: Set parameter globally, including this object.
@input Material: Material whose parameter to be set.
@input Node: Name of the parameter.
@input Color: Color or vector input.
"""
bl_idname = 'LNSetMaterialRgbParamNode'
bl_label = 'Set Material RGB Param'
arm_section = 'params'
arm_version = 2
property0: BoolProperty(
name="Per Object",
description="Set property per object",
default=False
)
def init(self, context):
super(SetMaterialRgbParamNode, self).init(context)
self.add_input('ArmNodeSocketAction', 'In')
self.add_input('ArmNodeSocketObject', 'Object')
self.add_input('NodeSocketBool', 'Per Object')
self.add_input('NodeSocketShader', 'Material')
self.add_input('NodeSocketString', 'Node')
self.add_input('NodeSocketColor', 'Color')
self.add_output('ArmNodeSocketAction', 'Out')
def draw_buttons(self, context, layout):
layout.prop(self, 'property0')
def get_replacement_node(self, node_tree: bpy.types.NodeTree):
if self.arm_version not in (0, 1):
raise LookupError()
return NodeReplacement(
'LNSetMaterialRgbParamNode', self.arm_version, 'LNSetMaterialRgbParamNode', 2,
in_socket_mapping={0:0, 1:2, 2:3, 3:4}, out_socket_mapping={0:0}
in_socket_mapping={0:0, 1:3, 2:4, 3:5}, out_socket_mapping={0:0}
)

View file

@ -1,30 +1,38 @@
from arm.logicnode.arm_nodes import *
class SetMaterialValueParamNode(ArmLogicTreeNode):
"""Set a float value material parameter to the specified object. If `per object` is disabled, value will be set to all objects with this material"""
"""Set a float value material parameter to the specified object.
@seeNode Get Scene Root
@input Object: Object whose material parameter should change. Use `Get Scene Root` node to set paramter globally.
@input Per Object:
- `Enabled`: Set material parameter specific to this object. Global parameter will be ignored.
- `Disabled`: Set parameter globally, including this object.
@input Material: Material whose parameter to be set.
@input Node: Name of the parameter.
@input Float: float value.
"""
bl_idname = 'LNSetMaterialValueParamNode'
bl_label = 'Set Material Value Param'
arm_section = 'params'
arm_version = 2
property0: BoolProperty(
name="Per Object",
description="Set property per object",
default=False
)
def init(self, context):
super(SetMaterialValueParamNode, self).init(context)
self.add_input('ArmNodeSocketAction', 'In')
self.add_input('ArmNodeSocketObject', 'Object')
self.add_input('NodeSocketBool', 'Per Object')
self.add_input('NodeSocketShader', 'Material')
self.add_input('NodeSocketString', 'Node')
self.add_input('NodeSocketFloat', 'Float')
self.add_output('ArmNodeSocketAction', 'Out')
def draw_buttons(self, context, layout):
layout.prop(self, 'property0')
def get_replacement_node(self, node_tree: bpy.types.NodeTree):
if self.arm_version not in (0, 1):
@ -32,5 +40,5 @@ class SetMaterialValueParamNode(ArmLogicTreeNode):
return NodeReplacement(
'LNSetMaterialValueParamNode', self.arm_version, 'LNSetMaterialValueParamNode', 2,
in_socket_mapping={0:0, 1:2, 2:3, 3:4}, out_socket_mapping={0:0}
in_socket_mapping={0:0, 1:3, 2:4, 3:5}, out_socket_mapping={0:0}
)