Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutComponent

Layout 组件相当于一个容器,能自动对它的所有子节点进行统一排版。
注意:
1.不会考虑子节点的缩放和旋转。
2.对 Layout 设置后结果需要到下一帧才会更新,除非你设置完以后手动调用。updateLayout 可通过 cc.LayoutComponent 获得此组件

Hierarchy

Index

Constructors

constructor

Properties

Private _N$layoutType

_N$layoutType: Type = Type.NONE

Private _N$padding

_N$padding: number = 0

Private _affectedByScale

_affectedByScale: boolean = false

Private _cellSize

_cellSize: Size = new Size(40, 40)

Private _enabled

_enabled: boolean = true
property

_enabled

type

{Boolean}

Private _horizontalDirection

_horizontalDirection: HorizontalDirection = HorizontalDirection.LEFT_TO_RIGHT

_id

_id: string = idGenerator.getNewId()

For internal usage.

Private _layoutDirty

_layoutDirty: boolean = true

Private _layoutSize

_layoutSize: Size = new Size(300, 200)

Protected _name

_name: string

_objFlags

_objFlags: number

Private _paddingBottom

_paddingBottom: number = 0

Private _paddingLeft

_paddingLeft: number = 0

Private _paddingRight

_paddingRight: number = 0

Private _paddingTop

_paddingTop: number = 0

Private _resizeMode

_resizeMode: ResizeMode = ResizeMode.NONE

sceneGetter

sceneGetter: null | function = null

Private _spacingX

_spacingX: number = 0

Private _spacingY

_spacingY: number = 0

Private _startAxis

_startAxis: AxisDirection = AxisDirection.HORIZONTAL

Private _verticalDirection

_verticalDirection: VerticalDirection = VerticalDirection.TOP_TO_BOTTOM

node

node: INode = NullNode

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

property

node

type

{Node}

example
cc.log(comp.node);

Static AxisDirection

AxisDirection: AxisDirection = AxisDirection

Static HorizontalDirection

HorizontalDirection: HorizontalDirection = HorizontalDirection

Static ResizeMode

ResizeMode: ResizeMode = ResizeMode

Static Type

Type: Type = Type

Static VerticalDirection

VerticalDirection: VerticalDirection = VerticalDirection

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

isOnLoadCalled

  • get isOnLoadCalled(): number

affectedByScale

  • get affectedByScale(): boolean
  • set affectedByScale(value: boolean): void

cellSize

  • get cellSize(): Readonly<Size>
  • set cellSize(value: object): void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

horizontalDirection

isValid

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

    property

    {Boolean} isValid

    default

    true

    readonly
    example
    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

padding

  • get padding(): number
  • set padding(value: number): void

paddingBottom

  • get paddingBottom(): number
  • set paddingBottom(value: number): void

paddingLeft

  • get paddingLeft(): number
  • set paddingLeft(value: number): void

paddingRight

  • get paddingRight(): number
  • set paddingRight(value: number): void

paddingTop

  • get paddingTop(): number
  • set paddingTop(value: number): void

resizeMode

spacingX

  • get spacingX(): number
  • set spacingX(value: number): void

spacingY

  • get spacingY(): number
  • set spacingY(value: number): void

startAxis

type

  • get type(): Type
  • set type(value: Type): void

uuid

  • get uuid(): string

verticalDirection

Methods

Optional Private preload

  • __preload(): void
  • __preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

    Returns void

Private addChildrenEventListeners

  • _addChildrenEventListeners(): void

Private addEventListeners

  • _addEventListeners(): void

Private childAdded

  • childAdded(child: INode): void

Private childRemoved

  • childRemoved(child: INode): 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

Private doLayout

  • _doLayout(): void

Private doLayoutBasic

  • _doLayoutBasic(): void

Private doLayoutDirty

  • _doLayoutDirty(): void

Private doLayoutGrid

  • _doLayoutGrid(): void

Private doLayoutGridAxisHorizontal

  • doLayoutGridAxisHorizontal(layoutAnchor: any, layoutSize: any): void

Private doLayoutGridAxisVertical

  • doLayoutGridAxisVertical(layoutAnchor: Vec2, layoutSize: Size): void

Private doLayoutHorizontally

  • doLayoutHorizontally(baseWidth: any, rowBreak: any, fnPositionY: any, applyChildren: any): number

Private doLayoutVertically

  • doLayoutVertically(baseHeight: number, columnBreak: boolean, fnPositionX: function, applyChildren: boolean): number
  • Parameters

    • baseHeight: number
    • columnBreak: boolean
    • fnPositionX: function
        • (node: INode, columnMaxWidth: number, col: number): number
        • Parameters

          • node: INode
          • columnMaxWidth: number
          • col: number

          Returns number

    • applyChildren: boolean

    Returns number

Private doScaleDirty

  • _doScaleDirty(): void

Private getHorizontalBaseWidth

  • getHorizontalBaseWidth(children: Readonly<INode[]>): number

Protected Optional getLocalBounds

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

    Parameters

    • out_rect: Rect

      提供包围盒的 Rect

    Returns void

getRenderScene

  • _getRenderScene(): RenderScene

Private getUsedScaleValue

  • getUsedScaleValue(value: any): number

Private getVerticalBaseHeight

  • getVerticalBaseHeight(children: Readonly<INode[]>): number

instantiate

  • instantiate(cloned: any): any

Private migratePaddingData

  • _migratePaddingData(): void

onPreDestroy

  • _onPreDestroy(): void

Private removeChildrenEventListeners

  • _removeChildrenEventListeners(): void

Private removeEventListeners

  • _removeEventListeners(): void

Private resized

  • _resized(): void

Private transformDirty

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

destroy

  • destroy(): any

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

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

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

Protected Optional onDestroy

  • onDestroy(): void
  • 当该组件被销毁时调用
    该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。

    Returns void

Protected onDisable

  • onDisable(): void

Protected onEnable

  • onEnable(): void

Protected Optional onFocusInEditor

  • onFocusInEditor(): void

Protected Optional onLoad

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

    Returns void

Protected Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

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

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

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

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

    Returns void

Protected Optional resetInEditor

  • resetInEditor(): 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

    [[cc.Node.schedule]]

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

    Parameters

    • callback: any

      回调函数。

    • Default value delay: number = 0

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

    Returns void

Protected Optional start

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

    Returns void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): 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

updateLayout

  • updateLayout(): void
  • 立即执行更新布局。

    example
    layout.type = cc.LayoutComponent.HORIZONTAL;
    layout.node.addChild(childNode);
    cc.log(childNode.x); // not yet changed
    layout.updateLayout();
    cc.log(childNode.x); // changed

    Returns void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc