godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
30bc58bbda99abc3589627ed4cdf34c1215adaaf
godot-docs/classes/class_graphnode.rst
Rémi Verschelde 30bc58bbda classref: Sync with current master branch
2017-09-06 14:46:15 +02:00

293 lines
34 KiB
ReStructuredText
Raw Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_GraphNode:
GraphNode
=========
**Inherits:** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_all_slots<class_GraphNode_clear_all_slots>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_slot<class_GraphNode_clear_slot>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_connection_input_color<class_GraphNode_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_input_count<class_GraphNode_get_connection_input_count>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_input_pos<class_GraphNode_get_connection_input_pos>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_input_type<class_GraphNode_get_connection_input_type>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_connection_output_color<class_GraphNode_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_output_count<class_GraphNode_get_connection_output_count>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_output_pos<class_GraphNode_get_connection_output_pos>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_output_type<class_GraphNode_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_GraphNode_get_offset>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_overlay<class_GraphNode_get_overlay>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_left<class_GraphNode_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_right<class_GraphNode_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_slot_type_left<class_GraphNode_get_slot_type_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_slot_type_right<class_GraphNode_get_slot_type_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_title<class_GraphNode_get_title>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_close_button_visible<class_GraphNode_is_close_button_visible>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_comment<class_GraphNode_is_comment>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_resizable<class_GraphNode_is_resizable>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_GraphNode_is_selected>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_left<class_GraphNode_is_slot_enabled_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_right<class_GraphNode_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_comment<class_GraphNode_set_comment>` **(** :ref:`bool<class_bool>` comment **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_GraphNode_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_overlay<class_GraphNode_set_overlay>` **(** :ref:`int<class_int>` overlay **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_resizable<class_GraphNode_set_resizable>` **(** :ref:`bool<class_bool>` resizable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_GraphNode_set_selected>` **(** :ref:`bool<class_bool>` selected **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_show_close_button<class_GraphNode_set_show_close_button>` **(** :ref:`bool<class_bool>` show **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_title<class_GraphNode_set_title>` **(** :ref:`String<class_string>` title **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **close_request** **(** **)**
Signal sent on closing the GraphNode.
- **dragged** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)**
Signal sent when the GraphNode is dragged.
- **offset_changed** **(** **)**
Signal sent when the GraphNode is moved.
- **raise_request** **(** **)**
Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
- **resize_request** **(** :ref:`Vector2<class_vector2>` new_minsize **)**
Member Variables
----------------
- :ref:`bool<class_bool>` **resizable**
- :ref:`bool<class_bool>` **show_close**
- :ref:`String<class_string>` **title**
Numeric Constants
-----------------
- **OVERLAY_DISABLED** = **0**
- **OVERLAY_BREAKPOINT** = **1**
- **OVERLAY_POSITION** = **2**
Description
-----------
A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections.
Member Function Description
---------------------------
.. _class_GraphNode_clear_all_slots:
- void **clear_all_slots** **(** **)**
Disable all input and output slots of the GraphNode.
.. _class_GraphNode_clear_slot:
- void **clear_slot** **(** :ref:`int<class_int>` idx **)**
Disable input and output slot whose index is 'idx'.
.. _class_GraphNode_get_connection_input_color:
- :ref:`Color<class_color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**
Return the color of the input connection 'idx'.
.. _class_GraphNode_get_connection_input_count:
- :ref:`int<class_int>` **get_connection_input_count** **(** **)**
Return the number of enabled input slots (connections) to the GraphNode.
.. _class_GraphNode_get_connection_input_pos:
- :ref:`Vector2<class_vector2>` **get_connection_input_pos** **(** :ref:`int<class_int>` idx **)**
Return the position of the input connection 'idx'.
.. _class_GraphNode_get_connection_input_type:
- :ref:`int<class_int>` **get_connection_input_type** **(** :ref:`int<class_int>` idx **)**
Return the type of the input connection 'idx'.
.. _class_GraphNode_get_connection_output_color:
- :ref:`Color<class_color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**
Return the color of the output connection 'idx'.
.. _class_GraphNode_get_connection_output_count:
- :ref:`int<class_int>` **get_connection_output_count** **(** **)**
Return the number of enabled output slots (connections) of the GraphNode.
.. _class_GraphNode_get_connection_output_pos:
- :ref:`Vector2<class_vector2>` **get_connection_output_pos** **(** :ref:`int<class_int>` idx **)**
Return the position of the output connection 'idx'.
.. _class_GraphNode_get_connection_output_type:
- :ref:`int<class_int>` **get_connection_output_type** **(** :ref:`int<class_int>` idx **)**
Return the type of the output connection 'idx'.
.. _class_GraphNode_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the offset of the GraphNode.
.. _class_GraphNode_get_overlay:
- :ref:`int<class_int>` **get_overlay** **(** **)** const
.. _class_GraphNode_get_slot_color_left:
- :ref:`Color<class_color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** const
Return the color set to 'idx' left (input) slot.
.. _class_GraphNode_get_slot_color_right:
- :ref:`Color<class_color>` **get_slot_color_right** **(** :ref:`int<class_int>` idx **)** const
Return the color set to 'idx' right (output) slot.
.. _class_GraphNode_get_slot_type_left:
- :ref:`int<class_int>` **get_slot_type_left** **(** :ref:`int<class_int>` idx **)** const
Return the (integer) type of left (input) 'idx' slot.
.. _class_GraphNode_get_slot_type_right:
- :ref:`int<class_int>` **get_slot_type_right** **(** :ref:`int<class_int>` idx **)** const
Return the (integer) type of right (output) 'idx' slot.
.. _class_GraphNode_get_title:
- :ref:`String<class_string>` **get_title** **(** **)** const
Return the title of the GraphNode.
.. _class_GraphNode_is_close_button_visible:
- :ref:`bool<class_bool>` **is_close_button_visible** **(** **)** const
Returns true if the close button is shown. False otherwise.
.. _class_GraphNode_is_comment:
- :ref:`bool<class_bool>` **is_comment** **(** **)** const
.. _class_GraphNode_is_resizable:
- :ref:`bool<class_bool>` **is_resizable** **(** **)** const
.. _class_GraphNode_is_selected:
- :ref:`bool<class_bool>` **is_selected** **(** **)**
.. _class_GraphNode_is_slot_enabled_left:
- :ref:`bool<class_bool>` **is_slot_enabled_left** **(** :ref:`int<class_int>` idx **)** const
Return true if left (input) slot 'idx' is enabled. False otherwise.
.. _class_GraphNode_is_slot_enabled_right:
- :ref:`bool<class_bool>` **is_slot_enabled_right** **(** :ref:`int<class_int>` idx **)** const
Return true if right (output) slot 'idx' is enabled. False otherwise.
.. _class_GraphNode_set_comment:
- void **set_comment** **(** :ref:`bool<class_bool>` comment **)**
.. _class_GraphNode_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the offset of the GraphNode.
.. _class_GraphNode_set_overlay:
- void **set_overlay** **(** :ref:`int<class_int>` overlay **)**
.. _class_GraphNode_set_resizable:
- void **set_resizable** **(** :ref:`bool<class_bool>` resizable **)**
.. _class_GraphNode_set_selected:
- void **set_selected** **(** :ref:`bool<class_bool>` selected **)**
.. _class_GraphNode_set_show_close_button:
- void **set_show_close_button** **(** :ref:`bool<class_bool>` show **)**
Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work.
.. _class_GraphNode_set_slot:
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)**
.. _class_GraphNode_set_title:
- void **set_title** **(** :ref:`String<class_string>` title **)**
Set the title of the GraphNode.
Reference in New Issue View Git Blame Copy Permalink