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 ¶
- type Advanced
- type AlignmentMode
- type Any
- type Extension
- func (self *Extension[T]) AsAspectRatioContainer() Instance
- func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
- func (self *Extension[T]) AsContainer() Container.Instance
- func (self *Extension[T]) AsControl() Control.Instance
- func (self *Extension[T]) AsNode() Node.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- type ID
- type Instance
- func (self Instance) AlignmentHorizontal() AlignmentMode
- func (self Instance) AlignmentVertical() AlignmentMode
- func (self Instance) AsAspectRatioContainer() Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsContainer() Container.Instance
- func (self Instance) AsControl() Control.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) ID() ID
- func (self Instance) Ratio() Float.X
- func (self Instance) SetAlignmentHorizontal(value AlignmentMode)
- func (self Instance) SetAlignmentVertical(value AlignmentMode)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetRatio(value Float.X)
- func (self Instance) SetStretchMode(value StretchMode)
- func (self Instance) StretchMode() StretchMode
- func (self Instance) Virtual(name string) reflect.Value
- type StretchMode
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 Extension ¶
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 (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsContainer ¶
type 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.
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 (Instance) AlignmentHorizontal ¶
func (self Instance) AlignmentHorizontal() AlignmentMode
func (Instance) AlignmentVertical ¶
func (self Instance) AlignmentVertical() AlignmentMode
func (Instance) AsAspectRatioContainer ¶
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsContainer ¶
func (Instance) SetAlignmentHorizontal ¶
func (self Instance) SetAlignmentHorizontal(value AlignmentMode)
func (Instance) SetAlignmentVertical ¶
func (self Instance) SetAlignmentVertical(value AlignmentMode)
func (Instance) SetStretchMode ¶
func (self Instance) SetStretchMode(value StretchMode)
func (Instance) StretchMode ¶
func (self Instance) StretchMode() StretchMode
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 )