WidgetImageView

WidgetImageView#

(Image View)

Category: Render
Default object name: image_view
Inherits from: Widget

Description#

Allow users to view images and to manipulate the project through an image.

Public Attributes#

Type	Name	Visual Hint	Description
`double[3]`	`widget_color`	`VISUAL_HINT_RGB`	Widget background color.
`double[3]`	`background_color`	`VISUAL_HINT_RGB`	Image background color, used when the checkerboard is disabled.
`double`	`icon_size`	`VISUAL_HINT_DEFAULT`
`bool`	`use_rich_icons`	`VISUAL_HINT_DEFAULT`	Display Camera frustum & Spotlight cone eventhough item is not selected.
`string`	`background_plate_filename`	`VISUAL_HINT_FILENAME_OPEN`	Path to the image file.
`double`	`background_plate_opacity`	`VISUAL_HINT_PERCENTAGE`	Image file opacity.
`long`	`background_plate_fit_mode`	`VISUAL_HINT_DEFAULT`	Plate fit mode. All modes preserve aspect ratio except Stretch.
`string`	`foreground_plate_filename`	`VISUAL_HINT_FILENAME_OPEN`	Path to the image file.
`double`	`foreground_plate_opacity`	`VISUAL_HINT_PERCENTAGE`	Image file opacity.
`long`	`foreground_plate_fit_mode`	`VISUAL_HINT_DEFAULT`	Plate fit mode. All modes preserve aspect ratio except Stretch.

CID#

class "WidgetImageView" "Widget" {
    #version 0.92
    icon "../icons/object_icons/widget_image_view.iconrc"
    category "Render"
    doc "Allow users to view images and to manipulate the project through an image."
    reference "image" {
        doc "Widget runtime selected image"
        filter "Image"
        private yes
        hidden yes
        saveable no
        value ""
    }
    reference[10] "image_node" {
        doc "Image node(s) to view, last one is for manual selection & current shot"
        filter "ImageNode"
        output "none"
        private yes
        value "" "" "" "" "" "" "" "" "" ""
    }
    long "image_node_select" {
        output "none"
        private yes
        value 0
    }
    long[4] "image_node_region" {
        doc "Region of interest to be rendered: (left, top, right, bottom) in pixels in the widget coordinates."
        private yes
        animatable yes
        value 0 0 0 0
    }
    percentage[4] "limited_region" {
        doc "Region of interest to be rendered: (left, top, width, height) in percentages of the image visible window size."
        private yes
        animatable yes
        value 0.0 0.0 0.0 0.0
    }
    rgb "widget_color" {
        doc "Widget background color."
        value 0.235 0.235 0.235
    }
    rgb "background_color" {
        doc "Image background color, used when the checkerboard is disabled."
        value 0.0 0.0 0.0
    }
    attribute_group "display" {
        double "icon_size" {
            numeric_range yes 0.0 100000000
            ui_range yes 0.0 100000000
            value 0.5
        }
        bool "use_rich_icons" {
            doc "Display Camera frustum & Spotlight cone eventhough item is not selected."
            value no
        }
    }
    attribute_group "background_plate" {
        filename_open "background_plate_filename" {
            doc "Path to the image file."
            extension "exr" "tif" "tx" "tex" "hdr" "tga" "png" "jpg" "jpeg" "bmp" "sgi" "psd" "pic"
            value ""
        }
        percentage "background_plate_opacity" {
            doc "Image file opacity."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 1
        }
        long "background_plate_fit_mode" {
            doc "Plate fit mode. All modes preserve aspect ratio except Stretch."
            value 0
        }
    }
    attribute_group "foreground_plate" {
        filename_open "foreground_plate_filename" {
            doc "Path to the image file."
            extension "exr" "tif" "tx" "tex" "hdr" "tga" "png" "jpg" "jpeg" "bmp" "sgi" "psd" "pic"
            value ""
        }
        percentage "foreground_plate_opacity" {
            doc "Image file opacity."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 1
        }
        long "foreground_plate_fit_mode" {
            doc "Plate fit mode. All modes preserve aspect ratio except Stretch."
            value 0
        }
    }
}