Blender V4.3
blender::compositor::TranslateOperation Class Reference

#include <COM_TranslateOperation.h>

Inherits blender::compositor::MultiThreadedOperation.

Inherited by blender::compositor::TranslateCanvasOperation.

Public Member Functions

 TranslateOperation ()
 
 TranslateOperation (DataType data_type, ResizeMode mode=ResizeMode::Center)
 
float get_delta_x ()
 
float get_delta_y ()
 
void set_is_relative (const bool is_relative)
 
bool get_is_relative ()
 
PixelSampler get_sampler ()
 
void set_sampler (PixelSampler sampler)
 
void ensure_delta ()
 
void set_wrapping (int wrapping_type)
 
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_started (MemoryBuffer *output, const rcti &area, Span< MemoryBuffer * > inputs) override
 
void update_memory_buffer_partial (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 floatget_constant_elem_default (const float *default_elem)
 
const NodeOperationFlags get_flags () const
 
std::optional< NodeOperationHashgenerate_hash ()
 
unsigned int get_number_of_input_sockets () const
 
unsigned int get_number_of_output_sockets () const
 
NodeOperationOutputget_output_socket (unsigned int index=0)
 
NodeOperationInputget_input_socket (unsigned int index)
 
NodeOperationget_input_operation (int index)
 
virtual void determine_canvas (const rcti &preferred_area, rcti &r_area)
 
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 rctiget_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 MemoryBufferget_input_memory_buffer (MemoryBuffer **)
 
virtual std::unique_ptr< MetaDataget_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 Attributes

MemoryBufferExtend x_extend_mode_
 
MemoryBufferExtend y_extend_mode_
 
- 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_
 
ExecutionSystemexec_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

- Protected Member Functions inherited from blender::compositor::MultiThreadedOperation
 MultiThreadedOperation ()
 
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)
 
SocketReaderget_input_socket_reader (unsigned int index)
 
- Static Protected Member Functions inherited from blender::compositor::NodeOperation
static void combine_hashes (size_t &combined, size_t other)
 

Detailed Description

Definition at line 15 of file COM_TranslateOperation.h.

Constructor & Destructor Documentation

◆ TranslateOperation() [1/2]

blender::compositor::TranslateOperation::TranslateOperation ( )

Definition at line 9 of file COM_TranslateOperation.cc.

◆ TranslateOperation() [2/2]

Member Function Documentation

◆ ensure_delta()

◆ get_area_of_interest()

void blender::compositor::TranslateOperation::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_idxInput operation index for which we want to calculate the area being read.
output_areaArea being rendered by this operation.
r_input_areaReturned input operation area that needs to be read in order to render given output area.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 51 of file COM_TranslateOperation.cc.

References BLI_rcti_resize_x(), BLI_rcti_resize_y(), BLI_rcti_translate(), blender::compositor::Clip, ensure_delta(), get_delta_x(), get_delta_y(), blender::compositor::NodeOperation::get_height(), blender::compositor::NodeOperation::get_width(), blender::compositor::Repeat, x_extend_mode_, and y_extend_mode_.

◆ get_delta_x()

float blender::compositor::TranslateOperation::get_delta_x ( )
inline

◆ get_delta_y()

float blender::compositor::TranslateOperation::get_delta_y ( )
inline

◆ get_is_relative()

bool blender::compositor::TranslateOperation::get_is_relative ( )
inline

Definition at line 53 of file COM_TranslateOperation.h.

Referenced by ensure_delta().

◆ get_sampler()

PixelSampler blender::compositor::TranslateOperation::get_sampler ( )
inline

Definition at line 58 of file COM_TranslateOperation.h.

◆ set_is_relative()

void blender::compositor::TranslateOperation::set_is_relative ( const bool is_relative)
inline

◆ set_sampler()

◆ set_wrapping()

void blender::compositor::TranslateOperation::set_wrapping ( int wrapping_type)

◆ update_memory_buffer_partial()

void blender::compositor::TranslateOperation::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 85 of file COM_TranslateOperation.cc.

References BLI_rcti_is_empty(), copy_v4_v4(), get_delta_x(), get_delta_y(), blender::compositor::Nearest, x_extend_mode_, and y_extend_mode_.

◆ update_memory_buffer_started()

void blender::compositor::TranslateOperation::update_memory_buffer_started ( MemoryBuffer * ,
const rcti & ,
Span< MemoryBuffer * >  )
overridevirtual

Called before an update memory buffer pass is executed. Single-threaded calls.

Reimplemented from blender::compositor::MultiThreadedOperation.

Definition at line 44 of file COM_TranslateOperation.cc.

References ensure_delta().

Member Data Documentation

◆ IMAGE_INPUT_INDEX

int blender::compositor::TranslateOperation::IMAGE_INPUT_INDEX = 0
staticconstexprprotected

◆ x_extend_mode_

◆ X_INPUT_INDEX

int blender::compositor::TranslateOperation::X_INPUT_INDEX = 1
staticconstexprprotected

◆ y_extend_mode_

◆ Y_INPUT_INDEX

int blender::compositor::TranslateOperation::Y_INPUT_INDEX = 2
staticconstexprprotected

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