.. _net.sf.openfx.CopyRectanglePlugin:

CopyRectangle node
==================

.. raw:: html

   <!-- Do not edit this file! It is generated automatically by Natron itself. -->

*This documentation is for version 2.0 of CopyRectangle (net.sf.openfx.CopyRectanglePlugin).*

Description
-----------

Copies a rectangle from the input A to the input B in output.

It can be used to limit an effect to a rectangle of the original image by plugging the original image into the input B.

See also https://web.archive.org/web/20220807200909/http://www.opticalenquiry.com/nuke/index.php?title=CopyRectange

Inputs
------

+-------+-----------------------------------------------+----------+
| Input | Description                                   | Optional |
+=======+===============================================+==========+
| B     | The image from which the rectangle is copied. | No       |
+-------+-----------------------------------------------+----------+
| A     | The image from which the rectangle is copied. | No       |
+-------+-----------------------------------------------+----------+
| Mask  |                                               | Yes      |
+-------+-----------------------------------------------+----------+

Controls
--------

.. tabularcolumns:: |>{\raggedright}p{0.2\columnwidth}|>{\raggedright}p{0.06\columnwidth}|>{\raggedright}p{0.07\columnwidth}|p{0.63\columnwidth}|

.. cssclass:: longtable

+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| Parameter / script name              | Type    | Default   | Function                                                                                                                       |
+======================================+=========+===========+================================================================================================================================+
| Bottom Left / ``bottomLeft``         | Double  | x: 0 y: 0 | Coordinates of the bottom left corner of the rectangle                                                                         |
+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| Size / ``size``                      | Double  | w: 1 h: 1 | Width and height of the rectangle                                                                                              |
+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| Interactive Update / ``interactive`` | Boolean | Off       | If checked, update the parameter values during interaction with the image viewer, else update the values when pen is released. |
+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| HiDPI / ``hidpi``                    | Boolean | Off       | Should be checked when the display area is High-DPI (a.k.a Retina). Draws OpenGL overlays twice larger.                        |
+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| Softness / ``softness``              | Double  | 0         | Size of the fade around edges of the rectangle to apply                                                                        |
+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| Invert Mask / ``maskInvert``         | Boolean | Off       | When checked, the effect is fully applied where the mask is 0.                                                                 |
+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+
| Mix / ``mix``                        | Double  | 1         | Mix factor between the original and the transformed image.                                                                     |
+--------------------------------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------------+