#include <COM_ScaleOperation.h>

Inherits blender::compositor::BaseScaleOperation.

Inherited by blender::compositor::ScaleAbsoluteOperation, and blender::compositor::ScaleRelativeOperation.

Public Member Functions
	ScaleOperation ()

	ScaleOperation (DataType data_type)

void	init_data () override

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	update_memory_buffer_partial (MemoryBuffer output, const rcti &area, Span< MemoryBuffer > inputs) override

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

Public Member Functions inherited from blender::compositor::BaseScaleOperation
void	set_sampler (PixelSampler sampler)

void	set_variable_size (bool variable_size)

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_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)

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

Static Public Member Functions
static float	scale_coord (const float coord, const float center, const float relative_scale)

static float	scale_coord_inverted (const float coord, const float center, const float relative_scale)

static void	get_scale_offset (const rcti &input_canvas, const rcti &scale_canvas, float &r_scale_offset_x, float &r_scale_offset_y)

static void	scale_area (rcti &area, float relative_scale_x, float relative_scale_y)

static void	get_scale_area_of_interest (const rcti &input_canvas, const rcti &scale_canvas, float relative_scale_x, float relative_scale_y, const rcti &output_area, rcti &r_input_area)

static void	clamp_area_size_max (rcti &area, Size2f max_size)

Static Public Attributes
static constexpr float	MIN_RELATIVE_SCALE = 0.0001f

Protected Member Functions
virtual float	get_relative_scale_x_factor (float width)=0

virtual float	get_relative_scale_y_factor (float height)=0

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

PixelSampler	get_effective_sampler (PixelSampler sampler)

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
float	canvas_center_x_

float	canvas_center_y_

Protected Attributes inherited from blender::compositor::BaseScaleOperation
int	sampler_

bool	variable_size_

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_

Static Protected Attributes
static constexpr int	IMAGE_INPUT_INDEX = 0

static constexpr int	X_INPUT_INDEX = 1

static constexpr int	Y_INPUT_INDEX = 2

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

Detailed Description

Definition at line 35 of file COM_ScaleOperation.h.

Constructor & Destructor Documentation

◆ ScaleOperation() [1/2]

blender::compositor::ScaleOperation::ScaleOperation ( )

Definition at line 27 of file COM_ScaleOperation.cc.

◆ ScaleOperation() [2/2]

blender::compositor::ScaleOperation::ScaleOperation ( DataType data_type )

Definition at line 29 of file COM_ScaleOperation.cc.

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

Member Function Documentation

◆ clamp_area_size_max()

void blender::compositor::ScaleOperation::clamp_area_size_max	(	rcti &	area,
		Size2f	max_size )

static

Definition at line 80 of file COM_ScaleOperation.cc.

References BLI_rcti_size_x(), and BLI_rcti_size_y().

◆ determine_canvas()

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

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 182 of file COM_ScaleOperation.cc.

References BLI_rcti_size_x(), BLI_rcti_size_y(), blender::compositor::COM_AREA_NONE, blender::compositor::NodeOperationInput::determine_canvas(), blender::compositor::NodeOperation::get_input_operation(), blender::compositor::NodeOperation::get_input_socket(), IMAGE_INPUT_INDEX, scale_area(), blender::compositor::NodeOperation::unset_canvas(), X_INPUT_INDEX, and Y_INPUT_INDEX.

◆ get_area_of_interest()

void blender::compositor::ScaleOperation::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 128 of file COM_ScaleOperation.cc.

References blender::compositor::expand_area_for_sampler(), blender::compositor::NodeOperation::get_canvas(), blender::compositor::NodeOperation::get_height(), blender::compositor::NodeOperation::get_input_operation(), get_scale_area_of_interest(), blender::compositor::NodeOperation::get_width(), IMAGE_INPUT_INDEX, and blender::compositor::BaseScaleOperation::sampler_.

◆ get_relative_scale_x_factor()

virtual float blender::compositor::ScaleOperation::get_relative_scale_x_factor ( float width )

protectedpure virtual

Implemented in blender::compositor::ScaleAbsoluteOperation, and blender::compositor::ScaleRelativeOperation.

Referenced by update_memory_buffer_partial().

◆ get_relative_scale_y_factor()

virtual float blender::compositor::ScaleOperation::get_relative_scale_y_factor ( float height )

protectedpure virtual

Implemented in blender::compositor::ScaleAbsoluteOperation, and blender::compositor::ScaleRelativeOperation.

Referenced by update_memory_buffer_partial().

◆ get_scale_area_of_interest()

void blender::compositor::ScaleOperation::get_scale_area_of_interest	(	const rcti &	input_canvas,
		const rcti &	scale_canvas,
		float	relative_scale_x,
		float	relative_scale_y,
		const rcti &	output_area,
		rcti &	r_input_area )

static

Definition at line 106 of file COM_ScaleOperation.cc.

References BLI_rcti_size_x(), BLI_rcti_size_y(), ceilf, floorf, get_scale_offset(), scale_coord_inverted(), rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by get_area_of_interest(), and blender::compositor::TransformOperation::get_area_of_interest().

◆ get_scale_offset()

void blender::compositor::ScaleOperation::get_scale_offset	(	const rcti &	input_canvas,
		const rcti &	scale_canvas,
		float &	r_scale_offset_x,
		float &	r_scale_offset_y )

static

Definition at line 97 of file COM_ScaleOperation.cc.

References BLI_rcti_size_x(), and BLI_rcti_size_y().

Referenced by get_scale_area_of_interest(), scale_area(), and update_memory_buffer_partial().

◆ init_data()

void blender::compositor::ScaleOperation::init_data ( )

overridevirtual

Initializes operation data needed after operations are linked and resolutions determined. For rendering heap memory data use init_execution().

Reimplemented from blender::compositor::NodeOperation.

Definition at line 91 of file COM_ScaleOperation.cc.

References blender::compositor::NodeOperation::canvas_, canvas_center_x_, canvas_center_y_, blender::compositor::NodeOperation::get_height(), blender::compositor::NodeOperation::get_width(), rcti::xmin, and rcti::ymin.

◆ scale_area()

void blender::compositor::ScaleOperation::scale_area	(	rcti &	area,
		float	relative_scale_x,
		float	relative_scale_y )

static

Definition at line 65 of file COM_ScaleOperation.cc.

References BLI_rcti_size_x(), BLI_rcti_size_y(), BLI_rcti_translate(), ceilf, floorf, get_scale_offset(), scale_coord(), and rcti::xmin.

Referenced by blender::compositor::COM_convert_canvas(), determine_canvas(), and blender::compositor::TransformOperation::determine_canvas().

◆ scale_coord()

static float blender::compositor::ScaleOperation::scale_coord	(	const float	coord,
		const float	center,
		const float	relative_scale )

inlinestatic

Definition at line 51 of file COM_ScaleOperation.h.

References MIN_RELATIVE_SCALE.

Referenced by scale_area().

◆ scale_coord_inverted()

static float blender::compositor::ScaleOperation::scale_coord_inverted	(	const float	coord,
		const float	center,
		const float	relative_scale )

inlinestatic

Definition at line 56 of file COM_ScaleOperation.h.

References MIN_RELATIVE_SCALE.

Referenced by get_scale_area_of_interest(), and update_memory_buffer_partial().

◆ update_memory_buffer_partial()

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

overridevirtual

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

Implements blender::compositor::MultiThreadedOperation.

Definition at line 146 of file COM_ScaleOperation.cc.

Member Data Documentation

◆ canvas_center_x_

float blender::compositor::ScaleOperation::canvas_center_x_

protected

Definition at line 44 of file COM_ScaleOperation.h.

Referenced by init_data().

◆ canvas_center_y_

float blender::compositor::ScaleOperation::canvas_center_y_

protected

Definition at line 45 of file COM_ScaleOperation.h.

Referenced by init_data().

◆ IMAGE_INPUT_INDEX

int blender::compositor::ScaleOperation::IMAGE_INPUT_INDEX = 0

staticconstexprprotected

Definition at line 40 of file COM_ScaleOperation.h.

Referenced by determine_canvas(), get_area_of_interest(), and update_memory_buffer_partial().

◆ MIN_RELATIVE_SCALE

float blender::compositor::ScaleOperation::MIN_RELATIVE_SCALE = 0.0001f

staticconstexpr

Definition at line 37 of file COM_ScaleOperation.h.

Referenced by scale_coord(), and scale_coord_inverted().

◆ X_INPUT_INDEX

int blender::compositor::ScaleOperation::X_INPUT_INDEX = 1

staticconstexprprotected

Definition at line 41 of file COM_ScaleOperation.h.

Referenced by determine_canvas(), and update_memory_buffer_partial().

◆ Y_INPUT_INDEX

int blender::compositor::ScaleOperation::Y_INPUT_INDEX = 2

staticconstexprprotected

Definition at line 42 of file COM_ScaleOperation.h.

Referenced by determine_canvas(), and update_memory_buffer_partial().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScaleOperation() [1/2]

◆ ScaleOperation() [2/2]

Member Function Documentation

◆ clamp_area_size_max()

◆ determine_canvas()

◆ get_area_of_interest()

◆ get_relative_scale_x_factor()

◆ get_relative_scale_y_factor()

◆ get_scale_area_of_interest()

◆ get_scale_offset()

◆ init_data()

◆ scale_area()

◆ scale_coord()

◆ scale_coord_inverted()

◆ update_memory_buffer_partial()

Member Data Documentation

◆ canvas_center_x_

◆ canvas_center_y_

◆ IMAGE_INPUT_INDEX

◆ MIN_RELATIVE_SCALE

◆ X_INPUT_INDEX

◆ Y_INPUT_INDEX