Table of Contents

Class GraphFrame

Namespace
Godot
Assembly
GodotSharp.dll

GraphFrame is a special GraphElement to which other GraphElements can be attached. It can be configured to automatically resize to enclose all attached GraphElements. If the frame is moved, all the attached GraphElements inside it will be moved as well.

A GraphFrame is always kept behind the connection layer and other GraphElements inside a GraphEdit.

public class GraphFrame : GraphElement, IDisposable
Inheritance
GraphFrame
Implements
Inherited Members

Constructors

GraphFrame() 

public GraphFrame()

Properties

AutoshrinkEnabled

If true, the frame's rect will be adjusted automatically to enclose all attached GraphElements.

public bool AutoshrinkEnabled { get; set; }

Property Value

bool

AutoshrinkMargin

The margin around the attached nodes that is used to calculate the size of the frame when AutoshrinkEnabled is true.

public int AutoshrinkMargin { get; set; }

Property Value

int

DragMargin

The margin inside the frame that can be used to drag the frame.

public int DragMargin { get; set; }

Property Value

int

TintColor

The color of the frame when TintColorEnabled is true.

public Color TintColor { get; set; }

Property Value

Color

TintColorEnabled

If true, the tint color will be used to tint the frame.

public bool TintColorEnabled { get; set; }

Property Value

bool

Title

Title of the frame.

public string Title { get; set; }

Property Value

string

Methods

GetTitlebarHBox()

Returns the HBoxContainer used for the title bar, only containing a Label for displaying the title by default.

This can be used to add custom controls to the title bar such as option or close buttons.

public HBoxContainer GetTitlebarHBox()

Returns

HBoxContainer

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

Events

AutoshrinkChanged

Emitted when AutoshrinkEnabled or AutoshrinkMargin changes.

public event Action AutoshrinkChanged

Event Type

Action
Edit this page