MaskLayer: StencilMask Toggle for Current Layer/frames in TVPaint 11

Share your custom panels, brushes, papers... (you need to be registered to read posts in this section)
Post Reply
Svengali
Posts: 1552
Joined: 28 Dec 2006, 10:08

MaskLayer: StencilMask Toggle for Current Layer/frames in TVPaint 11

Post by Svengali »

MaskLayer.gif
MaskLayer.gif (7.4 MiB) Viewed 3863 times
In TVPaint 10 it used to be possible to turn the pixels of the current layer/frames into a normal Mask or an inverted Mask on the current layer/frames, and continue to draw. Some NEWBIE TVPaint users would occasionally turn the stencil on for the current layer by accident without realizing it and "mysteriously" could no longer draw on any frame of the current layer. This "mysterious loss of drawing" happened often enough that tech support and developers of TVPaint11 preempted the stencil mask for the current layer/frames. So, Stencil Masking of the active drawing layer went away; good for the new users but not so much for artists whose drawing workflow frequently used the stencil mask of the active layer/frame for critical drawing processes.

The MaskLayer Script for TVPaint 11.x Users
The MaskLayer Script provides a three way toggle for users of TVPaint 11 that works almost exactly like old TVPaint 10Stencil Mask did. Normally, the Stencil Mask is off. Direct drawing on the current layer/frames works as expected. When the MaskLayer Script is toggled, any pixels on the current layer/frame will act as a mask. Of course, the transparency of each pixel will be reflected in the opacity or partial transparency of the Stencil Mask. The presence of the masked pixel areas will show as a soft gray checkboard (you will still be able to see the pixels). When the MaskLayer Script button is toggled again, the Stencil Mask is inverted so that the soft gray checkerboard indicates the background, non-pixel areas of the screen that are protected from being drawn upon. Partially transparent pixels will have partial inverted masking as well. When the MaskLayer Script is toggled a third time, the Stencil Mask is removed so the artist returns to drawing normally, over background and existing pixels.

How the MaskLayer Script Works
First press of the MaskLayer Script button creates a duplicate of all frames for the current layer and positions this layer copy at the bottom of the layer stack. It also deactivates the visibility of that layer and assigns the Stencil Mask to ON INVERT so that the copied layer can act as a perfect mask to the existing pixels as the artist can draw under them on any selected frame of the current layer.Pressing the MaskLayer Script again deletes the existing MaskLayer after noting the state of the Stencil setting. A new MaskLayer is created and moved to the bottom layer position. The new copy is based on updated drawings of current layer's pixels and the new Stencil Mask is assigned ON NORMAL so that the background surrounding the pixels can act as a new perfect mask for drawing over any existing pixels on any and all frames of the current layer.

WARNING: IF no pixels exist for any frame of the active layer, the Stencil Mask completely protects the entire frame making it impossible to draw on it. In that case a popup message warns the user that the blank frame cannot be drawn on. Pressing the MaskLayer Script again simply deletes the existing MaskLayer and the artist can draw on the current layer frames in a normal way.

MaskLayer Script Notes:
Remember that any newly drawn pixels on the current layer will become part of future mask contours on the next toggle.
The user is responsible for toggling the mask state: Off, Invert, Normal. But the MaskLayer Script will do the housekeeping as to the presence of the MaskLayer and its Stencil status.
Toggling the MaskLayer Script works best when assigned to a shortcut key. The transparent gray checkboard gives a subtle visual indication of the mask state, inverted or normal, or not present.
When the MaskLayer button is toggled to off, the temporary layer at the bottom of the layer stack is deleted (not saved with the project).

SECOND REMINDER: Once created, the StencilMask for the original layer IS STILL PRESENT AND REMAINS ACTIVE WHEN YOU CHANGE LAYERS, SO YOU MUST REMEMBER TO TAB THE MASK LAYER OFF (or shut it off manually), OR IT WILL PROBABLY ADVERSELY AFFECT DRAWING ON OTHER LAYERS! On the positive side, the mask is still visible because of the gray checkerboard pattern... you will know exactly where the still active mask is in effect, AND this gives you an easy way to create a multiframe mask that could prove useful when working on different layers...
Attachments
MaskLayer.tvpx
(65.5 KiB) Downloaded 320 times
TVP Pro 11.0.10-64bit Win10 - 64GB ram -2TB HHD - 256GB SSD - Wacom Cintiq 16, driver 6.3.41-1
Android Tablet: rel. 11, Samsung Galaxy Note10.1 - 32GB with microSD 32GB
Android Tablet: rel. 11.5, Samsung Galaxy Tab S7plus - 128GB with microSD 64GB
User avatar
NathanOtano
Posts: 1187
Joined: 01 Apr 2014, 07:07
Location: Biarritz, France
Contact:

Re: MaskLayer: StencilMask Toggle for Current Layer/frames in TVPaint 11

Post by NathanOtano »

Thanks :) Great script
Working on Windows 10
Creator of Disnosc, providing storyboard, animation and design for 2D realistic pictural animation: https://www.disnosc.fr/ - nathanotano@disnosc.fr
Highly interested in animation workflows, I'm open to scripting new TVP functions for individuals and studios.
Post Reply