#include <COM_KeyingNode.h>

Inherits blender::compositor::Node.

Public Member Functions
	KeyingNode (bNode *editor_node)

void	convert_to_operations (NodeConverter &converter, const CompositorContext &context) const override
	convert node to operation

Public Member Functions inherited from blender::compositor::Node
	Node (bNode *editor_node, bool create_sockets=true)

virtual	~Node ()

const bNode *	get_bnode () const
	get the reference to the SDNA bNode struct

bNodeTree *	get_bnodetree () const
	get the reference to the SDNA bNodeTree struct

void	set_bnode (bNode *node)
	set the reference to the bNode

void	set_bnodetree (bNodeTree *nodetree)
	set the reference to the bNodeTree

Span< NodeInput * >	get_input_sockets () const
	get access to the vector of input sockets

Span< NodeOutput * >	get_output_sockets () const
	get access to the vector of input sockets

NodeOutput *	get_output_socket (unsigned int index=0) const

NodeInput *	get_input_socket (unsigned int index) const

void	set_is_in_active_group (bool value)
	Is this node in the active group (the group that is being edited)

bool	is_in_active_group () const
	Is this node part of the active group the active group is the group that is currently being edited. When no group is edited, the active group will be the main tree (all nodes that are not part of a group will be active)

void	set_instance_key (bNodeInstanceKey instance_key)

bNodeInstanceKey	get_instance_key () const

Protected Member Functions
NodeOperationOutput *	setup_pre_blur (NodeConverter &converter, NodeInput *input_image, int size) const

NodeOperationOutput *	setup_post_blur (NodeConverter &converter, NodeOperationOutput *post_blur_input, int size) const

NodeOperationOutput *	setup_dilate_erode (NodeConverter &converter, NodeOperationOutput *dilate_erode_input, int distance) const

NodeOperationOutput *	setup_feather (NodeConverter &converter, const CompositorContext &context, NodeOperationOutput *feather_input, int falloff, int distance) const

NodeOperationOutput *	setup_despill (NodeConverter &converter, NodeOperationOutput despill_input, NodeInput input_screen, float factor, float color_balance) const

NodeOperationOutput *	setup_clip (NodeConverter &converter, NodeOperationOutput *clip_input, int kernel_radius, float kernel_tolerance, float clip_black, float clip_white, bool edge_matte) const

Protected Member Functions inherited from blender::compositor::Node
void	add_input_socket (DataType datatype)
	add an NodeInput to the collection of input-sockets

void	add_input_socket (DataType datatype, bNodeSocket *socket)

void	add_output_socket (DataType datatype)
	add an NodeOutput to the collection of output-sockets

void	add_output_socket (DataType datatype, bNodeSocket *socket)

bNodeSocket *	get_editor_input_socket (int editor_node_input_socket_index)

bNodeSocket *	get_editor_output_socket (int editor_node_output_socket_index)

Additional Inherited Members
Protected Attributes inherited from blender::compositor::Node
Vector< NodeInput * >	inputs_
	the list of actual input-sockets

Vector< NodeOutput * >	outputs_
	the list of actual output-sockets

Detailed Description

KeyingNode.

Definition at line 15 of file COM_KeyingNode.h.

Constructor & Destructor Documentation

◆ KeyingNode()

blender::compositor::KeyingNode::KeyingNode ( bNode * editor_node )

Definition at line 27 of file COM_KeyingNode.cc.

Member Function Documentation

◆ convert_to_operations()

void blender::compositor::KeyingNode::convert_to_operations	(	NodeConverter &	converter,
		const CompositorContext &	context ) const

overridevirtual

convert node to operation

Todo: this must be described further

Parameters

system	the ExecutionSystem where the operations need to be added
context	reference to the CompositorContext

Implements blender::compositor::Node.

Definition at line 202 of file COM_KeyingNode.cc.

◆ setup_clip()

NodeOperationOutput * blender::compositor::KeyingNode::setup_clip	(	NodeConverter &	converter,
		NodeOperationOutput *	clip_input,
		int	kernel_radius,
		float	kernel_tolerance,
		float	clip_black,
		float	clip_white,
		bool	edge_matte ) const

protected

Definition at line 181 of file COM_KeyingNode.cc.

References blender::compositor::NodeConverter::add_link(), blender::compositor::NodeConverter::add_operation(), blender::compositor::NodeOperation::get_input_socket(), blender::compositor::NodeOperation::get_output_socket(), blender::compositor::KeyingClipOperation::set_clip_black(), blender::compositor::KeyingClipOperation::set_clip_white(), blender::compositor::KeyingClipOperation::set_is_edge_matte(), blender::compositor::KeyingClipOperation::set_kernel_radius(), and blender::compositor::KeyingClipOperation::set_kernel_tolerance().

Referenced by convert_to_operations().

◆ setup_despill()

NodeOperationOutput * blender::compositor::KeyingNode::setup_despill	(	NodeConverter &	converter,
		NodeOperationOutput *	despill_input,
		NodeInput *	input_screen,
		float	factor,
		float	color_balance ) const

protected

Definition at line 164 of file COM_KeyingNode.cc.

References blender::compositor::NodeConverter::add_link(), blender::compositor::NodeConverter::add_operation(), blender::compositor::NodeOperation::get_input_socket(), blender::compositor::NodeOperation::get_output_socket(), blender::compositor::NodeConverter::map_input_socket(), blender::compositor::KeyingDespillOperation::set_color_balance(), and blender::compositor::KeyingDespillOperation::set_despill_factor().

Referenced by convert_to_operations().

◆ setup_dilate_erode()

NodeOperationOutput * blender::compositor::KeyingNode::setup_dilate_erode	(	NodeConverter &	converter,
		NodeOperationOutput *	dilate_erode_input,
		int	distance ) const

protected

Definition at line 107 of file COM_KeyingNode.cc.

References blender::compositor::NodeConverter::add_link(), blender::compositor::NodeConverter::add_operation(), blender::compositor::NodeOperation::get_input_socket(), blender::compositor::NodeOperation::get_output_socket(), and blender::compositor::DilateDistanceOperation::set_distance().

Referenced by convert_to_operations().

◆ setup_feather()

NodeOperationOutput * blender::compositor::KeyingNode::setup_feather	(	NodeConverter &	converter,
		const CompositorContext &	context,
		NodeOperationOutput *	feather_input,
		int	falloff,
		int	distance ) const

protected

Definition at line 127 of file COM_KeyingNode.cc.

Referenced by convert_to_operations().

◆ setup_post_blur()

NodeOperationOutput * blender::compositor::KeyingNode::setup_post_blur	(	NodeConverter &	converter,
		NodeOperationOutput *	post_blur_input,
		int	size ) const

protected

Definition at line 87 of file COM_KeyingNode.cc.

References blender::compositor::NodeConverter::add_link(), blender::compositor::NodeConverter::add_operation(), blender::compositor::KeyingBlurOperation::BLUR_AXIS_X, blender::compositor::KeyingBlurOperation::BLUR_AXIS_Y, blender::compositor::NodeOperation::get_input_socket(), blender::compositor::NodeOperation::get_output_socket(), blender::compositor::KeyingBlurOperation::set_axis(), and blender::compositor::KeyingBlurOperation::set_size().

Referenced by convert_to_operations().

◆ setup_pre_blur()

NodeOperationOutput * blender::compositor::KeyingNode::setup_pre_blur	(	NodeConverter &	converter,
		NodeInput *	input_image,
		int	size ) const

protected

Definition at line 32 of file COM_KeyingNode.cc.

Referenced by convert_to_operations().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KeyingNode()

Member Function Documentation

◆ convert_to_operations()

◆ setup_clip()

◆ setup_despill()

◆ setup_dilate_erode()

◆ setup_feather()

◆ setup_post_blur()

◆ setup_pre_blur()