AspectRatioContainer

package
v0.0.0-...-fa94a0d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2025 License: MIT Imports: 27 Imported by: 0

Documentation

Overview

A container type that arranges its child controls in a way that preserves their proportions automatically when the container is resized. Useful when a container has a dynamic size and the child nodes must adjust their sizes accordingly without losing their aspect ratios.

Index

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 AlignmentMode

type AlignmentMode int //gd:AspectRatioContainer.AlignmentMode
const (
	// Aligns child controls with the beginning (left or top) of the container.
	AlignmentBegin AlignmentMode = 0
	// Aligns child controls with the center of the container.
	AlignmentCenter AlignmentMode = 1
	// Aligns child controls with the end (right or bottom) of the container.
	AlignmentEnd AlignmentMode = 2
)

type Any

type Any interface {
	gd.IsClass
	AsAspectRatioContainer() 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]) AsAspectRatioContainer

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

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]) 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.AspectRatioContainer

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) AlignmentHorizontal

func (self Instance) AlignmentHorizontal() AlignmentMode

func (Instance) AlignmentVertical

func (self Instance) AlignmentVertical() AlignmentMode

func (Instance) AsAspectRatioContainer

func (self Instance) AsAspectRatioContainer() 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) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

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

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Ratio

func (self Instance) Ratio() Float.X

func (Instance) SetAlignmentHorizontal

func (self Instance) SetAlignmentHorizontal(value AlignmentMode)

func (Instance) SetAlignmentVertical

func (self Instance) SetAlignmentVertical(value AlignmentMode)

func (*Instance) SetObject

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

func (Instance) SetRatio

func (self Instance) SetRatio(value Float.X)

func (Instance) SetStretchMode

func (self Instance) SetStretchMode(value StretchMode)

func (Instance) StretchMode

func (self Instance) StretchMode() StretchMode

func (Instance) Virtual

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

type StretchMode

type StretchMode int //gd:AspectRatioContainer.StretchMode
const (
	// The height of child controls is automatically adjusted based on the width of the container.
	StretchWidthControlsHeight StretchMode = 0
	// The width of child controls is automatically adjusted based on the height of the container.
	StretchHeightControlsWidth StretchMode = 1
	// The bounding rectangle of child controls is automatically adjusted to fit inside the container while keeping the aspect ratio.
	StretchFit StretchMode = 2
	// The width and height of child controls is automatically adjusted to make their bounding rectangle cover the entire area of the container while keeping the aspect ratio.
	//
	// When the bounding rectangle of child controls exceed the container's size and [Control.ClipContents] is enabled, this allows to show only the container's area restricted by its own bounding rectangle.
	//
	// [Control.ClipContents]: https://pkg.go.dev/graphics.gd/classdb/Control#Instance.ClipContents
	StretchCover StretchMode = 3
)

Jump to

Keyboard shortcuts

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