RV Masking

Usage

Creates a sub-menu called SG Masking. The matte characteristics are specified in Shotgun on a CustomNonProjectEntity by aspect ratio, a visible fraction of the image, as well as the center point of the matte in normalized coordinates.

You may configure the definitions by using the SG Masking > Manage Mask Definitions menu item, which will forward you to the shotgun page. Once you've changed the definition you may use the SG Masking > Force Reloading Mask Definitions menu item to get the updated settings.

To change the matte opacity please use the SG Masking > Opacity sub menu and to change the matte use the SG Masking > Masks sub-menu.

Example

Raw image:

Selected 16:9 (1.178) ratio with semi-transparent:

Selected widescreen (1.85) ratio with semi-transparent:

Selected Univisium with semi-transparent:

Selected widescreen (1.85) ratio with opaque:

Shotgun Mask Definition

The following is a description of the field values in Shotgun.

• Name: used for user feedback and UI
• Ratio: of the unmatted visible area
• Visible Height: Fraction of image visible by height (if top and bottom are 5% matted then this would be 0.9)
• Center X: Center point of matte in normalized X (0 is centered see "Normalized Coordinates" below)
• Center Y: Center point of matte in normalized Y (0 is centered see "Normalized Coordinates" below)
• Description: Long-form descriptive text

Configuration

This package makes use of a CustomNonProjectEntity with the following extra fields:

• Ratio (Float): sg_ratio
• Height Visible (Float): sg_height_visible
• Center X (Float): sg_center_x
• Center Y (Float): sg_center_y

To configure the shotgun entries please edit the config.json, which looks like this:

{
    "sg-masking-mode": {
        "entity-type": "CustomNonProjectEntity08",
        "page-id": "1482",
        "entity-fields": {
            "name": "code",
            "ratio": "sg_ratio",
            "height-visible": "sg_height_visible",
            "center-x": "sg_center_x",
            "center-y": "sg_center_y",
            "description": "description"
        }
   }
}

After installation of the package you can edit the config file by using the SG Masking > Advances > Settings menu item:

After saving you need to use the Force Reloading Mask Definitions to apply the changes to your current session. Otherwise it will be available on the next start of RV.

Environment Configuration

It is possible to overwrite the configuration by using an environment variable. To do so, save your desired configuration into a json-file. Store the file-path into the environment-variable: RV_PACKAGE_SETTINGS and start RV from this environment.