Bitbybit Docs
    Preparing search index...

    Class BabylonGuiControl

    每个 GUI 控件无论类型都共有的内容:内边距、在父级内的对齐、尺寸、颜色、字体大小、可见性、启用和只读状态以及克隆。尺寸是像素字符串(如 200px)或父级的 0 到 1 比例。设置器就地更改控件并将其返回,因此调用可以链式进行。

    Index

    Constructors

    create

    • 创建控件及其所有设置的副本,为其命名,并在给出 container 时将其添加到该容器;host 是副本所属的 GUI 纹理。

      Parameters

      • inputs: CloneControlDto

        控件、可选的容器、名称和可选的宿主纹理

      Returns Control

      副本

      const second = bitbybit.babylon.gui.control.cloneControl({ control: button, container: panel, name: "second", host: ui });
      
    • 将控件事件的名称(例如指针点击或指针进入)作为类型化的选择器传递,供按名称订阅控件事件的代码使用。

      Parameters

      Returns controlObservableSelectorEnum

      同一个选择器

      const selector = bitbybit.babylon.gui.control.createControlObservableSelector({ selector: Bit.Inputs.BabylonGui.controlObservableSelectorEnum.onPointerClickObservable });
      

    get

    • 在容器内按名称查找控件,也搜索其子级。

      Parameters

      Returns Control

      具有该名称的控件

      const button = bitbybit.babylon.gui.control.getControlByName({ container: panel, name: "buttonName" });
      
    • 读取控件的高度,以像素字符串或父级的分数表示。

      Parameters

      Returns string | number

      高度

    • 读取控件的宽度,以像素字符串或父级的分数表示。

      Parameters

      Returns string | number

      宽度

    • 以 CSS 颜色字符串读取控件的主颜色。

      Parameters

      Returns string

      颜色

    • 读取控件文本的字体大小,以字符串(例如 24px)或像素数表示。

      Parameters

      Returns string | number

      字体大小

    • 读取控件是显示而不是隐藏。

      Parameters

      Returns boolean

      当控件可见时为 true

    • 读取控件是否在正常显示的同时忽略输入。

      Parameters

      Returns boolean

      当控件为只读时为 true

    • 读取控件是启用而不是变暗且不活动。

      Parameters

      Returns boolean

      当控件已启用时为 true

    positioning

    • 按边设置控件在其父级内周围留出的空间;省略的边保留其内边距。值为像素字符串(例如 10px)或父级的分数。

      Parameters

      Returns Control

      同一个控件

      bitbybit.babylon.gui.control.changeControlPadding({ control: button, paddingLeft: "10px", paddingRight: "10px", paddingTop: "4px", paddingBottom: "4px" });
      
    • 设置控件在其父级内的位置:左、中或右,以及上、中或下。

      Parameters

      Returns Control

      同一个控件

      bitbybit.babylon.gui.control.changeControlAlignment({ control: panel, horizontalAlignment: Bit.Inputs.BabylonGui.horizontalAlignmentEnum.left, verticalAlignment: Bit.Inputs.BabylonGui.verticalAlignmentEnum.top });
      

    set

    • 显示或隐藏控件;隐藏的控件在堆叠面板的布局中保留其位置。

      Parameters

      Returns Control

      同一个控件

    • 使控件只读或恢复可编辑;只读控件正常显示但忽略输入。

      Parameters

      Returns Control

      同一个控件

    • 启用或禁用控件;禁用的控件绘制为变暗并忽略输入。

      Parameters

      Returns Control

      同一个控件

    • 设置控件的高度,以像素字符串(例如 40px)或父级的 0 到 1 的分数表示。

      Parameters

      Returns Control

      同一个控件

    • 设置控件的宽度,以像素字符串(例如 200px)或父级的 0 到 1 的分数表示。

      Parameters

      Returns Control

      同一个控件

    • 以 CSS 颜色设置控件的主颜色,即按钮或文本块的文本颜色以及滑块或复选框的填充颜色。

      Parameters

      Returns Control

      同一个控件

    • 设置控件文本的字体大小,以像素数或字符串(例如 24px)表示。

      Parameters

      Returns Control

      同一个控件