Home Reference Source 
import UiLayout from 'oxygen-core/components/UiLayout.js'
public class | source

UiLayout

Extends:

Component → UiLayout

Static Member Summary

Static Public Members
public static get

propsTypes: {"camera": string, "xAnchor": string, "yAnchor": string, "xOffset": string, "yOffset": string}

Static Method Summary

Static Public Methods
public static

factory(): *

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

camera: *

public set
public get

xAnchor: *

public set
public get

xOffset: *

public set
public get

yAnchor: *

public set
public get

yOffset: *

public set

Method Summary

Public Methods
public
public

layout(triggerAction: boolean)

public

onAction(name: *, args: ...*): *

public
public

onCameraChanged(camera: *)

public
public

onUpdate(deltaTime: *)

Inherited Summary

From class Component
public static get
public static

Component factory.
public get
public

[name]: *

public

deserialize(json: *)

Deserialize JSON properties into this component.
public

Destructor (dispose internal resources and detach from entity).
public

onAction(name: string, args: *)

Called when action arrived.
public

onAlterActionArguments(name: string, args: *): array | undefined

Called when asked to alter arrived action parameters.
public

Called after attached to entity.
public

Called before detached from entity.
public

onPropertySerialize(name: string, value: *): *

Called when property is serialized.
public

onPropertySetup(name: string, value: *)

Called when given property is deserialized.
public

serialize(): *

Serialize component into JSON data.

Static Public Members

public static get propsTypes: {"camera": string, "xAnchor": string, "yAnchor": string, "xOffset": string, "yOffset": string} source

Override:

Component#propsTypes

Static Public Methods

public static factory(): * source

Component factory.

Override:

Component#factory

Return:

*

Public Constructors

public constructor() source

Constructor.

Override:

Component#constructor

Public Members

public get camera: * source

public set camera source

public get xAnchor: * source

public set xAnchor source

public get xOffset: * source

public set xOffset source

public get yAnchor: * source

public set yAnchor source

public get yOffset: * source

public set yOffset source

Public Methods

public dispose() source

Destructor (dispose internal resources and detach from entity).

Override:

Component#dispose

public layout(triggerAction: boolean) source

Params:

NameTypeAttributeDescription
triggerAction boolean
  • optional
  • default: true

public onAction(name: *, args: ...*): * source

Called when action arrived.

Override:

Component#onAction

Params:

NameTypeAttributeDescription
name *
args ...*

Return:

*

public onAttach() source

Called after attached to entity.

Override:

Component#onAttach

public onCameraChanged(camera: *) source

Params:

NameTypeAttributeDescription
camera *

public onLayout() source

public onUpdate(deltaTime: *) source

Params:

NameTypeAttributeDescription
deltaTime *