.. _net.sf.openfx.TransformMaskedPlugin:

TransformMasked node
====================

.. raw:: html

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

|pluginIcon| 

*This documentation is for version 1.0 of TransformMasked (net.sf.openfx.TransformMaskedPlugin).*

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

Translate / Rotate / Scale a 2D image, with optional masking.

This plugin concatenates transforms upstream.

Inputs
------

+--------+-------------+----------+
| Input  | Description | Optional |
+========+=============+==========+
| Source |             | 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                                                                                                                                                                                                                                                  |
+=============================================+=========+===============+===========================================================================================================================================================================================================================================================+
| Translate / ``translate``                   | Double  | x: 0 y: 0     | Translation along the x and y axes in pixels. Can also be adjusted by clicking and dragging the center handle in the Viewer.                                                                                                                              |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Rotate / ``rotate``                         | Double  | 0             | Rotation angle in degrees around the Center. Can also be adjusted by clicking and dragging the rotation bar in the Viewer.                                                                                                                                |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Scale / ``scale``                           | Double  | x: 1 y: 1     | Scale factor along the x and y axes. Can also be adjusted by clicking and dragging the outer circle or the diameter handles in the Viewer.                                                                                                                |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Uniform / ``uniform``                       | Boolean | Off           | Use the X scale for both directions                                                                                                                                                                                                                       |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Skew X / ``skewX``                          | Double  | 0             | Skew along the x axis. Can also be adjusted by clicking and dragging the skew bar in the Viewer.                                                                                                                                                          |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Skew Y / ``skewY``                          | Double  | 0             | Skew along the y axis.                                                                                                                                                                                                                                    |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Skew Order / ``skewOrder``                  | Choice  | XY            | | The order in which skew transforms are applied: X then Y, or Y then X.                                                                                                                                                                                  |
|                                             |         |               | | **XY**                                                                                                                                                                                                                                                  |
|                                             |         |               | | **YX**                                                                                                                                                                                                                                                  |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Amount / ``transformAmount``                | Double  | 1             | Amount of transform to apply. 0 means the transform is identity, 1 means to apply the full transform.                                                                                                                                                     |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Center / ``center``                         | Double  | x: 0.5 y: 0.5 | Center of rotation and scale.                                                                                                                                                                                                                             |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Reset Center / ``resetCenter``              | Button  |               | Reset the position of the center to the center of the input region of definition                                                                                                                                                                          |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Interactive Update / ``interactive``        | Boolean | On            | 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.                                                                                                                                                   |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Invert / ``invert``                         | Boolean | Off           | Invert the transform.                                                                                                                                                                                                                                     |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Filter / ``filter``                         | Choice  | Cubic         | | Filtering algorithm - some filters may produce values outside of the initial range (*) or modify the values even if there is no movement (+).                                                                                                           |
|                                             |         |               | | **Impulse (impulse)**: (nearest neighbor / box) Use original values.                                                                                                                                                                                    |
|                                             |         |               | | **Box (box)**: Integrate the source image over the bounding box of the back-transformed pixel.                                                                                                                                                          |
|                                             |         |               | | **Bilinear (bilinear)**: (tent / triangle) Bilinear interpolation between original values.                                                                                                                                                              |
|                                             |         |               | | **Cubic (cubic)**: (cubic spline) Some smoothing.                                                                                                                                                                                                       |
|                                             |         |               | | **Keys (keys)**: (Catmull-Rom / Hermite spline) Some smoothing, plus minor sharpening (*).                                                                                                                                                              |
|                                             |         |               | | **Simon (simon)**: Some smoothing, plus medium sharpening (*).                                                                                                                                                                                          |
|                                             |         |               | | **Rifman (rifman)**: Some smoothing, plus significant sharpening (*).                                                                                                                                                                                   |
|                                             |         |               | | **Mitchell (mitchell)**: Some smoothing, plus blurring to hide pixelation (*)(+).                                                                                                                                                                       |
|                                             |         |               | | **Parzen (parzen)**: (cubic B-spline) Greatest smoothing of all filters (+).                                                                                                                                                                            |
|                                             |         |               | | **Notch (notch)**: Flat smoothing (which tends to hide moire’ patterns) (+).                                                                                                                                                                            |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Clamp / ``clamp``                           | Boolean | Off           | Clamp filter output within the original range - useful to avoid negative values in mattes                                                                                                                                                                 |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Black outside / ``black_outside``           | Boolean | On            | Fill the area outside the source image with black                                                                                                                                                                                                         |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Motion Blur / ``motionBlur``                | Double  | 0             | Quality of motion blur rendering. 0 disables motion blur, 1 is a good value. Increasing this slows down rendering.                                                                                                                                        |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Directional Blur Mode / ``directionalBlur`` | Boolean | Off           | Motion blur is computed from the original image to the transformed image, each parameter being interpolated linearly. The motionBlur parameter must be set to a nonzero value, and the blackOutside parameter may have an important effect on the result. |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Shutter / ``shutter``                       | Double  | 0.5           | Controls how long (in frames) the shutter should remain open.                                                                                                                                                                                             |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Shutter Offset / ``shutterOffset``          | Choice  | Start         | | Controls when the shutter should be open/closed. Ignored if there is no motion blur (i.e. shutter=0 or motionBlur=0).                                                                                                                                   |
|                                             |         |               | | **Centered (centered)**: Centers the shutter around the frame (from t-shutter/2 to t+shutter/2)                                                                                                                                                         |
|                                             |         |               | | **Start (start)**: Open the shutter at the frame (from t to t+shutter)                                                                                                                                                                                  |
|                                             |         |               | | **End (end)**: Close the shutter at the frame (from t-shutter to t)                                                                                                                                                                                     |
|                                             |         |               | | **Custom (custom)**: Open the shutter at t+shuttercustomoffset (from t+shuttercustomoffset to t+shuttercustomoffset+shutter)                                                                                                                            |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Custom Offset / ``shutterCustomOffset``     | Double  | 0             | When custom is selected, the shutter is open at current time plus this offset (in frames). Ignored if there is no motion blur (i.e. shutter=0 or motionBlur=0).                                                                                           |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.                                                                                                                                                                                                |
+---------------------------------------------+---------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. |pluginIcon| image:: net.sf.openfx.TransformMaskedPlugin.png
   :width: 10.0%
