Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UITransformComponent

UI 变换组件。 可通过 cc.UITransformComponent 获得该组件。

Hierarchy

Index

Constructors

constructor

Properties

Protected _anchorPoint

_anchorPoint: Vec2 = new Vec2(0.5, 0.5)

_canvas

_canvas: CanvasComponent | null = null

Protected _contentSize

_contentSize: Size = new Size(100, 100)

Private _enabled

_enabled: boolean = true
property

_enabled

type

{Boolean}

_id

_id: string = idGenerator.getNewId()

For internal usage.

Protected _name

_name: string

_objFlags

_objFlags: number

Protected _priority

_priority: number = 0

sceneGetter

sceneGetter: null | function = null

node

node: Node = NullNode

该组件被附加到的节点。组件总会附加到一个节点。

property

node

type

{Node}

example
cc.log(comp.node);

Static EventType

EventType: SystemEventType = SystemEventType

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null
  • Returns null

isOnLoadCalled

  • get isOnLoadCalled(): number
  • 返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。

    property

    _isOnLoadCalled

    type

    {Number}

    readonly
    example
    cc.log(this._isOnLoadCalled > 0);

    Returns number

anchorPoint

  • get anchorPoint(): Readonly<Vec2>
  • set anchorPoint(value: object): void
  • 锚点位置。

    Returns Readonly<Vec2>

  • Parameters

    • value: object

    Returns void

anchorX

  • get anchorX(): number
  • set anchorX(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

anchorY

  • get anchorY(): number
  • set anchorY(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

contentSize

  • get contentSize(): Readonly<Size>
  • set contentSize(value: object): void
  • 内容尺寸。

    Returns Readonly<Size>

  • Parameters

    • value: object

    Returns void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void
  • 表示该组件自身是否启用。

    property

    enabled

    type

    {Boolean}

    default

    true

    example
    comp.enabled = true;
    cc.log(comp.enabled);

    Returns boolean

  • Parameters

    • value: boolean

    Returns void

enabledInHierarchy

  • get enabledInHierarchy(): boolean
  • 表示该组件是否被启用并且所在的节点也处于激活状态。

    property

    enabledInHierarchy

    type

    {Boolean}

    readonly
    example
    cc.log(comp.enabledInHierarchy);

    Returns boolean

height

  • get height(): number
  • set height(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

isValid

  • get isValid(): boolean
  • 表示该对象是否可用(被 destroy 后将不可用)。
    当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

    property

    {Boolean} isValid

    default

    true

    readonly
    example
    import * as cc from 'cc';
    var node = new cc.Node();
    cc.log(node.isValid);    // true
    node.destroy();
    cc.log(node.isValid);    // true, still valid in this frame
    // after a frame...
    cc.log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

name

  • get name(): string
  • set name(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

priority

  • get priority(): number
  • set priority(value: number): void
  • 渲染先后顺序,按照广度渲染排列,按同级节点下进行一次排列。

    Returns number

  • Parameters

    • value: number

    Returns void

uuid

  • get uuid(): string
  • 组件的 uuid,用于编辑器。

    property

    uuid

    type

    {String}

    readonly
    example
    cc.log(comp.uuid);

    Returns string

visibility

  • get visibility(): number
  • 查找被渲染相机。

    Returns number

width

  • get width(): number
  • set width(value: number): void
  • Returns number

  • Parameters

    • value: number

    Returns void

Methods

preload

  • __preload(): void
  • Returns void

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Protected Optional getLocalBounds

  • getLocalBounds(out_rect: Rect): void
  • 如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。

    Parameters

    • out_rect: Rect

      提供包围盒的 Rect

    Returns void

getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any
  • Parameters

    • cloned: any

    Returns any

onPreDestroy

  • _onPreDestroy(): void

Protected parentChanged

  • parentChanged(node: Node): void
  • Parameters

    Returns void

Protected sortSiblings

  • _sortSiblings(): void
  • Returns void

updateVisibility

  • _updateVisibility(): void
  • Returns void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null
  • 向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。

    example
    var test = node.addComponent("Test");

    Type parameters

    Parameters

    Returns T | null

  • 向节点添加一个指定类型的组件类,你还可以通过传入脚本的名称来添加组件。

    example
    var test = node.addComponent("Test");

    Parameters

    • className: string

    Returns Component | null

convertToNodeSpaceAR

  • 将一个 UI 节点世界坐标系下点转换到另一个 UI 节点 (局部) 空间坐标系,这个坐标系以锚点为原点。 非 UI 节点转换到 UI 节点(局部) 空间坐标系,请走 CameraComponent 的 convertToUINode

    example
    const newVec3 = uiTransform.convertToNodeSpaceAR(cc.v3(100, 100, 0));

    Parameters

    • worldPoint: Vec3

      世界坐标点。

    • Optional out: Vec3

      转换后坐标。

    Returns Vec3

    • 返回与目标节点的相对位置。

convertToWorldSpaceAR

  • 将距当前节点坐标系下的一个点转换到世界坐标系。

    example
    const newVec3 = uiTransform.convertToWorldSpaceAR(3(100, 100, 0));

    Parameters

    • nodePoint: Vec3

      节点坐标。

    • Optional out: Vec3

      转换后坐标。

    Returns Vec3

    • 返回 UI 世界坐标系。

destroy

  • destroy(): any

getBoundingBox

  • getBoundingBox(): Rect
  • 返回父节坐标系下的轴向对齐的包围盒。

    example
    const boundingBox = uiTransform.getBoundingBox();

    Returns Rect

    • 节点大小的包围盒

getBoundingBoxTo

  • getBoundingBoxTo(parentMat: Mat4): Rect
  • 返回包含当前包围盒及其子节点包围盒的最小包围盒。

    Parameters

    • parentMat: Mat4

      父节点矩阵。

    Returns Rect

getBoundingBoxToWorld

  • getBoundingBoxToWorld(): Rect
  • 返回节点在世界坐标系下的对齐轴向的包围盒(AABB)。 该边框包含自身和已激活的子节点的世界边框。

    example
    const newRect = uiTransform.getBoundingBoxToWorld();

    Returns Rect

    • 返回世界坐标系下包围盒。

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null
  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Type parameters

    Parameters

    Returns T | null

  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Parameters

    • className: string

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null
  • 递归查找所有子节点中第一个匹配指定类型的组件。

    example
    var Test = node.getComponentInChildren("Test");

    Type parameters

    Parameters

    Returns T | null

  • 递归查找所有子节点中第一个匹配指定类型的组件。

    example
    var Test = node.getComponentInChildren("Test");

    Parameters

    • className: string

    Returns Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]
  • 返回节点上指定类型的所有组件。

    example
    var tests = node.getComponents("Test");

    Type parameters

    Parameters

    Returns T[]

  • 返回节点上指定类型的所有组件。

    example
    var tests = node.getComponents("Test");

    Parameters

    • className: string

    Returns Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]
  • 递归查找自身或所有子节点中指定类型的组件。

    example
    var tests = node.getComponentsInChildren("Test");

    Type parameters

    Parameters

    Returns T[]

  • 递归查找自身或所有子节点中指定类型的组件。

    example
    var tests = node.getComponentsInChildren("Test");

    Parameters

    • className: string

    Returns Component[]

getComputeAABB

  • getComputeAABB(out?: aabb): undefined | aabb
  • 计算出此 UI_2D 节点在世界空间下的 aabb 包围盒

    Parameters

    • Optional out: aabb

    Returns undefined | aabb

isHit

  • 当前节点的点击计算。

    Parameters

    Returns any

Protected Optional lateUpdate

  • lateUpdate(dt: number): void
  • 如果该组件启用,则每帧调用 LateUpdate。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

onDestroy

  • onDestroy(): void
  • Returns void

onDisable

  • onDisable(): void
  • Returns void

onEnable

  • onEnable(): void
  • Returns void

Optional onFocusInEditor

  • onFocusInEditor(): void

Protected Optional onLoad

  • onLoad(): void
  • 当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行,这能用于安排脚本的初始化顺序。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

  • onRestore(): void
  • onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

    如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

    编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。 然而,在极端的情况下,它可能无法良好运作。
    那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。 一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

    同样的,编辑可能无法在极端情况下正确地重置您的组件。
    于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
    一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
    此方法仅在编辑器下会被调用。

    Returns void

Optional resetInEditor

  • resetInEditor(): void
  • 用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

    Returns void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • 调度一个自定义的回调函数。
    如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

    method

    schedule

    example
    var timeCallback = function (dt) {
      cc.log("time: " + dt);
    }
    this.schedule(timeCallback, 1);

    Parameters

    • callback: any

      回调函数。

    • Default value interval: number = 0

      时间间隔,0 表示每帧都重复。

    • Default value repeat: number = cc.macro.REPEAT_FOREVER

      将被重复执行(repeat+ 1)次,您可以使用 cc.macro.REPEAT_FOREVER 进行无限次循环。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    schedule

    example
    var timeCallback = function (dt) {
      cc.log("time: " + dt);
    }
    this.scheduleOnce(timeCallback, 2);

    Parameters

    • callback: any

      回调函数。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

setAnchorPoint

  • setAnchorPoint(point: Vec2 | number, y?: undefined | number): void
  • 设置锚点的百分比。
    锚点应用于所有变换和坐标点的操作,它就像在节点上连接其父节点的大头针。
    锚点是标准化的,就像百分比一样。(0,0) 表示左下角,(1,1) 表示右上角。
    但是你可以使用比(1,1)更高的值或者比(0,0)更低的值。
    默认的锚点是(0.5,0.5),因此它开始于节点的中心位置。
    注意:Creator 中的锚点仅用于定位所在的节点,子节点的定位不受影响。

    example
    node.setAnchorPoint(cc.v2(1, 1));
    node.setAnchorPoint(1, 1);

    Parameters

    • point: Vec2 | number

      节点锚点或节点 x 轴锚。

    • Optional y: undefined | number

      节点 y 轴锚。

    Returns void

setContentSize

  • setContentSize(size: Size | number, height?: undefined | number): void
  • 设置节点原始大小,不受该节点是否被缩放或者旋转的影响。

    example
    node.setContentSize(cc.size(100, 100));
    node.setContentSize(100, 100);

    Parameters

    • size: Size | number

      节点内容变换的尺寸或者宽度。

    • Optional height: undefined | number

      节点内容未变换的高度。

    Returns void

Protected Optional start

  • start(): void
  • 如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Returns void

unschedule

  • unschedule(callback_fn: any): void
  • 取消调度一个自定义的回调函数。

    example
    this.unschedule(_callback);

    Parameters

    • callback_fn: any

      回调函数。

    Returns void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void
  • 取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

    method

    unscheduleAllCallbacks

    example
    this.unscheduleAllCallbacks();

    Returns void

Protected Optional update

  • update(dt: number): void
  • 如果该组件启用,则每帧调用 update。
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc