Class Node2D

2D结点

用于构建2D场景树结构,处理2D对象的位移旋转缩放等空间数据。

Hierarchy

  • Node
    • Node2D

Constructors

Properties

_anchorMax: Vector2 = ...
_anchorMin: Vector2 = ...
_children: Node[] = []
_globalVisible: boolean = false
_globalVisibleInvalid: boolean = true
_layout: Vector4 = ...
_parent: Node
_pivot: Vector2 = ...
_position: Vector2 = ...
_rect: Vector4 = ...
_rotation: number = 0
_scale: Vector2 = ...
_size: Vector2 = ...
mouseEnabled: boolean = true

自身以及子对象是否支持鼠标拾取

name: string

名称

transformLayout: TransformLayout3D
_registerPrimitives: {
    [type: string]: ((node2d: Node2D) => void);
} = {}

Type declaration

  • [type: string]: ((node2d: Node2D) => void)
      • (node2d: Node2D): void
      • Parameters

        Returns void

Accessors

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

    Returns Vector4

  • set layout(v: Vector4): void
  • Parameters

    Returns void

Methods

  • 添加子对象

    Parameters

    • Rest ...children: Node[]

      子对象

    Returns void

  • 添加组件到指定位置

    Parameters

    • component: Component

      被添加的组件

    • index: number

      插入的位置

    Returns void

  • 是否包含指定对象

    Parameters

    • child: Node

      可能的子孙对象

    Returns boolean

  • 获取报告的上级目标列表。默认返回 [this.parent]

    See

    IEventTarget

    Returns Node[]

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

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

    Returns

    要检索的组件。

    Type Parameters

    Parameters

    • componentName: K

      要检索的组件类型。

    Returns ComponentMap[K]

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

    Returns

    匹配类型的组件(如果找到)。

    Type Parameters

    Parameters

    • component: K
    • includeInactive: boolean = false

      是否包含不活跃组件。

    Returns ComponentMap[K]

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

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

    Returns

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

    Type Parameters

    Parameters

    • compnent: K
    • includeInactive: boolean = false

      是否包含不活跃组件。

    Returns ComponentMap[K]

  • 获取组件在容器的索引位置

    Returns

    组件在容器的索引位置

    Parameters

    Returns number

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

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

    Returns

    所有找到的组件。

    Type Parameters

    Parameters

    • Optional component: K

      要检索的组件类型。

    • includeInactive: boolean = false

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

    • results: ComponentMap[K][] = []

      列出接收找到的组件。

    Returns ComponentMap[K][]

  • 返回Container或其任何父级中指定的所有组件。

    Returns

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

    Type Parameters

    Parameters

    • Optional component: K

      要检索的组件类型。

    • includeInactive: boolean = false

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

    • results: ComponentMap[K][] = []

      列出找到的组件。

    Returns ComponentMap[K][]

  • 移除子对象

    Parameters

    • child: Node

      子对象

    Returns void

  • 删除指定位置的子对象

    Parameters

    • index: number

      需要删除子对象的所有

    Returns Node

  • Activates/Deactivates the Node, depending on the given true or false value.

    A Node may be inactive because a parent is not active. In that case, calling SetActive will not activate it, but only set the local state of the Node, which you can check using Node.activeSelf. Unity can then use this state when all parents become active.

    Parameters

    • value: boolean

      Activate or deactivate the object, where true activates the Node and false deactivates the Node.

    Returns void

  • 设置组件到指定位置

    Parameters

    • component: Component

      被设置的组件

    • index: number

      索引

    Returns void

  • 设置子组件的位置

    Parameters

    • component: Component

      子组件

    • index: number

      位置索引

    Returns void

  • 交换子组件位置

    Parameters

    • index1: number

      第一个子组件的索引位置

    • index2: number

      第二个子组件的索引位置

    Returns void

  • 遍历自身以及所有子结点。

    Returns

    回调函数结果的列表。

    Type Parameters

    • T

    Parameters

    • callback: ((container: Node) => T)

      回调函数。

        • (container: Node): T
        • Parameters

          • container: Node

          Returns T

    • results: T[] = []

      存放回调函数结果的列表。

    Returns T[]

  • 遍历祖先结点。

    Returns

    回调函数结果的列表。

    Type Parameters

    • T

    Parameters

    • callback: ((container: Node) => T)

      回调函数。

        • (container: Node): T
        • Parameters

          • container: Node

          Returns T

    • results: T[] = []

      存放回调函数结果的列表。

    Returns T[]

  • 遍历自身以及所有可见子结点。

    Returns

    回调函数结果的列表。

    Type Parameters

    • T

    Parameters

    • callback: ((container: Node) => T)

      回调函数。

        • (container: Node): T
        • Parameters

          • container: Node

          Returns T

    • results: T[] = []

      存放回调函数结果的列表。

    Returns T[]

  • 注册原始游戏对象,被注册后可以使用 Node2D.registerPrimitive 进行创建。

    Type Parameters

    Parameters

    • type: K

      原始游戏对象类型。

    • handler: ((object2D: Node2D) => void)

      构建原始游戏对象的函数。

        • (object2D: Node2D): void
        • Parameters

          Returns void

    Returns void

Generated using TypeDoc