Skip to content

NodalItemDot

NodalItemDot#

(Dot)

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

Go to User page.

Description#

Layout node used to improve the graph layout as it creates a colored proxy to an input node that can be located somewhere else. It can also be used to route connections to avoid traversing nodes.

Public Attributes#

Type Name Visual Hint Description
double[3] color VISUAL_HINT_COLOR Set the color of the dot.
long size VISUAL_HINT_DEFAULT Set the size of the dot.
long display_comments VISUAL_HINT_DEFAULT Define how comments are displayed in the View.
reference input VISUAL_HINT_DEFAULT Input item of the dot.
bool hide_input_link VISUAL_HINT_DEFAULT When turned on, the link between Dot and its Input node is hidden.

CID#

class "NodalItemDot" "ProjectItem" {
    #version 0.9
    icon "../icons/object_icons/nodal_item_dot.iconrc"
    category "NodalItem"
    doc "Layout node used to improve the graph layout as it creates a colored proxy to an input node that can be located somewhere else. It can also be used to route connections to avoid traversing nodes."
    color "color" {
        doc "Set the color of the dot."
        output "none"
        value 0.35 0.31 0.31
    }
    long "size" {
        doc "Set the size of the dot."
        output "none"
        numeric_range yes 10 65536
        ui_range yes 10 255
        value 15
    }
    long "display_comments" {
        doc "Define how comments are displayed in the View."
        output "none"
        preset "none" "0"
        preset "top" "1"
        preset "bottom" "2"
        preset "left" "3"
        preset "right" "4"
        value 1
    }
    reference "input" {
        doc "Input item of the dot."
        filter "Context" "ProjectItem"
        value ""
    }
    bool "hide_input_link" {
        doc "When turned on, the link between Dot and its Input node is hidden."
        output "none"
        value no
    }
}