Struct gdnative_bindings_lily::GraphNode [−][src]
pub struct GraphNode { /* fields omitted */ }
Expand description
core class GraphNode
inherits Container
(unsafe).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
GraphNode
is a reference-only type. Persistent references can
only exist in the unsafe Ref<GraphNode>
form.
In the cases where Rust code owns an object of this type, for example if the object was just
created on the Rust side and not passed to the engine yet, ownership should be either given
to the engine or the object must be manually destroyed using Ref::free
, or Ref::queue_free
if it is a Node
.
Class hierarchy
GraphNode inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Constants
Creates a new instance of this object.
Because this type is not reference counted, the lifetime of the returned object is not automatically managed.
Immediately after creation, the object is owned by the caller, and can be
passed to the engine (in which case the engine will be responsible for
destroying the object) or destroyed manually using Ref::free
, or preferably
Ref::queue_free
if it is a Node
.
Disables all input and output slots of the GraphNode.
Disables input and output slot whose index is idx
.
Returns the color of the input connection idx
.
Returns the number of enabled input slots (connections) to the GraphNode.
Returns the position of the input connection idx
.
Returns the type of the input connection idx
.
Returns the color of the output connection idx
.
Returns the number of enabled output slots (connections) of the GraphNode.
Returns the position of the output connection idx
.
Returns the type of the output connection idx
.
Sets the overlay shown above the GraphNode. See [enum Overlay].
Returns the color set to idx
left (input) slot.
Returns the color set to idx
right (output) slot.
Returns the (integer) type of left (input) idx
slot.
Returns the (integer) type of right (output) idx
slot.
The text displayed in the GraphNode’s title bar.
If true
, the close button will be visible.
Note: Pressing it will only emit the [signal close_request] signal, the GraphNode needs to be removed manually.
If true
, the GraphNode is a comment node.
If true
, the user can resize the GraphNode.
Note: Dragging the handle will only emit the [signal resize_request] signal, the GraphNode needs to be resized manually.
If true
, the GraphNode is selected.
Returns true
if left (input) slot idx
is enabled, false
otherwise.
Returns true
if right (output) slot idx
is enabled, false
otherwise.
If true
, the GraphNode is a comment node.
Sets the overlay shown above the GraphNode. See [enum Overlay].
If true
, the user can resize the GraphNode.
Note: Dragging the handle will only emit the [signal resize_request] signal, the GraphNode needs to be resized manually.
If true
, the GraphNode is selected.
If true
, the close button will be visible.
Note: Pressing it will only emit the [signal close_request] signal, the GraphNode needs to be removed manually.
Sets properties of the slot with ID idx
.
If enable_left
/right
, a port will appear and the slot will be able to be connected from this side.
type_left
/right
is an arbitrary type of the port. Only ports with the same type values can be connected.
color_left
/right
is the tint of the port’s icon on this side.
custom_left
/right
is a custom texture for this side’s port.
Note: This method only sets properties of the slot. To create the slot, add a Control-derived child to the GraphNode.
Default Arguments
custom_left
-null
custom_right
-null
The text displayed in the GraphNode’s title bar.
Methods from Deref<Target = Container>
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
Trait Implementations
type RefKind = ManuallyManaged
type RefKind = ManuallyManaged
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for GraphNode
impl UnwindSafe for GraphNode