blender::compositor::MathBaseOperation Class Reference

#include <COM_MathBaseOperation.h>

Inherits blender::compositor::MultiThreadedOperation.

Inherited by blender::compositor::MathFunctor2Operation< std::plus >, blender::compositor::MathFunctor2Operation< std::greater >, blender::compositor::MathFunctor2Operation< std::less >, blender::compositor::MathFunctor2Operation< std::multiplies >, blender::compositor::MathFunctor2Operation< std::minus >, blender::compositor::MathAbsoluteOperation, blender::compositor::MathArcCosineOperation, blender::compositor::MathArcSineOperation, blender::compositor::MathArcTan2Operation, blender::compositor::MathArcTangentOperation, blender::compositor::MathCeilOperation, blender::compositor::MathCompareOperation, blender::compositor::MathCosineOperation, blender::compositor::MathDegreesOperation, blender::compositor::MathDivideOperation, blender::compositor::MathExponentOperation, blender::compositor::MathFloorOperation, blender::compositor::MathFlooredModuloOperation, blender::compositor::MathFractOperation, blender::compositor::MathFunctor2Operation< TFunctor >, blender::compositor::MathHyperbolicCosineOperation, blender::compositor::MathHyperbolicSineOperation, blender::compositor::MathHyperbolicTangentOperation, blender::compositor::MathInverseSqrtOperation, blender::compositor::MathLogarithmOperation, blender::compositor::MathMaximumOperation, blender::compositor::MathMinimumOperation, blender::compositor::MathModuloOperation, blender::compositor::MathMultiplyAddOperation, blender::compositor::MathPingpongOperation, blender::compositor::MathPowerOperation, blender::compositor::MathRadiansOperation, blender::compositor::MathRoundOperation, blender::compositor::MathSignOperation, blender::compositor::MathSineOperation, blender::compositor::MathSmoothMaxOperation, blender::compositor::MathSmoothMinOperation, blender::compositor::MathSnapOperation, blender::compositor::MathSqrtOperation, blender::compositor::MathTangentOperation, blender::compositor::MathTruncOperation, and blender::compositor::MathWrapOperation.

Public Member Functions
void	determine_canvas (const rcti &preferred_area, rcti &r_area) override
void	set_use_clamp (bool value)
void	update_memory_buffer_partial (MemoryBuffer *output, const rcti &area, Span< MemoryBuffer * > inputs) final
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	init_execution ()
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)
virtual void	get_area_of_interest (int input_idx, const rcti &output_area, rcti &r_input_area)
	Get input operation area being read by this operation on rendering given output area.
void	get_area_of_interest (NodeOperation *input_op, const rcti &output_area, rcti &r_input_area)

Protected Member Functions
	MathBaseOperation ()
float	clamp_when_enabled (float value)
void	clamp_when_enabled (float *out)
virtual void	update_memory_buffer_partial (BuffersIterator< float > &it)=0
Protected Member Functions inherited from blender::compositor::MultiThreadedOperation
	MultiThreadedOperation ()
virtual void	update_memory_buffer_started (MemoryBuffer *, const rcti &, Span< MemoryBuffer * >)
virtual void	update_memory_buffer_finished (MemoryBuffer *, const rcti &, Span< MemoryBuffer * >)
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	use_clamp_
Protected Attributes inherited from blender::compositor::MultiThreadedOperation
int	num_passes_
int	current_pass_
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

this program converts an input color to an output value. it assumes we are in sRGB color space.

Definition at line 15 of file COM_MathBaseOperation.h.

Constructor & Destructor Documentation

MathBaseOperation()

blender::compositor::MathBaseOperation::MathBaseOperation ( )

protected

Definition at line 11 of file COM_MathBaseOperation.cc.

References blender::compositor::NodeOperation::add_input_socket(), blender::compositor::NodeOperation::add_output_socket(), blender::compositor::NodeOperationFlags::can_be_constant, blender::compositor::NodeOperation::flags_, use_clamp_, and blender::compositor::Value.

Member Function Documentation

clamp_when_enabled() [1/2]

void blender::compositor::MathBaseOperation::clamp_when_enabled ( float * out )

inlineprotected

Definition at line 30 of file COM_MathBaseOperation.h.

References CLAMP, and use_clamp_.

clamp_when_enabled() [2/2]

float blender::compositor::MathBaseOperation::clamp_when_enabled ( float value )

inlineprotected

Definition at line 22 of file COM_MathBaseOperation.h.

References use_clamp_.

Referenced by blender::compositor::MathAbsoluteOperation::update_memory_buffer_partial(), blender::compositor::MathArcCosineOperation::update_memory_buffer_partial(), blender::compositor::MathArcSineOperation::update_memory_buffer_partial(), blender::compositor::MathArcTan2Operation::update_memory_buffer_partial(), blender::compositor::MathArcTangentOperation::update_memory_buffer_partial(), blender::compositor::MathCeilOperation::update_memory_buffer_partial(), blender::compositor::MathCompareOperation::update_memory_buffer_partial(), blender::compositor::MathCosineOperation::update_memory_buffer_partial(), blender::compositor::MathDegreesOperation::update_memory_buffer_partial(), blender::compositor::MathDivideOperation::update_memory_buffer_partial(), blender::compositor::MathExponentOperation::update_memory_buffer_partial(), blender::compositor::MathFlooredModuloOperation::update_memory_buffer_partial(), blender::compositor::MathFloorOperation::update_memory_buffer_partial(), blender::compositor::MathFractOperation::update_memory_buffer_partial(), blender::compositor::MathHyperbolicCosineOperation::update_memory_buffer_partial(), blender::compositor::MathHyperbolicSineOperation::update_memory_buffer_partial(), blender::compositor::MathHyperbolicTangentOperation::update_memory_buffer_partial(), blender::compositor::MathInverseSqrtOperation::update_memory_buffer_partial(), blender::compositor::MathLogarithmOperation::update_memory_buffer_partial(), blender::compositor::MathMaximumOperation::update_memory_buffer_partial(), blender::compositor::MathMinimumOperation::update_memory_buffer_partial(), blender::compositor::MathModuloOperation::update_memory_buffer_partial(), blender::compositor::MathMultiplyAddOperation::update_memory_buffer_partial(), blender::compositor::MathPingpongOperation::update_memory_buffer_partial(), blender::compositor::MathPowerOperation::update_memory_buffer_partial(), blender::compositor::MathRadiansOperation::update_memory_buffer_partial(), blender::compositor::MathRoundOperation::update_memory_buffer_partial(), blender::compositor::MathSignOperation::update_memory_buffer_partial(), blender::compositor::MathSineOperation::update_memory_buffer_partial(), blender::compositor::MathSmoothMaxOperation::update_memory_buffer_partial(), blender::compositor::MathSmoothMinOperation::update_memory_buffer_partial(), blender::compositor::MathSnapOperation::update_memory_buffer_partial(), blender::compositor::MathSqrtOperation::update_memory_buffer_partial(), blender::compositor::MathTangentOperation::update_memory_buffer_partial(), blender::compositor::MathTruncOperation::update_memory_buffer_partial(), and blender::compositor::MathWrapOperation::update_memory_buffer_partial().

determine_canvas()

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

overridevirtual

Determine resolution

Reimplemented from blender::compositor::NodeOperation.

Definition at line 23 of file COM_MathBaseOperation.cc.

References blender::compositor::COM_AREA_NONE, blender::compositor::NodeOperation::determine_canvas(), blender::compositor::NodeOperationInput::determine_canvas(), blender::compositor::NodeOperation::get_input_socket(), and blender::compositor::NodeOperation::set_canvas_input_index().

set_use_clamp()

void blender::compositor::MathBaseOperation::set_use_clamp ( bool value )

inline

Definition at line 43 of file COM_MathBaseOperation.h.

References use_clamp_.

Referenced by blender::compositor::MathNode::convert_to_operations().

update_memory_buffer_partial() [1/2]

virtual void blender::compositor::MathBaseOperation::update_memory_buffer_partial ( BuffersIterator< float > & it )

protectedpure virtual

Implemented in blender::compositor::MathAbsoluteOperation, blender::compositor::MathArcCosineOperation, blender::compositor::MathArcSineOperation, blender::compositor::MathArcTan2Operation, blender::compositor::MathArcTangentOperation, blender::compositor::MathCeilOperation, blender::compositor::MathCompareOperation, blender::compositor::MathCosineOperation, blender::compositor::MathDegreesOperation, blender::compositor::MathDivideOperation, blender::compositor::MathExponentOperation, blender::compositor::MathFlooredModuloOperation, blender::compositor::MathFloorOperation, blender::compositor::MathFractOperation, blender::compositor::MathHyperbolicCosineOperation, blender::compositor::MathHyperbolicSineOperation, blender::compositor::MathHyperbolicTangentOperation, blender::compositor::MathInverseSqrtOperation, blender::compositor::MathLogarithmOperation, blender::compositor::MathMaximumOperation, blender::compositor::MathMinimumOperation, blender::compositor::MathModuloOperation, blender::compositor::MathMultiplyAddOperation, blender::compositor::MathPingpongOperation, blender::compositor::MathPowerOperation, blender::compositor::MathRadiansOperation, blender::compositor::MathRoundOperation, blender::compositor::MathSignOperation, blender::compositor::MathSineOperation, blender::compositor::MathSmoothMaxOperation, blender::compositor::MathSmoothMinOperation, blender::compositor::MathSnapOperation, blender::compositor::MathSqrtOperation, blender::compositor::MathTangentOperation, blender::compositor::MathTruncOperation, and blender::compositor::MathWrapOperation.

update_memory_buffer_partial() [2/2]

void blender::compositor::MathBaseOperation::update_memory_buffer_partial ( MemoryBuffer * output, const rcti & area, Span< MemoryBuffer * > inputs )

finalvirtual

Executes operation updating a memory buffer area. Multi-threaded calls.

Implements blender::compositor::MultiThreadedOperation.

Definition at line 38 of file COM_MathBaseOperation.cc.

References update_memory_buffer_partial().

Referenced by update_memory_buffer_partial().

Member Data Documentation

use_clamp_

bool blender::compositor::MathBaseOperation::use_clamp_

protected

Definition at line 17 of file COM_MathBaseOperation.h.

Referenced by clamp_when_enabled(), clamp_when_enabled(), MathBaseOperation(), and set_use_clamp().

---

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

• COM_MathBaseOperation.h
• COM_MathBaseOperation.cc