Blender  V3.3
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
blender::compositor::TranslateOperation Class Reference

#include <COM_TranslateOperation.h>

Inheritance diagram for blender::compositor::TranslateOperation:
blender::compositor::MultiThreadedOperation blender::compositor::NodeOperation blender::compositor::TranslateCanvasOperation

Public Member Functions

 TranslateOperation ()
 
 TranslateOperation (DataType data_type, ResizeMode mode=ResizeMode::Center)
 
bool determine_depending_area_of_interest (rcti *input, ReadBufferOperation *read_operation, rcti *output) override
 
void execute_pixel_sampled (float output[4], float x, float y, PixelSampler sampler) override
 calculate a single pixel More...
 
void init_execution () override
 
void deinit_execution () override
 
float getDeltaX ()
 
float getDeltaY ()
 
void ensure_delta ()
 
void setFactorXY (float factorX, float factorY)
 
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. More...
 
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
 
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. More...
 
void set_execution_model (const eExecutionModel model)
 
void set_bnodetree (const bNodeTree *tree)
 
void set_execution_system (ExecutionSystem *system)
 
virtual void init_data ()
 
virtual void execute_region (rcti *, unsigned int)
 when a chunk is executed by a CPUDevice, this method is called More...
 
virtual void execute_opencl_region (OpenCLDevice *, rcti *, unsigned int, MemoryBuffer **, MemoryBuffer *)
 when a chunk is executed by an OpenCLDevice, this method is called More...
 
virtual void execute_opencl (OpenCLDevice *, MemoryBuffer *, cl_mem, MemoryBuffer **, std::list< cl_mem > *, std::list< cl_kernel > *)
 custom handle to add new tasks to the OpenCL command queue in order to execute a chunk on an GPUDevice. More...
 
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). More...
 
void set_canvas_input_index (unsigned int index)
 set the index of the input socket that will determine the canvas of this operation More...
 
void set_determined_canvas_modifier (std::function< void(rcti &canvas)> fn)
 
virtual eCompositorPriority get_render_priority () const
 get the render priority of this node. More...
 
bool is_braked () const
 
void update_draw ()
 
unsigned int get_width () const
 
unsigned int get_height () const
 
void read_sampled (float result[4], float x, float y, PixelSampler sampler)
 
void read_filtered (float result[4], float x, float y, float dx[2], float dy[2])
 
void read (float result[4], int x, int y, void *chunk_data)
 
virtual voidinitialize_tile_data (rcti *)
 
virtual void deinitialize_tile_data (rcti *, void *)
 
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)
 
virtual void update_memory_buffer (MemoryBuffer *UNUSED(output), const rcti &UNUSED(area), Span< MemoryBuffer * > UNUSED(inputs))
 
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
eExecutionModel execution_model_
 
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_started (MemoryBuffer *UNUSED(output), const rcti &UNUSED(area), Span< MemoryBuffer * > UNUSED(inputs))
 
virtual void update_memory_buffer_finished (MemoryBuffer *UNUSED(output), const rcti &UNUSED(area), Span< MemoryBuffer * > UNUSED(inputs))
 
- 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)
 
void set_width (unsigned int width)
 
void set_height (unsigned int height)
 
SocketReaderget_input_socket_reader (unsigned int index)
 
void deinit_mutex ()
 
void init_mutex ()
 
void lock_mutex ()
 
void unlock_mutex ()
 
void set_complex (bool complex)
 set whether this operation is complex More...
 
virtual void execute_pixel (float output[4], int x, int y, void *)
 calculate a single pixel More...
 
virtual void execute_pixel_filtered (float[4], float, float, float[2], float[2])
 calculate a single pixel using an EWA filter More...
 
- Static Protected Member Functions inherited from blender::compositor::NodeOperation
static void combine_hashes (size_t &combined, size_t other)
 

Detailed Description

Definition at line 11 of file COM_TranslateOperation.h.

Constructor & Destructor Documentation

◆ TranslateOperation() [1/2]

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

Definition at line 8 of file COM_TranslateOperation.cc.

References Color.

◆ TranslateOperation() [2/2]

blender::compositor::TranslateOperation::TranslateOperation ( DataType  data_type,
ResizeMode  mode = ResizeMode::Center 
)

Member Function Documentation

◆ deinit_execution()

void blender::compositor::TranslateOperation::deinit_execution ( )
overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 35 of file COM_TranslateOperation.cc.

◆ determine_depending_area_of_interest()

bool blender::compositor::TranslateOperation::determine_depending_area_of_interest ( rcti input,
ReadBufferOperation read_operation,
rcti output 
)
overridevirtual

◆ ensure_delta()

void blender::compositor::TranslateOperation::ensure_delta ( )
inline

◆ execute_pixel_sampled()

void blender::compositor::TranslateOperation::execute_pixel_sampled ( float  [4],
float  ,
float  ,
PixelSampler   
)
overridevirtual

calculate a single pixel

Note
this method is called for non-complex
Parameters
resultis a float[4] array to store the result
xthe x-coordinate of the pixel to calculate in image space
ythe y-coordinate of the pixel to calculate in image space
input_bufferschunks that can be read by their ReadBufferOperation.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 42 of file COM_TranslateOperation.cc.

References blender::compositor::Bilinear, ensure_delta(), getDeltaX(), getDeltaY(), output, blender::compositor::NodeOperation::read_sampled(), x, and y.

◆ 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 95 of file COM_TranslateOperation.cc.

References BLI_rcti_translate(), blender::compositor::Clip, ensure_delta(), getDeltaX(), getDeltaY(), x_extend_mode_, and y_extend_mode_.

◆ getDeltaX()

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

◆ getDeltaY()

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

◆ init_execution()

void blender::compositor::TranslateOperation::init_execution ( )
overridevirtual

◆ set_wrapping()

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

◆ setFactorXY()

void blender::compositor::TranslateOperation::setFactorXY ( float  factorX,
float  factorY 
)

◆ 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 116 of file COM_TranslateOperation.cc.

References blender::compositor::area(), getDeltaX(), getDeltaY(), input, inputs, usdtokens::out(), output, x, x_extend_mode_, y, y_extend_mode_, and rcti::ymin.

Member Data Documentation

◆ IMAGE_INPUT_INDEX

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

◆ x_extend_mode_

MemoryBufferExtend blender::compositor::TranslateOperation::x_extend_mode_
protected

◆ X_INPUT_INDEX

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

◆ y_extend_mode_

MemoryBufferExtend blender::compositor::TranslateOperation::y_extend_mode_
protected

◆ Y_INPUT_INDEX

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

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