Class TransformLayout3D

变换布局

提供了比Transform更加适用于2D元素的API

通过修改Transform的数值实现

Hierarchy

Constructors

constructor

Properties

_entity _invalidateLayout _invalidatePivot _invalidateSize _layoutInvalid _leftTop _onAdded _onRemoved _position _rightBottom _size _updateLayout anchorMax anchorMin emitter enabled hideFlags pivot runEnvironment

Accessors

entity isVisibleAndEnabled leftTop node position rightBottom size

Methods

addComponent beforeRender destroy getComponent getComponentInChildren getComponentInParent getComponents getComponentsInChildren getComponentsInParent getShareTargets init setEntity __create__ getDependencies isSingleComponent

Constructors

constructor

Properties

Protected _entity

_entity: Node3D

Private _invalidateLayout

_invalidateLayout: any

Private _invalidatePivot

_invalidatePivot: any

Private _invalidateSize

_invalidateSize: any

Private _layoutInvalid

_layoutInvalid: any

布局是否失效

Private _leftTop

_leftTop: any

Private _onAdded

_onAdded: any

Private _onRemoved

_onRemoved: any

Private Readonly _position

_position: any

Private _rightBottom

_rightBottom: any

Private _size

_size: any

Private _updateLayout

_updateLayout: any

anchorMax

anchorMax: Vector3

最大锚点，父Transform2D中左上角锚定的规范化位置。

anchorMin

anchorMin: Vector3

最小锚点，父Transform2D中左上角锚定的规范化位置。

Readonly emitter

emitter: EventEmitter<Node3DEventMap>

enabled

enabled: boolean

是否启用update方法

hideFlags

hideFlags: HideFlags

隐藏标记，用于控制是否在层级界面、检查器显示，是否保存

pivot

pivot: Vector3

The normalized position in this RectTransform that it rotates around.

runEnvironment

runEnvironment: RunEnvironment

可运行环境

Accessors

entity

  • get entity(): Node3D

  • 此组件附加到的游戏对象。组件总是附加到游戏对象上。

    Returns Node3D

isVisibleAndEnabled

  • get isVisibleAndEnabled(): boolean

  • Has the Behaviour had enabled called. 是否所在Object3D显示且该行为已启动。

    Returns boolean

leftTop

  • get leftTop(): Vector3

  • 与最小最大锚点形成的边框的left、right、top、bottom距离。当 anchorMin.x != anchorMax.x 时对 layout.x layout.y 赋值生效，当 anchorMin.y != anchorMax.y 时对 layout.z layout.w 赋值生效，否则赋值无效，自动被覆盖。

    Returns Vector3

  • set leftTop(v): void

  • Parameters

    Returns void

node

  • get node(): Node

  • 2D节点。

    Returns Node

position

  • get position(): Vector3

  • 位移

    Returns Vector3

  • set position(v): void

  • Parameters

    Returns void

rightBottom

  • get rightBottom(): Vector3

  • 与最小最大锚点形成的边框的left、right、top、bottom距离。当 anchorMin.x != anchorMax.x 时对 layout.x layout.y 赋值生效，当 anchorMin.y != anchorMax.y 时对 layout.z layout.w 赋值生效，否则赋值无效，自动被覆盖。

    Returns Vector3

  • set rightBottom(v): void

  • Parameters

    Returns void

size

  • get size(): Vector3

  • 尺寸，宽高。

    Returns Vector3

  • set size(v): void

  • Parameters

    Returns void

Methods

addComponent

  • Adds a component class of type componentType to the game object.

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • type: K

      组件类定义。

    • Optional params: gPartial<ComponentMap[K]>

    Returns ComponentMap[K]

    被添加的组件。

beforeRender

  • Parameters

    Returns void

destroy

  • 销毁

    Returns void

getComponent

  • 返回游戏对象附加的一个指定类型的组件，如果没有，则返回 null。

    使用 Entity.GetComponent 将返回找到的第一个组件。如果您希望有多个相同类型的组件，请改用 Entity.GetComponents，并循环通过返回的组件测试某些唯一属性。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    Returns ComponentMap[K]

    要检索的组件。

getComponentInChildren

  • 使用深度优先搜索返回 Entity 或其任何子项中的 Type 组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      是否包含不活跃组件。

    Returns ComponentMap[K]

    匹配类型的组件（如果找到）。

getComponentInParent

  • 检索 Entity 或其任何父项type中的 Type 组件。

    此方法向上递归，直到找到具有匹配组件的 Entity。仅匹配活动游戏对象上的组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要查找的组件类型。

    • Optional includeInactive: boolean

      是否包含不活跃组件。

    Returns ComponentMap[K]

    如果找到与类型匹配的组件，则返回一个组件。否则返回 null。

getComponents

  • 返回Entity中指定类型的所有组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • type: K

      要检索的组件类型。

    • Optional results: ComponentMap[K][]

      列出接收找到的组件。

    Returns ComponentMap[K][]

    实体中指定类型的所有组件。

getComponentsInChildren

  • 使用深度优先搜索返回 当前实体 或其任何子子项中 Type 的所有组件。递归工作。

    在子游戏对象上递归搜索组件。这意味着它还包括目标实体的所有子实体，以及所有后续子实体。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      非活动游戏对象上的组件是否应该包含在搜索结果中？

    • Optional results: ComponentMap[K][]

      列出接收找到的组件。

    Returns ComponentMap[K][]

    所有找到的组件。

getComponentsInParent

  • 返回当前实体或其任何父级中指定的所有组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      非活动组件是否应该包含在搜索结果中？

    • Optional results: ComponentMap[K][]

      列出找到的组件。

    Returns ComponentMap[K][]

    实体或其任何父级中指定的所有组件。

getShareTargets

  • 把事件分享到实体上。

    Returns Entity[]

init

  • 初始化组件

    在添加到Entity时立即被调用。

    Returns void

Private setEntity

  • Private

    该方法仅在Entity中使用

    Parameters

    • entity: Entity

      游戏对象

    Returns void

Static Private __create__

  • __create__<T>(this): T
  • Private

    组件无法直接使用关键字 new 来构造。

    Type Parameters

    • T

    Parameters

    Returns T

    新建的组件实例。

    See

    getInstance

Static getDependencies

  • 获取组件依赖列表

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      组件类定义

    Returns "Component"[]

Static isSingleComponent

  • 判断组件是否为唯一组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K | ComponentMap[K] | Constructor<ComponentMap[K]>

      组件类定义

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc