Skip to content

ImageNodeRead

ImageNodeRead#

(Read)

Go to User page.

Description#

Read a still image or a sequence of images from disk.

Public Attributes#

Type Name Visual Hint Description
reference (ProcessImageNodeWrite) input VISUAL_HINT_DEFAULT Input Image Node Write process.
long input_mode VISUAL_HINT_DEFAULT Control how the node should read the image.
action detect_sequence VISUAL_HINT_DEFAULT
long sequence_mode VISUAL_HINT_DEFAULT Tells whether the read node is working on a still or a sequence or images.
long first_frame VISUAL_HINT_DEFAULT Set the first frame of the sequence.
long last_frame VISUAL_HINT_DEFAULT Set the last frame of the sequence.
long frame_offset VISUAL_HINT_DEFAULT Set the sequence frame offset.
long pre_behavior VISUAL_HINT_DEFAULT Behavior to apply before the beginning of the sequence. Drop shows nothing, Hold uses the first image, Loop repeats the sequence.
long post_behavior VISUAL_HINT_DEFAULT Behavior to apply after the end of the sequence. Drop shows nothing, Hold uses the last image, Loop repeats the sequence.
long missing_frame VISUAL_HINT_DEFAULT Behavior to apply in case an image is missing. Drop shows nothing, Hold uses the last read image
string filename VISUAL_HINT_FILENAME_OPEN Set the filename of the image or sequence. Use # to specify the number of digits of the sequence (for example seq####.exr).
string current_filename VISUAL_HINT_DEFAULT Path to current image.

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.

CID#

class "ImageNodeRead" "ImageNode" {
    #license {
        flavor "advanced"
    }
    #version 0.92
    icon "../icons/object_icons/image_node_read.iconrc"
    category "Image"
    doc "Read a still image or a sequence of images from disk."
    attribute_group "input" {
        reference "input" {
            doc "Input Image Node Write process."
            filter "ProcessImageNodeWrite"
            value ""
        }
        long "input_mode" {
            doc "Control how the node should read the image."
            preset "Force evaluation" "0"
            preset "Evaluate missing" "1"
            preset "Read from disk" "2"
            value 1
        }
    }
    attribute_group "options" {
        action "detect_sequence" {
            value <empty>
        }
        long "sequence_mode" {
            doc "Tells whether the read node is working on a still or a sequence or images."
            preset "Still" "0"
            preset "Sequence" "1"
            value 0
        }
        long "first_frame" {
            doc "Set the first frame of the sequence."
            value 0
        }
        long "last_frame" {
            doc "Set the last frame of the sequence."
            value 0
        }
        long "frame_offset" {
            doc "Set the sequence frame offset."
            value 0
        }
        long "pre_behavior" {
            doc "Behavior to apply before the beginning of the sequence. Drop shows nothing, Hold uses the first image, Loop repeats the sequence."
            preset "Drop" "0"
            preset "Hold" "1"
            preset "Loop" "2"
            value 0
        }
        long "post_behavior" {
            doc "Behavior to apply after the end of the sequence. Drop shows nothing, Hold uses the last image, Loop repeats the sequence."
            preset "Drop" "0"
            preset "Hold" "1"
            preset "Loop" "2"
            value 0
        }
        long "missing_frame" {
            doc "Behavior to apply in case an image is missing. Drop shows nothing, Hold uses the last read image"
            preset "Drop" "0"
            preset "Hold" "1"
            value 0
        }
        filename_open "filename" {
            doc "Set the filename of the image or sequence. Use # to specify the number of digits of the sequence (for example seq####.exr)."
            extension "exr" "tif" "tex" "tx" "hdr" "tga" "png" "jpg" "jpeg" "bmp" "sgi" "psd" "pic"
            value ""
        }
        string "current_filename" {
            doc "Path to current image."
            saveable no
            read_only yes
            value ""
        }
    }
    set "thumbnail" {
        output "none"
        private no
        hidden no
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range no 0.0 1
        ui_range no 0.0 1
        dg_active no
        dg_cyclic no
        dirtiness_pass_through no
        read_only no
        shading_variable no
        experimental no
        advanced no
        overriden no
        promote_attribute no
        allow_expression yes
        localizable yes
        value yes
    }
    set "pass_through" {
        private no
        hidden yes
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range no 0.0 1
        ui_range no 0.0 1
        dg_active yes
        dg_cyclic no
        dirtiness_pass_through no
        read_only no
        shading_variable no
        experimental no
        advanced no
        overriden no
        promote_attribute no
        allow_expression yes
        localizable yes
        value no
    }
    set "master_input" {
        private no
        hidden yes
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range no 0.0 1
        ui_range no 0.0 1
        dg_active yes
        dg_cyclic no
        dirtiness_pass_through no
        read_only no
        shading_variable no
        experimental no
        advanced no
        overriden no
        promote_attribute no
        allow_expression yes
        localizable yes
        value "a"
    }
}