AspectRatioContainer

Documentation

Overview

Package AspectRatioContainer provides methods for working with AspectRatioContainer object instances.

Index

• type Advanced
• type AlignmentMode
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AlignmentHorizontal() gdclass.AspectRatioContainerAlignmentMode
  • func (self Instance) AlignmentVertical() gdclass.AspectRatioContainerAlignmentMode
  • 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) Ratio() Float.X
  • func (self Instance) SetAlignmentHorizontal(value gdclass.AspectRatioContainerAlignmentMode)
  • func (self Instance) SetAlignmentVertical(value gdclass.AspectRatioContainerAlignmentMode)
  • func (self Instance) SetRatio(value Float.X)
  • func (self Instance) SetStretchMode(value gdclass.AspectRatioContainerStretchMode)
  • func (self Instance) StretchMode() gdclass.AspectRatioContainerStretchMode
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type StretchMode

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 = gdclass.AspectRatioContainerAlignmentMode //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 Instance

type Instance [1]gdclass.AspectRatioContainer

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.

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() gdclass.AspectRatioContainerAlignmentMode

func (Instance) AlignmentVertical

func (self Instance) AlignmentVertical() gdclass.AspectRatioContainerAlignmentMode

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

func (self Instance) Ratio() Float.X

func (Instance) SetAlignmentHorizontal

func (self Instance) SetAlignmentHorizontal(value gdclass.AspectRatioContainerAlignmentMode)

func (Instance) SetAlignmentVertical

func (self Instance) SetAlignmentVertical(value gdclass.AspectRatioContainerAlignmentMode)

func (Instance) SetRatio

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

func (Instance) SetStretchMode

func (self Instance) SetStretchMode(value gdclass.AspectRatioContainerStretchMode)

func (Instance) StretchMode

func (self Instance) StretchMode() gdclass.AspectRatioContainerStretchMode

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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

type StretchMode

type StretchMode = gdclass.AspectRatioContainerStretchMode //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 [member Control.clip_contents] is enabled, this allows to show only the container's area restricted by its own bounding rectangle.*/
	StretchCover StretchMode = 3
)