Skip to content

NodalItemBackdrop

NodalItemBackdrop#

(Backdrop)

  • Category: NodalItem
  • Default object name: backdrop
  • Inherits from: ProjectItem

Go to User page.

Description#

Layout node that allows to surround a group of nodes with a colored background.

Public Attributes#

Type Name Visual Hint Description
string title VISUAL_HINT_DEFAULT Set the title of the backdrop header.
double[3] color VISUAL_HINT_COLOR Set the color of the backdrop. Note that a new color is automatically set when creating a new backdrop.
long display_comments VISUAL_HINT_DEFAULT Define how comments are displayed in the Build View.
bool autofit VISUAL_HINT_DEFAULT When enabled, resize automatically the backdrop according to the nodes it surrounds.
action fit VISUAL_HINT_DEFAULT Resize to fit content nodes once.

CID#

class "NodalItemBackdrop" "ProjectItem" {
    #license {
        flavor "advanced"
    }
    #version 0.9
    icon "../icons/object_icons/nodal_item_backdrop.iconrc"
    category "NodalItem"
    doc "Layout node that allows to surround a group of nodes with a colored background."
    string "title" {
        doc "Set the title of the backdrop header."
        value "backdrop"
    }
    color "color" {
        doc "Set the color of the backdrop. Note that a new color is automatically set when creating a new backdrop."
        value 0.35 0.31 0.31
    }
    long "display_comments" {
        doc "Define how comments are displayed in the Build View."
        preset "none" "0"
        preset "top" "1"
        preset "bottom" "2"
        preset "left" "3"
        preset "right" "4"
        value 1
    }
    attribute_group "Geometry" {
        bool "autofit" {
            doc "When enabled, resize automatically the backdrop according to the nodes it surrounds."
            value no
        }
        action "fit" {
            doc "Resize to fit content nodes once."
            value <empty>
        }
        long "width" {
            doc "backdrop width."
            hidden yes
            numeric_range yes 30 2147483647
            value 640
        }
        long "height" {
            doc "backdrop height."
            hidden yes
            numeric_range yes 30 2147483647
            value 480
        }
    }
}