Skip to content
MenuAnchor

界面 / MenuAnchor

MenuAnchor Class

菜单锚点

Hierarchy

Table of contents

Accessors

contentPadding(): Margin
isFitInWindow(): boolean
isRightOpenMenu(): boolean
itemPadding(): Margin
itemStyle(): ButtonStyle
maxListHeight(): number
menuBorderBrush(): ImageInfo
onClickMenuItemEvent(): MulticastDelegate<(menuId: string) => void>
placement(): MenuPlacement
scrollBarPadding(): Margin
scrollBarStyle(): ScrollbarStyle
scrollBarThickness(): number
click

Accessors

alignPosition(): Readonly<Vector2> client
获取控件的对齐位置,在对齐方式为靠右对齐、靠下对齐、中心对齐时,alignPosition的值与positon不同;
autoSizeHorizontalEnable(): boolean client
获取是否自动水平设置大小
autoSizeVerticalEnable(): boolean client
获取是否自动垂直设置大小
cachedGeometry(): Geometry client
获取上一次的GetTickSpaceGeometry
constraints(): Readonly<UIConstraintAnchors> client
获取控件的布局
desiredSize(): Vector2 client
获取期望大小
enable(): boolean client
是否可用
guid(): string client
获取控件GUID
isHovered(): boolean client
是否是hovered
mouseCursor(): MouseCursor client
获取控件上光标类型
name(): string client
获取名字
paintSpaceGeometry(): Geometry client
获取最后一次用于渲染Widget的几何信息
parent(): Widget client
获取父节点
pivot(): Vector2 client
获取控件锚点位置,这个属性决定了控件图形与锚点的相对位置;(0,0)时,锚点位于控件左上角;(0.5,0.5)时,锚点位于控件正中心
position(): Readonly<Vector2> client
获取控件的位置
renderOpacity(): number client
获取渲染透明度
renderScale(): Vector2 client
获取渲染缩放
renderShear(): Vector2 client
获取渲染错切形变
renderTransformAngle(): number client
获取渲染的角度
renderTransformPivot(): Vector2 client
获取渲染锚点
size(): Vector2 client
获取大小
tickSpaceGeometry(): Geometry client
获取最后一次用于驱动Widget Tick的几何信息
transform(): Readonly<UITransform> client
得到控件的大小和位置
visibility(): SlateVisibility client
获取可见性
visible(): boolean client
是否可见
zOrder(): number client
获取zorder

Methods

addMenuItem(info: MenuItemInfo): void
addMenuItems(info: MenuItemInfo[]): void
open(focusMenu?: boolean): void
toggleOpen(focusOnOpen?: boolean): void
click

Methods

addChild(child: Widget): void client
添加子节点
clone(position: Vector2, Parent?: any): Widget client
克隆UI控件及其子节点到指定父控件位置(默认到其父节点)
destroyObject(): void client
立刻移除并销毁 不可以在使用
equal(that: Widget): boolean client
判断是不是同一个对象
findChildByPath(inPath: string): Widget client
通过相对路径查找节点
getChildAt(index: number): Widget client
获取第几位子节点
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> client
通过名字查找节点
getChildrenCount(): number client
获取子节点数量
invalidateLayoutAndVolatility(): void client
立刻触发重新渲染的和排布计算
removeAllChildren(): void client
清除所有子节点,会销毁UI无法再使用
removeChild(child: Widget): void client
移除节点,会销毁UI无法在使用
removeChildAt(index: number): void client
移除第几个节点,会销毁UI无法再使用
removeObject(): void client
立刻移除并添加到根节点 可以再使用
serialize(): string client
序列化UI控件
deserialize(Data: string, Parent?: Widget): Widget client
反序列化UI

Accessors


contentPadding

get contentPadding(): Margin

set contentPadding(inPadding): void

菜单内容边距

Returns

Margin

菜单内容边距

Parameters

inPaddingMargin

isFitInWindow

get isFitInWindow(): boolean

set isFitInWindow(isFit): void

Returns

boolean

Parameters

isFitboolean

isRightOpenMenu

get isRightOpenMenu(): boolean

set isRightOpenMenu(isOpen): void

Returns

boolean

Parameters

isOpenboolean

itemPadding

get itemPadding(): Margin

set itemPadding(inPadding): void

Returns

Margin

Parameters

inPaddingMargin

itemStyle

get itemStyle(): ButtonStyle

菜单项样式

Returns

ButtonStyle

maxListHeight

get maxListHeight(): number

set maxListHeight(inHeight): void

Returns

number

Parameters

inHeightnumber

get menuBorderBrush(): ImageInfo

菜单背景图

Returns

ImageInfo

onClickMenuItemEvent

get onClickMenuItemEvent(): MulticastDelegate<(menuId: string) => void>

Returns

MulticastDelegate<(menuId: string) => void>

placement

get placement(): MenuPlacement

set placement(inType): void

Returns

MenuPlacement

Parameters

inTypeMenuPlacement

scrollBarPadding

get scrollBarPadding(): Margin

set scrollBarPadding(inPadding): void

Returns

Margin

Parameters

inPaddingMargin

scrollBarStyle

get scrollBarStyle(): ScrollbarStyle

滚动条样式

Returns

ScrollbarStyle

scrollBarThickness

get scrollBarThickness(): number

set scrollBarThickness(inThickness): void

Returns

number

Parameters

inThicknessnumber

Methods


addMenuItem

addMenuItem(info): void

Parameters

infoMenuItemInfo

addMenuItems

addMenuItems(info): void

Parameters

infoMenuItemInfo[]

open

open(focusMenu?): void

Parameters

focusMenu?boolean

toggleOpen

toggleOpen(focusOnOpen?): void

Parameters

focusOnOpen?boolean