Class View<Config>

constructor

• new View<
      Config extends
          Partial<
              {
                  defaults: Defaults;
                  enabled: boolean;
                  name: string;
                  position: vec3;
                  rotation: quat;
                  scale: number;
              },
          > = Partial<
          {
              defaults: Defaults;
              enabled: boolean;
              name: string;
              position: vec3;
              rotation: quat;
              scale: number;
          },
      >,
  >(
      _config: Config,
  ): View<Config>

  Type Parameters

  • Config extends Partial<
        {
            defaults: Defaults;
            enabled: boolean;
            name: string;
            position: vec3;
            rotation: quat;
            scale: number;
        },
    > = Partial<
        {
            defaults: Defaults;
            enabled: boolean;
            name: string;
            position: vec3;
            rotation: quat;
            scale: number;
        },
    >

  Parameters

  • _config: Config

  Returns View<Config>

Protected_alpha

ProtectedattachedToScene

ProtectedchildViews

Protectedcontainer

isDestroyed

StaticonCreateView

StaticonDestroyView

onEnabled

alpha

• get alpha(): number

  Returns the current alpha of the view

  Returns number
• set alpha(a: number): void

  Parameters

  • a: number

  Returns void

  Inherit Doc

Protectedconfig

• get config(): Config

  Returns Config

localPosition

• get localPosition(): vec3

  Returns vec3

• set localPosition(position: vec3): void

  Parameters

  • position: vec3

  Returns void

localRotation

• get localRotation(): quat

  Returns quat

• set localRotation(rotation: quat): 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: number): void

  Parameters

  • scale: number

  Returns void

localScaleVec3

• get localScaleVec3(): vec3

  Returns vec3

• set localScaleVec3(vec: vec3): void

  Parameters

  • vec: vec3

  Returns void

name

• get name(): string

  Returns string

position

• get position(): vec3

  Returns vec3

  Deprecated

  use localPosition instead

• set position(position: vec3): void

  Parameters

  • position: vec3

  Returns void

  Deprecated

  pleasre use localPosition

scale

• set scale(scale: number): void

  Parameters

  • scale: number

  Returns void

  Deprecated

  use localScale instead

worldPosition

• get worldPosition(): vec3

  Returns vec3

• set worldPosition(position: vec3): void

  Parameters

  • position: vec3

  Returns void

worldRotation

• get worldRotation(): quat

  Returns quat

• set worldRotation(rotation: quat): void

  Parameters

  • rotation: quat

  Returns void

worldScale

• get worldScale(): number

  Returns number

• set worldScale(scale: number): void

  Parameters

  • scale: number

  Returns void

worldScaleVec3

• get worldScaleVec3(): vec3

  Returns vec3

• set worldScaleVec3(scale: vec3): void

  Parameters

  • scale: vec3

  Returns void

ProtectedaddChild

• addChild<Child extends View<any>>(
      child: Child,
      configure?: (c: Child) => void,
      preserveWorldTransform?: boolean,
  ): Child

  Type Parameters

  • Child extends View<any>

  Parameters

  • child: Child
  • Optionalconfigure: (c: Child) => void
  • preserveWorldTransform: boolean = false

  Returns Child

addComponent

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

  Type Parameters

  • K extends keyof ComponentNameMap

  Parameters

  • typeName: K

  Returns ComponentNameMap[K]

addOnDestroyCallback

• addOnDestroyCallback(callback: OnDestroyCallback): void

  addOnDestroyCallback adds a callback to call when the view is destroyed

  Parameters

  • callback: OnDestroyCallback

  Returns void

attachToScene

• attachToScene(parent: SceneObject): this

  Parameters

  • parent: SceneObject

  Returns this

destroy

• destroy(): void

  Returns void

ProtecteddestroyChild

• destroyChild<Child extends View<any>>(child: Child): boolean

  Destroys and removes the child from this View

  Type Parameters

  • Child extends View<any>

  Parameters

  • child: Child

    the child to be destroyed

  Returns boolean

  whether the child was destroyed

ProtecteddetachChild

• detachChild<Child extends View<any>>(child: Child): boolean

  Detaches child from parent and removes the child from this View

  Type Parameters

  • Child extends View<any>

  Parameters

  • child: Child

    the child to be detached

  Returns boolean

  whether the child was detached

getComponent

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

  Type Parameters

  • K extends keyof ComponentNameMap

  Parameters

  • typeName: K

  Returns ComponentNameMap[K]

getRelativePosOfPoint

• getRelativePosOfPoint(worldPos: vec3): 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 extends
          View<
              Conf extends Partial<
                  {
                      defaults: Defaults;
                      enabled: boolean;
                      name: string;
                      position: vec3;
                      rotation: quat;
                      scale: number;
                  },
              >
                  ? Conf<Conf>
                  : never,
          >,
  >(
      ctor: new (conf: Conf) => Child,
      conf: Conf,
      customize?: (c: Child) => void,
  ): Child

  Type Parameters

  • Conf
  • Child extends View<
        Conf extends Partial<
            {
                defaults: Defaults;
                enabled: boolean;
                name: string;
                position: vec3;
                rotation: quat;
                scale: number;
            },
        >
            ? Conf<Conf>
            : never,
    >

  Parameters

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

  Returns Child

ProtectedonAttachToScene

• onAttachToScene(
      _defaults: Defaults,
      _parentView: View<
          Partial<
              {
                  defaults: Defaults;
                  enabled: boolean;
                  name: string;
                  position: vec3;
                  rotation: quat;
                  scale: number;
              },
          >,
      >,
  ): void

  Parameters

  • _defaults: Defaults
  • _parentView: View<
        Partial<
            {
                defaults: Defaults;
                enabled: boolean;
                name: string;
                position: vec3;
                rotation: quat;
                scale: number;
            },
        >,
    >

  Returns void

ProtectedrecursivelySetChildProperty

• recursivelySetChildProperty<
      FieldName extends keyof View<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 extends keyof ComponentNameMap>(
                      typeName: K,
                  ) => ComponentNameMap[K]
              )
              | (
                  <K extends keyof ComponentNameMap>(
                      typeName: K,
                  ) => ComponentNameMap[K]
              ),
  >(
      fieldName: FieldName,
      newValue: FieldType,
  ): void

  Type Parameters

  • FieldName extends keyof View<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 extends keyof ComponentNameMap>(typeName: K) => ComponentNameMap[K])
        | (<K extends keyof ComponentNameMap>(typeName: K) => ComponentNameMap[K])

  Parameters

  • fieldName: FieldName
  • newValue: FieldType

  Returns void

setAlpha

• setAlpha(a: number): 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: boolean): void

  Parameters

  • enabled: boolean

  Returns void