GraphFrame

package

v0.0.0-...-357ca8a Latest Latest Go to latest Published: Sep 20, 2025 License: MIT Imports: 30 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/quaadgras/graphics.gd

Links

Open Source Insights

Documentation ¶

Overview ¶

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.

Index ¶

type Advanced
type Any
type Extension
type ID
- func (id ID) Instance() (Instance, bool)
type Instance
- func New() Instance

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Advanced ¶

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any ¶

type Any interface {
	gd.IsClass
	AsGraphFrame() Instance
}

type Extension ¶

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsCanvasItem ¶

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsContainer ¶

func (self *Extension[T]) AsContainer() Container.Instance

func (*Extension[T]) AsControl ¶

func (self *Extension[T]) AsControl() Control.Instance

func (*Extension[T]) AsGraphElement ¶

func (self *Extension[T]) AsGraphElement() GraphElement.Instance

func (*Extension[T]) AsGraphFrame ¶

func (self *Extension[T]) AsGraphFrame() Instance

func (*Extension[T]) AsNode ¶

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject ¶

func (self *Extension[T]) AsObject() [1]gd.Object

type ID ¶

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance ¶

func (id ID) Instance() (Instance, bool)

type Instance ¶

type Instance [1]gdclass.GraphFrame

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New ¶

func New() Instance

func (Instance) AsCanvasItem ¶

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsContainer ¶

func (self Instance) AsContainer() Container.Instance

func (Instance) AsControl ¶

func (self Instance) AsControl() Control.Instance

func (Instance) AsGraphElement ¶

func (self Instance) AsGraphElement() GraphElement.Instance

func (Instance) AsGraphFrame ¶

func (self Instance) AsGraphFrame() Instance

func (Instance) AsNode ¶

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject ¶

func (self Instance) AsObject() [1]gd.Object

func (Instance) AutoshrinkEnabled ¶

func (self Instance) AutoshrinkEnabled() bool

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

func (Instance) AutoshrinkMargin ¶

func (self Instance) AutoshrinkMargin() int

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

func (Instance) DragMargin ¶

func (self Instance) DragMargin() int

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

func (Instance) GetTitlebarHbox ¶

func (self Instance) GetTitlebarHbox() HBoxContainer.Instance

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.

func (Instance) ID ¶

func (self Instance) ID() ID

func (Instance) OnAutoshrinkChanged ¶

func (self Instance) OnAutoshrinkChanged(cb func(), flags ...Signal.Flags)

Emitted when AutoshrinkEnabled or AutoshrinkMargin changes.

func (Instance) SetAutoshrinkEnabled ¶

func (self Instance) SetAutoshrinkEnabled(value bool)

SetAutoshrinkEnabled sets the property returned by [IsAutoshrinkEnabled].

func (Instance) SetAutoshrinkMargin ¶

func (self Instance) SetAutoshrinkMargin(value int)

SetAutoshrinkMargin sets the property returned by [GetAutoshrinkMargin].

func (Instance) SetDragMargin ¶

func (self Instance) SetDragMargin(value int)

SetDragMargin sets the property returned by [GetDragMargin].

func (*Instance) SetObject ¶

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetTintColor ¶

func (self Instance) SetTintColor(value Color.RGBA)

SetTintColor sets the property returned by [GetTintColor].

func (Instance) SetTintColorEnabled ¶

func (self Instance) SetTintColorEnabled(value bool)

SetTintColorEnabled sets the property returned by [IsTintColorEnabled].

func (Instance) SetTitle ¶

func (self Instance) SetTitle(value string)

SetTitle sets the property returned by [GetTitle].

func (Instance) TintColor ¶

func (self Instance) TintColor() Color.RGBA

The color of the frame when TintColorEnabled is true.

func (Instance) TintColorEnabled ¶

func (self Instance) TintColorEnabled() bool

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

func (Instance) Title ¶

func (self Instance) Title() string

Title of the frame.

func (Instance) Virtual ¶

func (self Instance) Virtual(name string) reflect.Value

Source Files ¶

View all Source files

class.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL