Class BabylonGuiControl

What every GUI control shares, whatever its kind: padding, alignment inside its parent, size, color, font size, visibility, the enabled and read-only states and cloning. Sizes are pixel strings such as 200px or fractions of the parent from 0 to 1. The setters change the control in place and give it back so calls can be chained.

Index

Constructors

constructor

new BabylonGuiControl(): BabylonGuiControl
Returns BabylonGuiControl

create

cloneControl

cloneControl(inputs: CloneControlDto): Control
Makes a copy of a control with all its settings, names it and adds it to container when one is given; host is the GUI texture the copy belongs to.
Parameters
- inputs: CloneControlDto
  The control, the optional container, the name and the optional host texture
Returns Control
The copy
Example
```
const second = bitbybit.babylon.gui.control.cloneControl({ control: button, container: panel, name: "second", host: ui });
```
- Defined in bitbybit-docs.d.ts:49041

createControlObservableSelector

createControlObservableSelector(
inputs: ControlObservableSelectorDto,
): controlObservableSelectorEnum
Passes through the name of a control event, such as a pointer click or pointer enter, as a typed selector for code that subscribes to control events by name.
Parameters
- inputs: ControlObservableSelectorDto
  The event selector
Returns controlObservableSelectorEnum
The same selector
Example
```
const selector = bitbybit.babylon.gui.control.createControlObservableSelector({ selector: Bit.Inputs.BabylonGui.controlObservableSelectorEnum.onPointerClickObservable });
```
- Defined in bitbybit-docs.d.ts:49054

get

getControlByName

getControlByName(inputs: GetControlByNameDto): Control
Finds a control by its name inside a container, searching its children too.
Parameters
- inputs: GetControlByNameDto
  The container and the name
Returns Control
The control with that name
Example
```
const button = bitbybit.babylon.gui.control.getControlByName({ container: panel, name: "buttonName" });
```
- Defined in bitbybit-docs.d.ts:49066

getHeight

getHeight(inputs: ControlDto): string | number
Reads the height of a control, as a pixel string or a fraction of the parent.
Parameters
- inputs: ControlDto
  The control
Returns string | number
The height
- Defined in bitbybit-docs.d.ts:49134

getWidth

getWidth(inputs: ControlDto): string | number
Reads the width of a control, as a pixel string or a fraction of the parent.
Parameters
- inputs: ControlDto
  The control
Returns string | number
The width
- Defined in bitbybit-docs.d.ts:49142

getColor

getColor(inputs: ControlDto): string
Reads the main color of a control as a CSS color string.
Parameters
- inputs: ControlDto
  The control
Returns string
The color
- Defined in bitbybit-docs.d.ts:49150

getFontSize

getFontSize(inputs: ControlDto): string | number
Reads the font size of a control's text, as a string such as 24px or a number of pixels.
Parameters
- inputs: ControlDto
  The control
Returns string | number
The font size
- Defined in bitbybit-docs.d.ts:49158

getIsVisible

getIsVisible(inputs: ControlDto): boolean
Reads whether a control is shown rather than hidden.
Parameters
- inputs: ControlDto
  The control
Returns boolean
True when the control is visible
- Defined in bitbybit-docs.d.ts:49166

getIsReadonly

getIsReadonly(inputs: ControlDto): boolean
Reads whether a control ignores input while still being shown normally.
Parameters
- inputs: ControlDto
  The control
Returns boolean
True when the control is read-only
- Defined in bitbybit-docs.d.ts:49174

getIsEnabled

getIsEnabled(inputs: ControlDto): boolean
Reads whether a control is enabled rather than dimmed and inactive.
Parameters
- inputs: ControlDto
  The control
Returns boolean
True when the control is enabled
- Defined in bitbybit-docs.d.ts:49182

positioning

changeControlPadding

changeControlPadding(inputs: PaddingLeftRightTopBottomDto): Control
Sets the space kept clear around a control inside its parent, per side; a side left out keeps its padding. Values are pixel strings such as 10px or fractions of the parent.
Parameters
- inputs: PaddingLeftRightTopBottomDto
  The control and the four paddings
Returns Control
The same control
Example
```
bitbybit.babylon.gui.control.changeControlPadding({ control: button, paddingLeft: "10px", paddingRight: "10px", paddingTop: "4px", paddingBottom: "4px" });
```
- Defined in bitbybit-docs.d.ts:49014

changeControlAlignment

changeControlAlignment(inputs: AlignmentDto<Control>): Control
Sets where a control sits inside its parent: left, center or right, and top, center or bottom.
Parameters
- inputs: AlignmentDto<Control>
  The control and the two alignments
Returns Control
The same control
Example
```
bitbybit.babylon.gui.control.changeControlAlignment({ control: panel, horizontalAlignment: Bit.Inputs.BabylonGui.horizontalAlignmentEnum.left, verticalAlignment: Bit.Inputs.BabylonGui.verticalAlignmentEnum.top });
```
- Defined in bitbybit-docs.d.ts:49027

set

setIsVisible

setIsVisible(inputs: SetControlIsVisibleDto): Control
Shows or hides a control; a hidden control keeps its place in a stack panel's layout.
Parameters
- inputs: SetControlIsVisibleDto
  The control and the flag
Returns Control
The same control
- Defined in bitbybit-docs.d.ts:49074

setIsReadonly

setIsReadonly(inputs: SetControlIsReadonlyDto): Control
Makes a control read-only or editable again; a read-only control is shown normally but ignores input.
Parameters
- inputs: SetControlIsReadonlyDto
  The control and the flag
Returns Control
The same control
- Defined in bitbybit-docs.d.ts:49083

setIsEnabled

setIsEnabled(inputs: SetControlIsEnabledDto): Control
Enables or disables a control; a disabled control is drawn dimmed and ignores input.
Parameters
- inputs: SetControlIsEnabledDto
  The control and the flag
Returns Control
The same control
- Defined in bitbybit-docs.d.ts:49091

setHeight

setHeight(inputs: SetControlHeightDto): Control
Sets the height of a control, as a pixel string such as 40px or a fraction of the parent from 0 to 1.
Parameters
- inputs: SetControlHeightDto
  The control and the height
Returns Control
The same control
- Defined in bitbybit-docs.d.ts:49100

setWidth

setWidth(inputs: SetControlWidthDto): Control
Sets the width of a control, as a pixel string such as 200px or a fraction of the parent from 0 to 1.
Parameters
- inputs: SetControlWidthDto
  The control and the width
Returns Control
The same control
- Defined in bitbybit-docs.d.ts:49109

setColor

setColor(inputs: SetControlColorDto): Control
Sets the main color of a control, the text color of a button or text block and the fill color of a slider or checkbox, as a CSS color.
Parameters
- inputs: SetControlColorDto
  The control and the color
Returns Control
The same control
- Defined in bitbybit-docs.d.ts:49118

setFontSize

setFontSize(inputs: SetControlFontSizeDto): Control
Sets the font size of a control's text, as a number of pixels or a string such as 24px.
Parameters
- inputs: SetControlFontSizeDto
  The control and the font size
Returns Control
The same control
- Defined in bitbybit-docs.d.ts:49126

Class BabylonGuiControl

Index

Constructors

create

get

positioning

set

Constructors

constructor

Returns BabylonGuiControl

create

cloneControl

Parameters

Returns Control

Example

createControlObservableSelector

Parameters

Returns controlObservableSelectorEnum

Example

get

getControlByName

Parameters

Returns Control

Example

getHeight

Parameters

Returns string | number

getWidth

Parameters

Returns string | number

getColor

Parameters

Returns string

getFontSize

Parameters

Returns string | number

getIsVisible

Parameters

Returns boolean

getIsReadonly

Parameters

Returns boolean

getIsEnabled

Parameters

Returns boolean

positioning

changeControlPadding

Parameters

Returns Control

Example

changeControlAlignment

Parameters

Returns Control

Example

set

setIsVisible

Parameters

Returns Control

setIsReadonly

Parameters

Returns Control

setIsEnabled

Parameters

Returns Control

setHeight

Parameters

Returns Control

setWidth

Parameters

Returns Control

setColor

Parameters

Returns Control

setFontSize

Parameters

Returns Control

Settings

On This Page