Roto node

This documentation is for version 1.0 of Roto (fr.inria.built-in.Roto).

Description

Create masks and shapes

Inputs

Input

Description

Optional

Bg

Yes

Bg2

Yes

Bg3

Yes

Bg4

Yes

Controls

Parameter / script name

Type

Default

Function

Opacity / opacity

Double

1

Controls the opacity of the selected shape(s).

Color / color

Color

r: 1 g: 1 b: 1

The color of the shape. This parameter is used when the output components are set to RGBA.

Life Time / lifeTime

Choice

All
Controls the life-time of the shape/stroke
All: All frames
Single: Only for the specified frame
From start: From the start of the sequence up to the specified frame
To end: From the specified frame to the end of the sequence
Custom: Use the Activated parameter animation to control the life-time of the shape/stroke using keyframes

Activated / activated

Boolean

On

Controls whether the selected shape(s) should be rendered or not.Note that you can animate this parameter so you can activate/deactivate the shape throughout the time.

Feather / feather

Double

1.5

Controls the distance of feather (in pixels) to add around the selected shape(s)

Feather fall-off / featherFallOff

Double

1

Controls the rate at which the feather is applied on the selected shape(s).

Source / sourceType

Choice

background
Source color used for painting the stroke when the Reveal/Clone tools are used.
foreground: The painted result at this point in the hierarchy.
background: The original image unpainted connected to bg.
background 2: The original image unpainted connected to bg1.
background 3: The original image unpainted connected to bg2.
background 4: The original image unpainted connected to bg3.
background 5: The original image unpainted connected to bg4.
background 6: The original image unpainted connected to bg5.
background 7: The original image unpainted connected to bg6.
background 8: The original image unpainted connected to bg7.
background 9: The original image unpainted connected to bg8.
background 10: The original image unpainted connected to bg9.

Translate / cloneTranslate

Double

x: 0 y: 0

Rotate / cloneRotate

Double

0

Scale / cloneScale

Double

x: 1 y: 1

Uniform / cloneUniform

Boolean

On

Skew X / cloneSkewx

Double

0

Skew Y / cloneSkewy

Double

0

Skew Order / cloneSkewOrder

Choice

XY

XY
YX

Center / cloneCenter

Double

x: 0.5 y: 0.5

Reset Center / resetCloneCenter

Button

Reset the clone transform center

Reset Transform / resetCloneTransform

Button

Reset the clone transform to an identity

Filter / cloneFilter

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: (nearest neighbor / box) Use original values.
Bilinear: (tent / triangle) Bilinear interpolation between original values.
Cubic: (cubic spline) Some smoothing.
Keys: (Catmull-Rom / Hermite spline) Some smoothing, plus minor sharpening (*).
Simon: Some smoothing, plus medium sharpening (*).
Rifman: Some smoothing, plus significant sharpening (*).
Mitchell: Some smoothing, plus blurring to hide pixelation (*)(+).
Parzen: (cubic B-spline) Greatest smoothing of all filters (+).
Notch: Flat smoothing (which tends to hide moire’ patterns) (+).

Black Outside / blackOutside

Boolean

On

Fill the area outside the source image with black

Clone time offset / timeOffset

Integer

0

When the Clone tool is used, this determines depending on the time offset mode the source frame to clone. When in absolute mode, this is the frame number of the source, when in relative mode, this is an offset relative to the current frame.

Mode / timeOffsetMode

Choice

Relative
Time offset mode: when in absolute mode, this is the frame number of the source, when in relative mode, this is an offset relative to the current frame.
Relative
Absolute

Brush Size / brushSize

Double

25

This is the diameter of the brush in pixels. Shift + drag on the viewer to modify this value

Brush Spacing / brushSpacing

Double

0.1

Spacing between stamps of the paint brush

Brush Hardness / brushHardness

Double

0.2

Fall off of the brush effect from the center to the edge

Brush effect / brushEffect

Double

15

The strength of the effect

Opacity / pressureOpacity

Boolean

On

Alters the opacity of the paint brush proportionate to changes in pen pressure

Size / pressureSize

Boolean

Off

Alters the size of the paint brush proportionate to changes in pen pressure

Hardness / pressureHardness

Boolean

Off

Alters the hardness of the paint brush proportionate to changes in pen pressure

Build-up / buildUp

Boolean

Off

When checked, the paint stroke builds up when painted over itself

Visible portion / strokeVisiblePortion

Double

start: 0 end: 1

Defines the range of the stroke that should be visible: 0 is the start of the stroke and 1 the end.

Translate / translate

Double

x: 0 y: 0

Rotate / rotate

Double

0

Scale / scale

Double

x: 1 y: 1

Uniform / uniform

Boolean

On

Skew X / skewx

Double

0

Skew Y / skewy

Double

0

Skew Order / skewOrder

Choice

XY

XY
YX

Center / center

Double

x: 0.5 y: 0.5

Reset Center / resetTransformCenter

Button

Reset the transform center

Interactive / RotoTransformInteractive

Boolean

On

When check, modifying the transform will directly render the shape in the viewer. When unchecked, modifications are applied when releasing the mouse button.

Extra Matrix / extraMatrix

Double

x: 1 y: 0 z: 0 w: 0  : 1  : 0  : 0  : 0  : 1

This matrix gets concatenated to the transform resulting from the parameter above.

Reset Transform / resetTransform

Button

Reset the transform to an identity