StackPanel | Babylon.js API documentation

Class StackPanel

Class used to create a 2D stack panel container

Hierarchy (View Summary)

Container
- StackPanel
  - VirtualKeyboard

Index

Constructors

Accessors

accessibilityTag adaptHeightToChildren adaptWidthToChildren alpha background backgroundGradient centerX centerY children clipChildren clipContent color descendantsOnlyPadding disabledColor disabledColorItem fixedRatio fixedRatioMasterIsWidth focusedColor fontFamily fontOffset fontSize fontSizeInPixels fontStyle fontWeight gradient height heightInPixels highlightColor highlightLineWidth horizontalAlignment host isDirty isEnabled isHighlighted isReadOnly isVertical isVisible left leftInPixels linkedMesh linkOffsetX linkOffsetXInPixels linkOffsetY linkOffsetYInPixels notRenderable paddingBottom paddingBottomInPixels paddingLeft paddingLeftInPixels paddingRight paddingRightInPixels paddingTop paddingTopInPixels renderToIntermediateTexture rotation scaleX scaleY shadowBlur shadowColor shadowOffsetX shadowOffsetY spacing style top topInPixels transformCenterX transformCenterY transformedMeasure typeName verticalAlignment width widthInPixels zIndex HORIZONTAL_ALIGNMENT_CENTER HORIZONTAL_ALIGNMENT_LEFT HORIZONTAL_ALIGNMENT_RIGHT VERTICAL_ALIGNMENT_BOTTOM VERTICAL_ALIGNMENT_CENTER VERTICAL_ALIGNMENT_TOP

Constructors

constructor

new StackPanel(name?: string): StackPanel
Creates a new StackPanel
Parameters
- Optionalname: string
  defines control name
Returns StackPanel
Overrides Container.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151287

Properties

animations

animations: Nullable<Animation[]>

Array of animations

delegatePickingToChildren

delegatePickingToChildren: boolean

Gets or sets a boolean indicating that the container will let internal controls handle picking instead of doing it directly using its bounding info

hoverCursor

hoverCursor: string

Gets or sets the cursor to use when the control is hovered

ignoreLayoutWarnings

ignoreLayoutWarnings: boolean

Gets or sets a boolean indicating that layout warnings should be ignored

isFocusInvisible

isFocusInvisible: boolean

Gets or sets a boolean indicating if the control can be focusable

isHitTestVisible

isHitTestVisible: boolean

Gets or sets a boolean indicating if the control can be hit with pointer events

isPointerBlocker

isPointerBlocker: boolean

Gets or sets a boolean indicating if the control can block pointer events. False by default except on the following controls:

Button controls (Button, RadioButton, ToggleButton)
Checkbox
ColorPicker
InputText
Slider

isSerializable

isSerializable: boolean

Indicates if the control should be serialized. Defaults to true.

logLayoutCycleErrors

logLayoutCycleErrors: boolean

Gets or sets a boolean indicating that layout cycle errors should be displayed on the console

maxLayoutCycle

maxLayoutCycle: number

Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed

metadata

metadata: any

Gets or sets an object used to store user defined information for the node

`Optional`name

name?: string

defines the name of the control

onAccessibilityTagChangedObservable

onAccessibilityTagChangedObservable: Observable<Nullable<IAccessibilityTag>>

BABYLON.Observable that fires whenever the accessibility event of the control has changed

onAfterDrawObservable

onAfterDrawObservable: Observable<Control>

An event triggered after the control was drawn

onBeforeDrawObservable

onBeforeDrawObservable: Observable<Control>

An event triggered before drawing the control

onBlurObservable

onBlurObservable: Observable<Control>

BABYLON.Observable raised when the control loses the focus

onControlAddedObservable

onControlAddedObservable: Observable<Nullable<Control>>

An event triggered when any control is added to this container.

onControlRemovedObservable

onControlRemovedObservable: Observable<Nullable<Control>>

An event triggered when any control is removed from this container.

onDirtyObservable

onDirtyObservable: Observable<Control>

An event triggered when the control is marked as dirty

onDisposeObservable

onDisposeObservable: Observable<Control>

An event triggered when the control has been disposed

onEnabledStateChangedObservable

onEnabledStateChangedObservable: Observable<boolean>

BABYLON.Observable that fires when the control's enabled state changes

onEnterPressedObservable

onEnterPressedObservable: Observable<Control>

An event triggered when a control receives an ENTER key down event

onFocusObservable

onFocusObservable: Observable<Control>

BABYLON.Observable raised when the control gets the focus

onIsVisibleChangedObservable

onIsVisibleChangedObservable: Observable<boolean>

An event triggered when the control isVisible is changed

onKeyboardEventProcessedObservable

onKeyboardEventProcessedObservable: Observable<IKeyboardEvent>

BABYLON.Observable raised when a key event was processed

onPointerClickObservable

onPointerClickObservable: Observable<Vector2WithInfo>

An event triggered when a control is clicked on

onPointerDownObservable

onPointerDownObservable: Observable<Vector2WithInfo>

An event triggered when the pointer taps the control

onPointerEnterObservable

onPointerEnterObservable: Observable<Control>

An event triggered when pointer enters the control

onPointerMoveObservable

onPointerMoveObservable: Observable<Vector2>

An event triggered when the pointer moves over the control.

onPointerOutObservable

onPointerOutObservable: Observable<Control>

An event triggered when the pointer moves out of the control.

onPointerUpObservable

onPointerUpObservable: Observable<Vector2WithInfo>

An event triggered when pointer up

onWheelObservable

onWheelObservable: Observable<Vector2>

An event triggered when pointer wheel is scrolled

`Optional`overlapDeltaMultiplier

overlapDeltaMultiplier?: number

Gets/sets the deoverlap movement multiplier

`Optional`overlapGroup

overlapGroup?: number

Gets/sets the overlap group of the control. Controls with overlapGroup set to a number can be deoverlapped. Controls with overlapGroup set to undefined are not deoverlapped.

See

https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#deoverlapping

parent

parent: Nullable<Container>

Gets or sets the control parent

tabIndex

tabIndex: number

The tab index of this control. -1 indicates this control is not part of the tab navigation. A positive value indicates the order of the control in the tab navigation. A value of 0 indicated the control will be focused after all controls with a positive index. More than one control can have the same tab index and the navigation would then go through all controls with the same value in an order defined by the layout or the hierarchy. The value can be changed at any time.

See

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex

uniqueId

uniqueId: number

Gets or sets the unique id of the node. Please note that this number will be updated when the control is added to a container

useBitmapCache

useBitmapCache: boolean

Gets or sets a boolean indicating that the current control should cache its rendering (useful when the control does not change often)

`Static`AddHeader

AddHeader: (
    control: Control,
    text: string,
    size: string | number,
    options: { controlFirst: boolean; isHorizontal: boolean },
) => any

`Static`AllowAlphaInheritance

AllowAlphaInheritance: boolean

Gets or sets a boolean indicating if alpha must be an inherited value (false by default)

Accessors

accessibilityTag

get accessibilityTag(): Nullable<IAccessibilityTag>
Returns Nullable<IAccessibilityTag>
Inherited from Container.accessibilityTag
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152808
set accessibilityTag(value: Nullable<IAccessibilityTag>): void
Gets or sets the accessibility tag to describe the control for accessibility purpose. By default, GUI controls already indicate accessibility info, but one can override the info using this tag.
Parameters
- value: Nullable<IAccessibilityTag>
Returns void
Inherited from Container.accessibilityTag
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152807

adaptHeightToChildren

get adaptHeightToChildren(): boolean
Gets or sets a boolean indicating if the container should try to adapt to its children height

Returns boolean
Inherited from Container.adaptHeightToChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153575
set adaptHeightToChildren(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.adaptHeightToChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153576

adaptWidthToChildren

get adaptWidthToChildren(): boolean
Gets or sets a boolean indicating if the container should try to adapt to its children width

Returns boolean
Inherited from Container.adaptWidthToChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153578
set adaptWidthToChildren(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.adaptWidthToChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153579

alpha

get alpha(): number
Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent)

Returns number
Inherited from Container.alpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152882
set alpha(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.alpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152883

background

get background(): string
Gets or sets background color

Returns string
Inherited from Container.background
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153581
set background(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.background
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153582

backgroundGradient

get backgroundGradient(): Nullable<BaseGradient>
Gets or sets background gradient color. Takes precedence over background

Returns Nullable<BaseGradient>
Inherited from Container.backgroundGradient
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153584
set backgroundGradient(value: Nullable<BaseGradient>): void
Parameters
- value: Nullable<BaseGradient>
Returns void
Inherited from Container.backgroundGradient
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153585

centerX

get centerX(): number
Gets the center coordinate on X axis

Returns number
Inherited from Container.centerX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153135

centerY

get centerY(): number
Gets the center coordinate on Y axis

Returns number
Inherited from Container.centerY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153137

children

get children(): Control[]
Gets the list of children

Returns Control[]
Inherited from Container.children
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153587

clipChildren

get clipChildren(): boolean
Returns boolean
Inherited from Container.clipChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152760
set clipChildren(value: boolean): void
Sets/Gets a boolean indicating if the children are clipped to the current control bounds. Please note that not clipping children may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
Parameters
- value: boolean
Returns void
Inherited from Container.clipChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152759

clipContent

get clipContent(): boolean
Returns boolean
Inherited from Container.clipContent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152767
set clipContent(value: boolean): void
Sets/Gets a boolean indicating that control content must be clipped Please note that not clipping content may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
Parameters
- value: boolean
Returns void
Inherited from Container.clipContent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152766

color

get color(): string
Gets or sets foreground color

Returns string
Inherited from Container.color
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153004
set color(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.color
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153005

descendantsOnlyPadding

get descendantsOnlyPadding(): boolean
Gets or sets a value indicating the padding should work like in CSS. Basically, it will add the padding amount on each side of the parent control for its children.

Returns boolean
Inherited from Container.descendantsOnlyPadding
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153028
set descendantsOnlyPadding(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.descendantsOnlyPadding
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153029

disabledColor

get disabledColor(): string
Gets or sets background color of control if it's disabled. Only applies to Button class.

Returns string
Inherited from Container.disabledColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153142
set disabledColor(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.disabledColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153143

disabledColorItem

get disabledColorItem(): string
Gets or sets front color of control if it's disabled. Only applies to Checkbox class.

Returns string
Inherited from Container.disabledColorItem
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153145
set disabledColorItem(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.disabledColorItem
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153146

fixedRatio

get fixedRatio(): number
Gets or sets a fixed ratio for this control. When different from 0, the ratio is used to compute the "second" dimension. The first dimension used in the computation is the last one set (by setting width / widthInPixels or height / heightInPixels), and the second dimension is computed as first dimension * fixedRatio

Returns number
Inherited from Container.fixedRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152948
set fixedRatio(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.fixedRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152941

fixedRatioMasterIsWidth

get fixedRatioMasterIsWidth(): boolean
Gets or sets a boolean indicating that the fixed ratio is set on the width instead of the height. True by default. When the height of a control is set, this property is changed to false.

Returns boolean
Inherited from Container.fixedRatioMasterIsWidth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152955
set fixedRatioMasterIsWidth(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.fixedRatioMasterIsWidth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152950

focusedColor

get focusedColor(): Nullable<string>
Border color when control is focused When not defined the ADT color will be used. If no ADT color is defined, focused state won't have any border

Returns Nullable<string>
Inherited from Container.focusedColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153167
set focusedColor(value: Nullable<string>): void
Parameters
- value: Nullable<string>
Returns void
Inherited from Container.focusedColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153168

fontFamily

get fontFamily(): string
Gets or set font family

Returns string
Inherited from Container.fontFamily
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152981
set fontFamily(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.fontFamily
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152982

fontOffset

get fontOffset(): { ascent: number; descent: number; height: number }
Gets or set information about font offsets (used to render and align text)

Returns { ascent: number; descent: number; height: number }
Inherited from Container.fontOffset
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152871
set fontOffset(
offset: { ascent: number; descent: number; height: number },
): void
Parameters
- offset: { ascent: number; descent: number; height: number }
Returns void
Inherited from Container.fontOffset
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152876

get fontSize(): string | number
Gets or sets font size

Returns string | number
Inherited from Container.fontSize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153001
set fontSize(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.fontSize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153002

fontSizeInPixels

get fontSizeInPixels(): number
Gets or sets font size in pixels

Returns number
Inherited from Container.fontSizeInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152998
set fontSizeInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.fontSizeInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152999

fontStyle

get fontStyle(): string
Gets or sets font style

Returns string
Inherited from Container.fontStyle
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152984
set fontStyle(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.fontStyle
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152985

fontWeight

get fontWeight(): string
Gets or sets font weight

Returns string
Inherited from Container.fontWeight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152987
set fontWeight(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.fontWeight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152988

gradient

get gradient(): Nullable<BaseGradient>
Gets or sets gradient. Setting a gradient will override the color

Returns Nullable<BaseGradient>
Inherited from Container.gradient
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153007
set gradient(value: Nullable<BaseGradient>): void
Parameters
- value: Nullable<BaseGradient>
Returns void
Inherited from Container.gradient
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153008

height

get height(): string | number
Gets or sets control height

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Overrides Container.height
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151282
set height(value: string | number): void
Gets or sets panel height. This value should not be set when in vertical mode as it will be computed automatically
Parameters
- value: string | number
Returns void
Overrides Container.height
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151281

heightInPixels

get heightInPixels(): number
Gets or sets control height in pixel

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.heightInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152978
set heightInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.heightInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152979

highlightColor

get highlightColor(): string
Gets or sets a string defining the color to use for highlighting this control

Returns string
Inherited from Container.highlightColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152901
set highlightColor(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.highlightColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152902

highlightLineWidth

get highlightLineWidth(): number
Gets or sets a number indicating size of stroke we want to highlight the control with (mostly for debugging purpose)

Returns number
Inherited from Container.highlightLineWidth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152887
set highlightLineWidth(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.highlightLineWidth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152888

horizontalAlignment

get horizontalAlignment(): number
Gets or sets the horizontal alignment

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#alignments
Inherited from Container.horizontalAlignment
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152932
set horizontalAlignment(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.horizontalAlignment
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152933

host

get host(): AdvancedDynamicTexture
Get the hosting AdvancedDynamicTexture

Returns AdvancedDynamicTexture
Inherited from Container.host
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152869

isDirty

get isDirty(): boolean
Gets a boolean indicating that the control needs to update its rendering

Returns boolean
Inherited from Container.isDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153019

isEnabled

get isEnabled(): boolean
Gets or sets if control is Enabled

Returns boolean
Inherited from Container.isEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153139
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.isEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153140

isHighlighted

get isHighlighted(): boolean
Gets or sets a boolean indicating that we want to highlight the control (mostly for debugging purpose)

Returns boolean
Inherited from Container.isHighlighted
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152892
set isHighlighted(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.isHighlighted
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152893

isReadOnly

get isReadOnly(): boolean
Gets or sets a boolean indicating if the control is readonly (default: false). A readonly control will still raise pointer events but will not react to them

Returns boolean
Inherited from Container.isReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153588
set isReadOnly(value: boolean): void
Gets or sets a boolean indicating if the control is readonly (default: false). A readonly control will still raise pointer events but will not react to them
Parameters
- value: boolean
Returns void
Inherited from Container.isReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153589

isVertical

get isVertical(): boolean
Gets or sets a boolean indicating if the stack panel is vertical or horizontal

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151264
set isVertical(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151265

isVisible

get isVisible(): boolean
Gets or sets a boolean indicating if the control is visible

Returns boolean
Inherited from Container.isVisible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153016
set isVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.isVisible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153017

left

get left(): string | number
Gets or sets a value indicating the left coordinate of the control

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.left
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153090
set left(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.left
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153091

leftInPixels

get leftInPixels(): number
Gets or sets a value indicating the left coordinate in pixels of the control

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.leftInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153096
set leftInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.leftInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153097

linkedMesh

get linkedMesh(): Nullable<TransformNode>
Gets the current linked mesh (or null if none)

Returns Nullable<TransformNode>
Inherited from Container.linkedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153023

linkOffsetX

get linkOffsetX(): string | number
Gets or sets a value indicating the offset on X axis to the linked mesh

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
Inherited from Container.linkOffsetX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153114
set linkOffsetX(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.linkOffsetX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153115

linkOffsetXInPixels

get linkOffsetXInPixels(): number
Gets or sets a value indicating the offset in pixels on X axis to the linked mesh

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
Inherited from Container.linkOffsetXInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153120
set linkOffsetXInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.linkOffsetXInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153121

linkOffsetY

get linkOffsetY(): string | number
Gets or sets a value indicating the offset on Y axis to the linked mesh

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
Inherited from Container.linkOffsetY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153126
set linkOffsetY(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.linkOffsetY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153127

linkOffsetYInPixels

get linkOffsetYInPixels(): number
Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
Inherited from Container.linkOffsetYInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153132
set linkOffsetYInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.linkOffsetYInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153133

notRenderable

get notRenderable(): boolean
Gets or sets a boolean indicating if the control can be rendered

Returns boolean
Inherited from Container.notRenderable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153013
set notRenderable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.notRenderable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153014

paddingBottom

get paddingBottom(): string | number
Gets or sets a value indicating the padding to use on the bottom of the control

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingBottom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153076
set paddingBottom(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.paddingBottom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153077

paddingBottomInPixels

get paddingBottomInPixels(): number
Gets or sets a value indicating the padding in pixels to use on the bottom of the control

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingBottomInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153082
set paddingBottomInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.paddingBottomInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153083

paddingLeft

get paddingLeft(): string | number
Gets or sets a value indicating the padding to use on the left of the control

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingLeft
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153034
set paddingLeft(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.paddingLeft
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153035

paddingLeftInPixels

get paddingLeftInPixels(): number
Gets or sets a value indicating the padding in pixels to use on the left of the control

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingLeftInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153040
set paddingLeftInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.paddingLeftInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153041

paddingRight

get paddingRight(): string | number
Gets or sets a value indicating the padding to use on the right of the control

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingRight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153048
set paddingRight(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.paddingRight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153049

paddingRightInPixels

get paddingRightInPixels(): number
Gets or sets a value indicating the padding in pixels to use on the right of the control

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingRightInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153054
set paddingRightInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.paddingRightInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153055

paddingTop

get paddingTop(): string | number
Gets or sets a value indicating the padding to use on the top of the control

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingTop
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153062
set paddingTop(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.paddingTop
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153063

paddingTopInPixels

get paddingTopInPixels(): number
Gets or sets a value indicating the padding in pixels to use on the top of the control

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.paddingTopInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153068
set paddingTopInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.paddingTopInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153069

renderToIntermediateTexture

get renderToIntermediateTexture(): boolean
Gets or sets boolean indicating if children should be rendered to an intermediate texture rather than directly to host, useful for alpha blending

Returns boolean
Inherited from Container.renderToIntermediateTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153564
set renderToIntermediateTexture(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Container.renderToIntermediateTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153565

rotation

get rotation(): number
Gets or sets the rotation angle (0 by default)

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
Inherited from Container.rotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152916
set rotation(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.rotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152917

scaleX

get scaleX(): number
Gets or sets a value indicating the scale factor on X axis (1 by default)

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
Inherited from Container.scaleX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152906
set scaleX(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.scaleX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152907

scaleY

get scaleY(): number
Gets or sets a value indicating the scale factor on Y axis (1 by default)

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
Inherited from Container.scaleY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152911
set scaleY(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.scaleY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152912

shadowBlur

get shadowBlur(): number
Gets or sets a value indicating the amount of blur to use to render the shadow

Returns number
Inherited from Container.shadowBlur
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152784
set shadowBlur(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.shadowBlur
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152785

shadowColor

get shadowColor(): string
Gets or sets a value indicating the color of the shadow (black by default ie. "#000")

Returns string
Inherited from Container.shadowColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152788
set shadowColor(value: string): void
Parameters
- value: string
Returns void
Inherited from Container.shadowColor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152789

shadowOffsetX

get shadowOffsetX(): number
Gets or sets a value indicating the offset to apply on X axis to render the shadow

Returns number
Inherited from Container.shadowOffsetX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152775
set shadowOffsetX(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.shadowOffsetX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152776

shadowOffsetY

get shadowOffsetY(): number
Gets or sets a value indicating the offset to apply on Y axis to render the shadow

Returns number
Inherited from Container.shadowOffsetY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152779
set shadowOffsetY(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.shadowOffsetY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152780

spacing

get spacing(): number
Gets or sets the spacing (in pixels) between each child.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151269
set spacing(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151270

style

get style(): Nullable<Style>
Gets or sets style

Returns Nullable<Style>
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#styles
Inherited from Container.style
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152993
set style(value: Nullable<Style>): void
Parameters
- value: Nullable<Style>
Returns void
Inherited from Container.style
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152994

top

get top(): string | number
Gets or sets a value indicating the top coordinate of the control

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.top
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153102
set top(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from Container.top
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153103

topInPixels

get topInPixels(): number
Gets or sets a value indicating the top coordinate in pixels of the control

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.topInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153108
set topInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.topInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153109

transformCenterX

get transformCenterX(): number
Gets or sets the transformation center on X axis (0 by default)

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
Inherited from Container.transformCenterX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152926
set transformCenterX(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.transformCenterX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152927

transformCenterY

get transformCenterY(): number
Gets or sets the transformation center on Y axis (0 by default)

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
Inherited from Container.transformCenterY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152921
set transformCenterY(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.transformCenterY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152922

transformedMeasure

get transformedMeasure(): Measure
Gets the transformed measure, that is the bounding box of the control after applying all transformations

Returns Measure
Inherited from Container.transformedMeasure
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152737

typeName

get typeName(): string
Gets the control type name

Returns string
Inherited from Container.typeName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152797

verticalAlignment

get verticalAlignment(): number
Gets or sets the vertical alignment

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#alignments
Inherited from Container.verticalAlignment
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152938
set verticalAlignment(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.verticalAlignment
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152939

width

get width(): string | number
Gets or sets control width

Returns string | number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Overrides Container.width
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151276
set width(value: string | number): void
Gets or sets panel width. This value should not be set when in horizontal mode as it will be computed automatically
Parameters
- value: string | number
Returns void
Overrides Container.width
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151275

widthInPixels

get widthInPixels(): number
Gets or sets the control width in pixel

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.widthInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152966
set widthInPixels(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.widthInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152967

zIndex

get zIndex(): number
Gets or sets z index which is used to reorder controls on the z axis

Returns number
Inherited from Container.zIndex
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153010
set zIndex(value: number): void
Parameters
- value: number
Returns void
Inherited from Container.zIndex
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153011

`Static`HORIZONTAL_ALIGNMENT_CENTER

get HORIZONTAL_ALIGNMENT_CENTER(): number
HORIZONTAL_ALIGNMENT_CENTER

Returns number
Inherited from Container.HORIZONTAL_ALIGNMENT_CENTER
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153497

`Static`HORIZONTAL_ALIGNMENT_LEFT

get HORIZONTAL_ALIGNMENT_LEFT(): number
HORIZONTAL_ALIGNMENT_LEFT

Returns number
Inherited from Container.HORIZONTAL_ALIGNMENT_LEFT
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153493

`Static`HORIZONTAL_ALIGNMENT_RIGHT

get HORIZONTAL_ALIGNMENT_RIGHT(): number
HORIZONTAL_ALIGNMENT_RIGHT

Returns number
Inherited from Container.HORIZONTAL_ALIGNMENT_RIGHT
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153495

`Static`VERTICAL_ALIGNMENT_BOTTOM

get VERTICAL_ALIGNMENT_BOTTOM(): number
VERTICAL_ALIGNMENT_BOTTOM

Returns number
Inherited from Container.VERTICAL_ALIGNMENT_BOTTOM
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153501

`Static`VERTICAL_ALIGNMENT_CENTER

get VERTICAL_ALIGNMENT_CENTER(): number
VERTICAL_ALIGNMENT_CENTER

Returns number
Inherited from Container.VERTICAL_ALIGNMENT_CENTER
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153503

`Static`VERTICAL_ALIGNMENT_TOP

get VERTICAL_ALIGNMENT_TOP(): number
VERTICAL_ALIGNMENT_TOP

Returns number
Inherited from Container.VERTICAL_ALIGNMENT_TOP
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153499

Methods

_onPointerPick

_onPointerPick(
    target: Control,
    coordinates: Vector2,
    pointerId: number,
    buttonIndex: number,
    notifyClick: boolean,
    pi: Nullable<PointerInfoBase>,
): boolean
Parameters
- target: Control
- coordinates: Vector2
- pointerId: number
- buttonIndex: number
- notifyClick: boolean
- pi: Nullable<PointerInfoBase>
Returns boolean
Inherited from Container._onPointerPick
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153429

addControl

addControl(control: Nullable<Control>): Container
Adds a new control to the current container
Parameters
- control: Nullable<Control>
  defines the control to add
Returns Container
the current container
Inherited from Container.addControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153621

blur

blur(): void
Function to unfocus a button programmatically

Returns void
Inherited from Container.blur
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153202

clearControls

clearControls(): Container
Removes all controls from the current container

Returns Container
the current container
Inherited from Container.clearControls
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153626

clone

clone(host?: AdvancedDynamicTexture): Control
Clones a control and its descendants
Parameters
- Optionalhost: AdvancedDynamicTexture
  the texture where the control will be instantiated. Can be empty, in which case the control will be created on the same texture
Returns Control
the cloned control
Inherited from Container.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153464

contains

contains(x: number, y: number): boolean
Tests if a given coordinates belong to the current control
Parameters
- x: number
  defines x coordinate to test
- y: number
  defines y coordinate to test
Returns boolean
true if the coordinates are inside the control
Inherited from Container.contains
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153404

containsControl

containsControl(control: Control): boolean
Search for a specific control in children
Parameters
- control: Control
  defines the control to look for
Returns boolean
true if the control is in child list
Inherited from Container.containsControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153615

dispose

dispose(): void
Releases associated resources

Returns void
Inherited from Container.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153700

focus

focus(): void
Function to focus a button programmatically

Returns void
Inherited from Container.focus
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153198

getAscendantOfClass

getAscendantOfClass(className: string): Nullable<Control>
Gets the first ascendant in the hierarchy of the given type
Parameters
- className: string
  defines the required type
Returns Nullable<Control>
the ascendant or null if not found
Inherited from Container.getAscendantOfClass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153222

getChildByName

getChildByName(name: string): Nullable<Control>
Gets a child using its name
Parameters
- name: string
  defines the child name to look for
Returns Nullable<Control>
the child control if found
Inherited from Container.getChildByName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153602

getChildByType

getChildByType(name: string, type: string): Nullable<Control>
Gets a child using its type and its name
Parameters
- name: string
  defines the child name to look for
- type: string
  defines the child type to look for
Returns Nullable<Control>
the child control if found
Inherited from Container.getChildByType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153609

getClassName

getClassName(): string
Get the current class name of the control.

Returns string
current class name
Inherited from Container.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:152802

getDescendants

getDescendants(
directDescendantsOnly?: boolean,
predicate?: (control: Control) => boolean,
): Control[]
Will return all controls that have this control as ascendant
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (control: Control) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns Control[]
all child controls
Inherited from Container.getDescendants
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153278

getDescendantsToRef

getDescendantsToRef(
    results: Control[],
    directDescendantsOnly?: boolean,
    predicate?: (control: Control) => boolean,
): void
Will store all controls that have this control as ascendant in a given array
Parameters
- results: Control[]
  defines the array where to store the descendants
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (control: Control) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns void
Inherited from Container.getDescendantsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153681

getDimension

getDimension(dim: "width" | "height"): ValueAndUnit
Gets the dimension of the control along a specified axis
Parameters
- dim: "width" | "height"
  the dimension to retrieve (width or height)
Returns ValueAndUnit
the dimension value along the specified axis
Inherited from Container.getDimension
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153458

getLocalCoordinates

getLocalCoordinates(globalCoordinates: Vector2): Vector2
Gets coordinates in local control space
Parameters
- globalCoordinates: Vector2
  defines the coordinates to transform
Returns Vector2
the new coordinates in local space
Inherited from Container.getLocalCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153245

getLocalCoordinatesToRef

getLocalCoordinatesToRef(globalCoordinates: Vector2, result: Vector2): Control
Gets coordinates in local control space
Parameters
- globalCoordinates: Vector2
  defines the coordinates to transform
- result: Vector2
  defines the target vector2 where to store the result
Returns Control
the current control
Inherited from Container.getLocalCoordinatesToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153252

getParentLocalCoordinates

getParentLocalCoordinates(globalCoordinates: Vector2): Vector2
Gets coordinates in parent local control space
Parameters
- globalCoordinates: Vector2
  defines the coordinates to transform
Returns Vector2
the new coordinates in parent local space
Inherited from Container.getParentLocalCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153258

isAscendant

isAscendant(container: Control): boolean
Determines if a container is an ascendant of the current control
Parameters
- container: Control
  defines the container to look for
Returns boolean
true if the container is one of the ascendant of the control
Inherited from Container.isAscendant
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153239

isDimensionFullyDefined

isDimensionFullyDefined(dim: "width" | "height"): boolean
A control has a dimension fully defined if that dimension doesn't depend on the parent's dimension. As an example, a control that has dimensions in pixels is fully defined, while in percentage is not fully defined.
Parameters
- dim: "width" | "height"
  the dimension to check (width or height)
Returns boolean
if the dimension is fully defined
Overrides Container.isDimensionFullyDefined
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151296

isReady

isReady(): boolean
Returns true if the control is ready to be used

Returns boolean
Inherited from Container.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153705

keepsFocusWith

keepsFocusWith(): Nullable<Control[]>
Function called to get the list of controls that should not steal the focus from this control

Returns Nullable<Control[]>
an array of controls
Inherited from Container.keepsFocusWith
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153194

linkWithMesh

linkWithMesh(mesh: Nullable<TransformNode>): void
Link current control with a target mesh
Parameters
- mesh: Nullable<TransformNode>
  defines the mesh to link with
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
Inherited from Container.linkWithMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153284

markAllAsDirty

markAllAsDirty(): void
Mark the element and its children as dirty

Returns void
Inherited from Container.markAllAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153231

markAsDirty

markAsDirty(force?: boolean): void
Mark control element as dirty
Parameters
- Optionalforce: boolean
  force non visible elements to be marked too
Returns void
Inherited from Container.markAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153227

moveToVector3

moveToVector3(position: Vector3, scene: Scene): void
Move the current control to a vector3 position projected onto the screen.
Parameters
- position: Vector3
  defines the target position
- scene: Scene
  defines the hosting scene
Returns void
Inherited from Container.moveToVector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153264

parse

parse(
    serializedObject: any,
    host?: AdvancedDynamicTexture,
    urlRewriter?: (url: string) => string,
): Control
Parses a serialized object into this control
Parameters
- serializedObject: any
  the object with the serialized properties
- Optionalhost: AdvancedDynamicTexture
  the texture where the control will be instantiated. Can be empty, in which case the control will be created on the same texture
- OptionalurlRewriter: (url: string) => string
  defines an url rewriter to update urls before sending them to the controls
Returns Control
this control
Inherited from Container.parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153472

processKeyboard

processKeyboard(evt: IKeyboardEvent): void
Handles the keyboard event
Parameters
- evt: IKeyboardEvent
  Defines the KeyboardEvent
Returns void
Inherited from Container.processKeyboard
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153207

removeControl

removeControl(control: Control): Container
Removes a control from the current container
Parameters
- control: Control
  defines the control to remove
Returns Container
the current container
Inherited from Container.removeControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153632

serialize

serialize(serializationObject: any, force: boolean, allowCanvas: boolean): void
Serializes the current control
Parameters
- serializationObject: any
  defined the JSON serialized object
- force: boolean
  force serialization even if isSerializable === false
- allowCanvas: boolean
  defines if the control is allowed to use a Canvas2D object to serialize
Returns void
Overrides Container.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151303

setPadding

setPadding(
    paddingTop: string | number,
    paddingRight?: string | number,
    paddingBottom?: string | number,
    paddingLeft?: string | number,
): void
Shorthand function to set the top, right, bottom, and left padding values on the control.
Parameters
- paddingTop: string | number
  The value of the top padding.
- OptionalpaddingRight: string | number
  The value of the right padding. If omitted, top is used.
- OptionalpaddingBottom: string | number
  The value of the bottom padding. If omitted, top is used.
- OptionalpaddingLeft: string | number
  The value of the left padding. If omitted, right is used.
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.setPadding
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153293

setPaddingInPixels

setPaddingInPixels(
    paddingTop: number,
    paddingRight?: number,
    paddingBottom?: number,
    paddingLeft?: number,
): void
Shorthand funtion to set the top, right, bottom, and left padding values in pixels on the control.
Parameters
- paddingTop: number
  The value in pixels of the top padding.
- OptionalpaddingRight: number
  The value in pixels of the right padding. If omitted, top is used.
- OptionalpaddingBottom: number
  The value in pixels of the bottom padding. If omitted, top is used.
- OptionalpaddingLeft: number
  The value in pixels of the left padding. If omitted, right is used.
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
Inherited from Container.setPaddingInPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153302

`Static`Parse

Parse(
    serializedObject: any,
    host: AdvancedDynamicTexture,
    urlRewriter?: (url: string) => string,
): Control
Creates a Control from parsed data
Parameters
- serializedObject: any
  defines parsed data
- host: AdvancedDynamicTexture
  defines the hosting AdvancedDynamicTexture
- OptionalurlRewriter: (url: string) => string
  defines an url rewriter to update urls before sending them to the controls
Returns Control
a new Control
Inherited from Container.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:153520

Class StackPanel

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StackPanel

Properties

animations

delegatePickingToChildren

hoverCursor

ignoreLayoutWarnings

isFocusInvisible

isHitTestVisible

isPointerBlocker

isSerializable

logLayoutCycleErrors

maxLayoutCycle

metadata

Optionalname

onAccessibilityTagChangedObservable

onAfterDrawObservable

onBeforeDrawObservable

onBlurObservable

onControlAddedObservable

onControlRemovedObservable

onDirtyObservable

onDisposeObservable

onEnabledStateChangedObservable

onEnterPressedObservable

onFocusObservable

onIsVisibleChangedObservable

onKeyboardEventProcessedObservable

onPointerClickObservable

onPointerDownObservable

onPointerEnterObservable

onPointerMoveObservable

onPointerOutObservable

onPointerUpObservable

onWheelObservable

OptionaloverlapDeltaMultiplier

OptionaloverlapGroup

See

parent

tabIndex

See

uniqueId

useBitmapCache

StaticAddHeader

StaticAllowAlphaInheritance

Accessors

accessibilityTag

Returns Nullable<IAccessibilityTag>

Parameters

Returns void

adaptHeightToChildren

Returns boolean

Parameters

Returns void

adaptWidthToChildren

Returns boolean

Parameters

Returns void

alpha

Returns number

Parameters

Returns void

background

Returns string

Parameters

Returns void

backgroundGradient

Returns Nullable<BaseGradient>

Parameters

Returns void

centerX

`Optional`name

`Optional`overlapDeltaMultiplier

`Optional`overlapGroup

`Static`AddHeader

`Static`AllowAlphaInheritance