ImageNodeDiff

ImageNodeDiff#

(Diff)

Category: Image
Default object name: diff
Inherits from: ProjectItem > ImageNode

Description#

Merge two images.

Public Attributes#

Type	Name	Visual Hint	Description
`reference` (`ImageNode`)	`b`	`VISUAL_HINT_DEFAULT`	Define the B image.
`reference` (`ImageNode`)	`a`	`VISUAL_HINT_DEFAULT`	Define the A image.
`long`	`window`	`VISUAL_HINT_DEFAULT`	Define the resulting image window in the event the image window of the inputs mismatch.
`long`	`background_mode`	`VISUAL_HINT_DEFAULT`	Define the color of the background when the difference is lower than the specified threshold.
`double[4]`	`background_color`	`VISUAL_HINT_RGBA`	Set the background color when Background Mode is set to Use Background Color.
`double`	`difference_threshold`	`VISUAL_HINT_DEFAULT`	Set the threshold for which the node should display Difference Color when performing the difference operation.
`double[4]`	`difference_color`	`VISUAL_HINT_RGBA`	Set the resulting output color when the difference between A and B is higher than the specified threshold.

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 "ImageNodeDiff" "ImageNode" {
    #license {
        flavor "advanced"
    }
    #version 0.92
    icon "../icons/object_icons/image_node_diff.iconrc"
    category "Image"
    doc "Merge two images."
    attribute_group "input" {
        reference "b" {
            doc "Define the B image."
            filter "ImageNode"
            dirtiness_pass_through yes
            value ""
        }
        reference "a" {
            doc "Define the A image."
            filter "ImageNode"
            dirtiness_pass_through yes
            value ""
        }
    }
    attribute_group "options" {
        long "window" {
            doc "Define the resulting image window in the event the image window of the inputs mismatch."
            output "image"
            preset "Keep A" "0"
            preset "Keep B" "1"
            preset "Union" "2"
            preset "Intersection" "3"
            value 2
        }
        long "background_mode" {
            doc "Define the color of the background when the difference is lower than the specified threshold."
            output "image"
            preset "Use Background Color" "0"
            preset "A" "1"
            preset "B" "2"
            value 0
        }
        rgba "background_color" {
            doc "Set the background color when Background Mode is set to Use Background Color."
            output "image"
            animatable yes
            value 0.0 0.0 0.0 1
        }
        double "difference_threshold" {
            doc "Set the threshold for which the node should display Difference Color when performing the difference operation."
            output "image"
            numeric_range yes 0.0 3.402823e+38
            ui_range yes 0.0 1
            value 0.01
        }
        rgba "difference_color" {
            doc "Set the resulting output color when the difference between A and B is higher than the specified threshold."
            output "image"
            animatable yes
            value 1 0.0 1 1
        }
    }
    attribute_group "ModuleImageNodeInput.b" {
        doc "b"
    }
    attribute_group "ModuleImageNodeInput.a" {
        doc "a"
    }
    attribute_group "ModuleImageNodeWindow" {
        doc "null"
    }
    attribute_group "INodeDiffOptions" {
        doc "null"
    }
}