Skip to content

ToolRenderRegion

ToolRenderRegion#

(Render Region)

  • Category: View
  • Default object name: render_region
  • Inherits from: Tool

Go to User page.

Description#

Define a region to render only a specific part of the image.

Public Attributes#

Type Name Visual Hint Description
long mode VISUAL_HINT_DEFAULT Region draw mode. Centered Box draws a region centered on LMB start position. Box 2D draws a region starting from a corner at LMB start position.
long target VISUAL_HINT_DEFAULT Region target. Widget applies to the Image View Widget. Image applies to displayed the Image.

CID#

class "ToolRenderRegion" "Tool" {
    #version 0.9
    icon "../icons/object_icons/tool_render_region.iconrc"
    category "View"
    doc "Define a region to render only a specific part of the image."
    ui_weight 30
    attribute_group "region_tool" {
        long "mode" {
            doc "Region draw mode. Centered Box draws a region centered on LMB start position. Box 2D draws a region starting from a corner at LMB start position."
            preset "Centered Box" "0"
            preset "Box 2D" "1"
            value 1
        }
        long "target" {
            doc "Region target. Widget applies to the Image View Widget. Image applies to displayed the Image."
            preset "Widget" "0"
            preset "Image" "1"
            value 0
        }
    }
}