Class default<Config>

constructor

• new default<Config>(_config): default<Config>

• Type Parameters

  • Config extends Partial<{
        defaults: Partial<{
            colorMask: vec4b;
            font: Font;
            fontSize: number;
            textColor: vec4;
        }>;
        enabled: boolean;
        name: string;
        position: vec3;
        rotation: quat;
        scale: number;
    }> = Partial<{
        defaults: Partial<{
            colorMask: vec4b;
            font: Font;
            fontSize: number;
            textColor: vec4;
        }>;
        enabled: boolean;
        name: string;
        position: vec3;
        rotation: quat;
        scale: number;
    }>

  Parameters

  • _config: Config

  Returns default<Config>

Protected_alpha

ProtectedattachedToScene

ProtectedchildViews

Protectedcontainer

isDestroyed

onEnabled

StaticonCreateView

StaticonDestroyView

alpha

• get alpha(): number

• Returns the current alpha of the view

  Returns number
• set alpha(a): void

• Parameters

  • a: number

  Returns void

  Inherit Doc

Protectedconfig

• get config(): Config

• Returns Config

localPosition

• get localPosition(): vec3

• Returns vec3

• set localPosition(position): void

• Parameters

  • position: vec3

  Returns void

localRotation

• get localRotation(): quat

• Returns quat

• set localRotation(rotation): void

• Parameters

  • rotation: quat

  Returns void

localScale

• get localScale(): number

• Return the local scale of an object, assuming uniform scaling

  Returns number
• set localScale(scale): void

• Parameters

  • scale: number

  Returns void

localScaleVec3

• get localScaleVec3(): vec3

• Returns vec3

• set localScaleVec3(vec): void

• Parameters

  • vec: vec3

  Returns void

name

• get name(): string

• Returns string

position

• get position(): vec3
• Deprecated

  use localPosition instead

  Returns vec3
• set position(position): void
• Deprecated

  pleasre use localPosition

  Parameters

  • position: vec3

  Returns void

scale

• set scale(scale): void
• Deprecated

  use localScale instead

  Parameters

  • scale: number

  Returns void

worldPosition

• get worldPosition(): vec3

• Returns vec3

• set worldPosition(position): void

• Parameters

  • position: vec3

  Returns void

worldRotation

• get worldRotation(): quat

• Returns quat

• set worldRotation(rotation): void

• Parameters

  • rotation: quat

  Returns void

worldScale

• get worldScale(): number

• Returns number

• set worldScale(scale): void

• Parameters

  • scale: number

  Returns void

worldScaleVec3

• get worldScaleVec3(): vec3

• Returns vec3

• set worldScaleVec3(scale): void

• Parameters

  • scale: vec3

  Returns void

ProtectedaddChild

• addChild<Child>(child, configure?, preserveWorldTransform?): Child

• Type Parameters

  • Child extends default<any>

  Parameters

  • child: Child
  • Optionalconfigure: ((c: Child) => void)
    • • (c): void

      • Parameters

        • c: Child

        Returns void

  • preserveWorldTransform: boolean = false

  Returns Child

addComponent

• addComponent<K>(typeName): ComponentNameMap[K]

• Type Parameters

  • K extends keyof ComponentNameMap

  Parameters

  • typeName: K

  Returns ComponentNameMap[K]

addOnDestroyCallback

• addOnDestroyCallback(callback): void

• addOnDestroyCallback adds a callback to call when the view is destroyed

  Parameters

  • callback: OnDestroyCallback

  Returns void

attachToScene

• attachToScene(parent): this

• Parameters

  • parent: SceneObject

  Returns this

destroy

• destroy(): void

• Returns void

ProtecteddestroyChild

• destroyChild<Child>(child): boolean

• Destroys and removes the child from this View

  Type Parameters

  • Child extends default<any>

  Parameters

  • child: Child

    the child to be destroyed

  Returns boolean

  whether the child was destroyed

ProtecteddetachChild

• detachChild<Child>(child): boolean

• Detaches child from parent and removes the child from this View

  Type Parameters

  • Child extends default<any>

  Parameters

  • child: Child

    the child to be detached

  Returns boolean

  whether the child was detached

getComponent

• getComponent<K>(typeName): ComponentNameMap[K]

• Type Parameters

  • K extends keyof ComponentNameMap

  Parameters

  • typeName: K

  Returns ComponentNameMap[K]

getRelativePosOfPoint

• getRelativePosOfPoint(worldPos): vec3

• Parameters

  • worldPos: vec3

    a point representing something's world position

  Returns vec3

  the point's position relative to this view

getSceneObject

• getSceneObject(): SceneObject

• Returns SceneObject

getTransform

• getTransform(): Transform

• Returns Transform

isEnabled

• isEnabled(): boolean

• Returns boolean

isVisible

• isVisible(): boolean

• Returns boolean

ProtectednewChild

• newChild<Conf, Child>(ctor, conf, customize?): Child

• Type Parameters

  • Conf
  • Child extends default<Conf>

  Parameters

  • ctor: (new (conf: Conf) => Child)
    • • new (conf): Child

      • Parameters

        • conf: Conf

        Returns Child

  • conf: Conf
  • Optionalcustomize: ((c: Child) => void)
    • • (c): void

      • Parameters

        • c: Child

        Returns void

  Returns Child

ProtectedonAttachToScene

• onAttachToScene(defaults, parentView): void

• Parameters

  • defaults: Partial<{
        colorMask: vec4b;
        font: Font;
        fontSize: number;
        textColor: vec4;
    }>
  • parentView: default<Partial<{
        defaults: Partial<{
            colorMask: vec4b;
            font: Font;
            fontSize: number;
            textColor: vec4;
        }>;
        enabled: boolean;
        name: string;
        position: vec3;
        rotation: quat;
        scale: number;
    }>>

  Returns void

ProtectedrecursivelySetChildProperty

• recursivelySetChildProperty<FieldName, FieldType>(fieldName, newValue): void

• Type Parameters

  • FieldName extends keyof default<Config>
  • FieldType extends
        | string
        | number
        | boolean
        | vec3
        | quat
        | PublicApi<boolean>
        | (() => boolean)
        | (() => boolean)
        | ((a: number) => void)
        | (() => void)
        | ((callback: OnDestroyCallback) => void)
        | ((parent: SceneObject) => this)
        | (() => SceneObject)
        | (() => Transform)
        | ((worldPos: vec3) => vec3)
        | ((enabled: boolean) => void)
        | (<K>(typeName: K) => ComponentNameMap[K])
        | (<K>(typeName: K) => ComponentNameMap[K])

  Parameters

  • fieldName: FieldName
  • newValue: FieldType

  Returns void

ProtectedremoveChild

• removeChild<Child>(child): void
• Deprecated

  use destroyChild or detachChild instead.

  Type Parameters

  • Child extends default<any>

  Parameters

  • child: Child

  Returns void

setAlpha

• setAlpha(a): void

• Set the alpha of the View to a, and recursively apply this alpha to all descendents. The alpha will be applied by setting the .a component of baseColor to a.

  Parameters

  • a: number

    The value to set the alpha of the view to, from 0 to 1

  Returns void

setEnabled

• setEnabled(enabled): void

• Parameters

  • enabled: boolean

  Returns void