Class Layout

Hierarchy

Component
- Layout

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Layout(props?: ObjectProps<Layout>): Layout

- Defined in src/ui/Layout.ts:112
Parameters
- Optional props: ObjectProps<Layout>
Returns Layout

Properties

Static horizontalAlignmentPropertyKey

horizontalAlignmentPropertyKey: string = "_horizontalAlignment"

Static offsetKey

offsetKey: string = "_offset"

Static rotationKey

rotationKey: string = "_rotation"

Static scaleKey

scaleKey: string = "_scale"

Static verticalAlignmentPropertyKey

verticalAlignmentPropertyKey: string = "_verticalAlignment"

Accessors

absolutePos

get absolutePos(): Vector3

- Defined in src/ui/Layout.ts:85
Returns Vector3

absoluteScale

get absoluteScale(): Vector3

- Defined in src/ui/Layout.ts:81
Returns Vector3

active

get active(): boolean
set active(active: boolean): void

Inherited from Component.active
- Defined in src/core/Component.ts:12
Returns boolean
Inherited from Component.active
- Defined in src/core/Component.ts:13
Parameters
- active: boolean
Returns void

actualHeight

get actualHeight(): number
set actualHeight(h: number): void

- Defined in src/ui/Layout.ts:48
Returns number
- Defined in src/ui/Layout.ts:52
Parameters
- h: number
Returns void

actualWidth

get actualWidth(): number
set actualWidth(w: number): void

- Defined in src/ui/Layout.ts:47
Returns number
- Defined in src/ui/Layout.ts:51
Parameters
- w: number
Returns void

entity

get entity(): Entity

Inherited from Component.entity
- Defined in src/core/Component.ts:10
Returns Entity

finalTint

get finalTint(): Color

- Defined in src/ui/Layout.ts:50
Returns Color

forward

get forward(): Vector3

- Defined in src/ui/Layout.ts:59
Returns Vector3

height

get height(): UISize

- Defined in src/ui/Layout.ts:30
Returns UISize

horizontalAlignment

get horizontalAlignment(): number
set horizontalAlignment(value: number): void

- Defined in src/ui/Layout.ts:31
Returns number
- Defined in src/ui/Layout.ts:33
Parameters
- value: number
Returns void

id

get id(): string

Inherited from Component.id
- Defined in src/core/Component.ts:11
Returns string

inheritTint

get inheritTint(): boolean
set inheritTint(inherit: boolean): void

- Defined in src/ui/Layout.ts:40
Returns boolean
- Defined in src/ui/Layout.ts:41
Parameters
- inherit: boolean
Returns void

localForward

get localForward(): Vector3

- Defined in src/ui/Layout.ts:73
Returns Vector3

localRight

get localRight(): Vector3

- Defined in src/ui/Layout.ts:69
Returns Vector3

localUp

get localUp(): Vector3

- Defined in src/ui/Layout.ts:77
Returns Vector3

margin

get margin(): Rect

- Defined in src/ui/Layout.ts:35
Returns Rect

offset

get offset(): Vector3
set offset(offset: Vector3): void

- Defined in src/ui/Layout.ts:27
Returns Vector3
- Defined in src/ui/Layout.ts:43
Parameters
- offset: Vector3
Returns void

parent

get parent(): undefined | Entity

Inherited from Component.parent
- Defined in src/core/Component.ts:9
Returns undefined | Entity

pivot

get pivot(): Vector2

- Defined in src/ui/Layout.ts:28
Returns Vector2

right

get right(): Vector3

- Defined in src/ui/Layout.ts:54
Returns Vector3

rotation

get rotation(): Quaternion
set rotation(rotation: Quaternion): void

- Defined in src/ui/Layout.ts:36
Returns Quaternion
- Defined in src/ui/Layout.ts:44
Parameters
- rotation: Quaternion
Returns void

scale

get scale(): Vector2
set scale(scale: Vector2): void

- Defined in src/ui/Layout.ts:37
Returns Vector2
- Defined in src/ui/Layout.ts:45
Parameters
- scale: Vector2
Returns void

tint

get tint(): Color
set tint(tint: Color): void

- Defined in src/ui/Layout.ts:38
Returns Color
- Defined in src/ui/Layout.ts:39
Parameters
- tint: Color
Returns void

up

get up(): Vector3

- Defined in src/ui/Layout.ts:64
Returns Vector3

version

get version(): number

- Defined in src/ui/Layout.ts:25
Returns number

verticalAlignment

get verticalAlignment(): number
set verticalAlignment(value: number): void

- Defined in src/ui/Layout.ts:32
Returns number
- Defined in src/ui/Layout.ts:34
Parameters
- value: number
Returns void

width

get width(): UISize

- Defined in src/ui/Layout.ts:29
Returns UISize

worldMatrix

get worldMatrix(): Matrix44

- Defined in src/ui/Layout.ts:49
Returns Matrix44

Methods

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Inherited from SerializableObject.destroy
- Defined in src/core/SerializableObject.ts:33
Returns void

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Inherited from Component.isLoaded
- Defined in src/core/Component.ts:36
Returns boolean

onReplace

onReplace(previous: Component): void

Inherited from Component.onReplace
- Defined in src/core/Component.ts:46
Parameters
- previous: Component
Returns void

reset

reset(): void

Inherited from Component.reset
- Defined in src/core/Component.ts:40
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setEntity

setEntity(entity: Entity): void

Inherited from Component.setEntity
- Defined in src/core/Component.ts:32
Parameters
- entity: Entity
Returns void

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/ui/Layout.ts:121
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject