base class of CalculateMean, implementing the simple CalculateMean More...

#include <COM_CalculateMeanOperation.h>

Inherits blender::compositor::ConstantOperation.

Inherited by blender::compositor::CalculateStandardDeviationOperation.

Classes
struct	PixelsSum

Public Member Functions
	CalculateMeanOperation ()

void	init_execution () override

void	set_setting (int setting)

void	get_area_of_interest (int input_idx, const rcti &output_area, rcti &r_input_area) override
	Get input operation area being read by this operation on rendering given output area.

void	determine_canvas (const rcti &preferred_area, rcti &r_area) override

const float *	get_constant_elem () override

void	update_memory_buffer (MemoryBuffer output, const rcti &area, Span< MemoryBuffer > inputs) override

Public Member Functions inherited from blender::compositor::ConstantOperation
	ConstantOperation ()

bool	can_get_constant_elem () const

void	update_memory_buffer (MemoryBuffer output, const rcti &area, Span< MemoryBuffer > inputs) override

Public Member Functions inherited from blender::compositor::NodeOperation
virtual	~NodeOperation ()

void	set_name (const std::string name)

const std::string	get_name () const

void	set_id (const int id)

const int	get_id () const

const void	set_node_instance_key (const bNodeInstanceKey &node_instance_key)

const bNodeInstanceKey	get_node_instance_key () const

float	get_constant_value_default (float default_value)

const float *	get_constant_elem_default (const float *default_elem)

const NodeOperationFlags	get_flags () const

std::optional< NodeOperationHash >	generate_hash ()

unsigned int	get_number_of_input_sockets () const

unsigned int	get_number_of_output_sockets () const

NodeOperationOutput *	get_output_socket (unsigned int index=0)

NodeOperationInput *	get_input_socket (unsigned int index)

NodeOperation *	get_input_operation (int index)

virtual bool	is_output_operation (bool) const
	is_output_operation determines whether this operation is an output of the ExecutionSystem during rendering or editing.

void	set_bnodetree (const bNodeTree *tree)

void	set_execution_system (ExecutionSystem *system)

virtual void	init_data ()

virtual void	deinit_execution ()

void	set_canvas (const rcti &canvas_area)

const rcti &	get_canvas () const

void	unset_canvas ()

virtual bool	is_active_viewer_output () const
	is this operation the active viewer output user can select an ViewerNode to be active (the result of this node will be drawn on the backdrop).

void	set_canvas_input_index (unsigned int index)
	set the index of the input socket that will determine the canvas of this operation

void	set_determined_canvas_modifier (std::function< void(rcti &canvas)> fn)

virtual eCompositorPriority	get_render_priority () const
	get the render priority of this node.

bool	is_braked () const

void	update_draw ()

unsigned int	get_width () const

unsigned int	get_height () const

virtual MemoryBuffer *	get_input_memory_buffer (MemoryBuffer **)

virtual std::unique_ptr< MetaData >	get_meta_data ()

void	render (MemoryBuffer output_buf, Span< rcti > areas, Span< MemoryBuffer > inputs_bufs)

void	get_area_of_interest (NodeOperation *input_op, const rcti &output_area, rcti &r_input_area)

Protected Member Functions
virtual float	calculate_value (const MemoryBuffer *input) const

float	calculate_mean (const MemoryBuffer *input) const

Protected Member Functions inherited from blender::compositor::NodeOperation
	NodeOperation ()

virtual void	hash_output_params ()

template<typename T >
void	hash_param (T param)

template<typename T1 , typename T2 >
void	hash_params (T1 param1, T2 param2)

template<typename T1 , typename T2 , typename T3 >
void	hash_params (T1 param1, T2 param2, T3 param3)

void	add_input_socket (DataType datatype, ResizeMode resize_mode=ResizeMode::Center)

void	add_output_socket (DataType datatype)

SocketReader *	get_input_socket_reader (unsigned int index)

Protected Attributes
bool	is_calculated_

float	constant_value_

int	setting_

std::function< float(const float *elem)>	setting_func_

Protected Attributes inherited from blender::compositor::ConstantOperation
bool	needs_canvas_to_get_constant_

Protected Attributes inherited from blender::compositor::NodeOperation
rcti	canvas_ = COM_AREA_NONE

NodeOperationFlags	flags_

ExecutionSystem *	exec_system_

Additional Inherited Members
Static Protected Member Functions inherited from blender::compositor::NodeOperation
static void	combine_hashes (size_t &combined, size_t other)

Detailed Description

base class of CalculateMean, implementing the simple CalculateMean

Definition at line 17 of file COM_CalculateMeanOperation.h.

Constructor & Destructor Documentation

◆ CalculateMeanOperation()

blender::compositor::CalculateMeanOperation::CalculateMeanOperation ( )

Definition at line 13 of file COM_CalculateMeanOperation.cc.

References blender::compositor::NodeOperation::add_input_socket(), blender::compositor::NodeOperation::add_output_socket(), blender::compositor::Align, blender::compositor::Color, blender::compositor::NodeOperation::flags_, is_calculated_, blender::compositor::NodeOperationFlags::is_constant_operation, blender::compositor::ConstantOperation::needs_canvas_to_get_constant_, setting_, and blender::compositor::Value.

Member Function Documentation

◆ calculate_mean()

float blender::compositor::CalculateMeanOperation::calculate_mean ( const MemoryBuffer * input ) const

protected

Definition at line 104 of file COM_CalculateMeanOperation.cc.

References blender::compositor::NodeOperation::exec_system_, blender::compositor::ExecutionSystem::execute_work(), blender::compositor::CalculateMeanOperation::PixelsSum::num_pixels, and split().

Referenced by calculate_value(), and blender::compositor::CalculateStandardDeviationOperation::calculate_value().

◆ calculate_value()

float blender::compositor::CalculateMeanOperation::calculate_value ( const MemoryBuffer * input ) const

protectedvirtual

Reimplemented in blender::compositor::CalculateStandardDeviationOperation.

Definition at line 99 of file COM_CalculateMeanOperation.cc.

References calculate_mean().

Referenced by update_memory_buffer().

◆ determine_canvas()

void blender::compositor::CalculateMeanOperation::determine_canvas	(	const rcti &	preferred_area,
		rcti &	r_area )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 70 of file COM_CalculateMeanOperation.cc.

References blender::compositor::NodeOperation::determine_canvas().

◆ get_area_of_interest()

void blender::compositor::CalculateMeanOperation::get_area_of_interest	(	int	input_idx,
		const rcti &	output_area,
		rcti &	r_input_area )

overridevirtual

Get input operation area being read by this operation on rendering given output area.

Implementation don't need to ensure r_input_area is within input operation bounds. The caller must clamp it. TODO: See if it's possible to use parameter overloading (input_id for example).

Parameters

input_idx	Input operation index for which we want to calculate the area being read.
output_area	Area being rendered by this operation.
r_input_area	Returned input operation area that needs to be read in order to render given output area.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 62 of file COM_CalculateMeanOperation.cc.

References BLI_assert, blender::compositor::NodeOperation::get_canvas(), and blender::compositor::NodeOperation::get_input_operation().