Skip to content

ImageNodeReformat

ImageNodeReformat#

(Reformat)

Go to User page.

Description#

Reformat image.

Public Attributes#

Type Name Visual Hint Description
reference (ImageNode) a VISUAL_HINT_DEFAULT Define the A image.
long resolution_mode VISUAL_HINT_DEFAULT Defines the canvas size of the image.
string resolution_preset VISUAL_HINT_ENUM Defines the canvas size of the image.
long[2] resolution VISUAL_HINT_PIXEL Defines the canvas size of the image. The canvas is the visible area of the image.
double display_aspect_ratio VISUAL_HINT_DEFAULT Set the pixel aspect ratio of the image when displayed in the Image View. Please note that this is only a display setting. This doesn't modify the rendered pixel aspect ratio.
long resize_type VISUAL_HINT_DEFAULT Width : Scale so that the input width fits the output width, while preserving the aspect ratio. Height : Scale so that the input height fits the output height, while preserving the aspect ratio. Fit : Scale so that the input smallest size fits the output width or height, while preserving the aspect ratio. Fill : Scale so that the input longest size fits the output width or height, while preserving the aspect ratio. Distort : Scale the input so that both sides fit the output dimensions.
bool center VISUAL_HINT_DEFAULT If true, translate the center of the image to the center of the output. Note : It is not used if the resize type is set to Distort.
long filter VISUAL_HINT_DEFAULT Specify the filter used to perform the reformat. Nearest Neighbor use original value, Box integrate the input image over the bounding box of the pixel, Bilinear Filtering and Bicubic Filtering process a linear and cubic interpolation respectively between original values. Please note that Bilinear and Bicubic filter do not apply an antialising filter after resizing the input image, thus as any interpolation filter, there are inappropriate when downscaling an image, in which case you should use a Box filter for better smoothing.

Inherited Public Attributes#

Type Name Visual Hint Description
bool thumbnail VISUAL_HINT_DEFAULT Enable/Disable the display of the node thumbnail in the Build View.
double thumbnail_size VISUAL_HINT_DEFAULT Set the size of the thumbnail in the Build View.
long caching VISUAL_HINT_DEFAULT Cache result of this node
action clear_cache VISUAL_HINT_DEFAULT Clear the internal image cached by the node. If you clear the image cache, the node will request an evaluation when displayed by the Image View.
bool pass_through VISUAL_HINT_DEFAULT Enable pass through. If enabled, the node returns the input specified as Master Input.
string master_input VISUAL_HINT_TAG Define which input should be returned by the node if Pass Through is enabled.

CID#

class "ImageNodeReformat" "ImageNode" {
    #license {
        flavor "advanced"
    }
    #version 0.93
    icon "../icons/object_icons/image_node_reformat.iconrc"
    category "Image"
    doc "Reformat image."
    attribute_group "input" {
        reference "a" {
            doc "Define the A image."
            filter "ImageNode"
            dirtiness_pass_through yes
            value ""
        }
    }
    attribute_group "options" {
        long "resolution_mode" {
            doc "Defines the canvas size of the image."
            preset "Use Project Preferences" "0"
            preset "User-defined" "1"
            value 0
        }
        enum "resolution_preset" {
            doc "Defines the canvas size of the image."
            filter "resolution_preset"
            read_only yes
            value "__invalid_enum_label__"
        }
        pixel[2] "resolution" {
            doc "Defines the canvas size of the image. The canvas is the visible area of the image."
            output "image"
            animatable yes
            numeric_range yes 20 16384
            ui_range yes 20 16384
            read_only yes
            value 1280 720
        }
        double "display_aspect_ratio" {
            doc "Set the pixel aspect ratio of the image when displayed in the Image View. Please note that this is only a display setting. This doesn\'t modify the rendered pixel aspect ratio."
            numeric_range yes 0.1 10
            ui_range yes 0.5 2
            dg_active no
            read_only yes
            value 1
        }
        long "resize_type" {
            doc "Width : Scale so that the input width fits the output width, while preserving the aspect ratio. Height : Scale so that the input height fits the output height, while preserving the aspect ratio. Fit : Scale so that the input smallest size fits the output width or height, while preserving the aspect ratio. Fill : Scale so that the input longest size fits the output width or height, while preserving the aspect ratio. Distort : Scale the input so that both sides fit the output dimensions."
            preset "Width" "0"
            preset "Height" "1"
            preset "Fit" "2"
            preset "Fill" "3"
            preset "Distort" "4"
            value 0
        }
        bool "center" {
            doc "If true, translate the center of the image to the center of the output. Note : It is not used if the resize type is set to Distort."
            value yes
        }
        long "filter" {
            doc "Specify the filter used to perform the reformat. Nearest Neighbor use original value, Box integrate the input image over the bounding box of the pixel, Bilinear Filtering and Bicubic Filtering process a linear and cubic interpolation respectively between original values. Please note that Bilinear and Bicubic filter do not apply an antialising filter after resizing the input image, thus as any interpolation filter, there are inappropriate when downscaling an image, in which case you should use a Box filter for better smoothing."
            preset "Nearest Neighbor" "0"
            preset "Box" "1"
            preset "Bilinear Filtering" "2"
            preset "Bicubic Filtering" "3"
            value 1
        }
    }
    attribute_group "ModuleImageNodeInput.a" {
        doc "a"
    }
}