Class default

Protected_alpha

ProtectedattachedToScene

ProtectedchildViews

Protectedcontainer

isDestroyed

Protectedmaterial

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

endColor

• get endColor(): vec4

  Gets the color of the line at the end.

  Returns vec4
• set endColor(color: vec4): void

  Sets the color of the line at the end.

  Parameters

  • color: vec4

  Returns void

endWidth

• get endWidth(): number

  Gets the width of the line at the end.

  Returns number
• set endWidth(newWidth: number): void

  Sets the width of the line at the end.

  Parameters

  • newWidth: number

  Returns void

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

lookAtCamera

• get lookAtCamera(): boolean

  Returns boolean

• set lookAtCamera(isEnabled: boolean): void

  Parameters

  • isEnabled: boolean

  Returns void

name

• get name(): string

  Returns string

points

• get points(): vec3[]

  Returns a shallow copy of the array of points that the LineRenderer will draw a line between.

  Returns vec3[]
• set points(points: vec3[]): void

  Set the array of points that the LineRenderer will draw a line between.

  Parameters

  • points: vec3[]

  Returns void

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

startColor

• get startColor(): vec4

  Gets the color of the line at the start.

  Returns vec4
• set startColor(color: vec4): void

  Sets the color of the line at the start.

  Parameters

  • color: vec4

  Returns void

startWidth

• get startWidth(): number

  Gets the width of the line at the start.

  Returns number
• set startWidth(newWidth: number): void

  Sets the width of the line at the start.

  Parameters

  • newWidth: number

  Returns void

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 default<any>>(
      child: Child,
      configure?: (c: Child) => void,
      preserveWorldTransform?: boolean,
  ): Child

  Type Parameters

  • Child extends default<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 default<any>>(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 extends default<any>>(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 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
          default<
              Conf extends Partial<
                  {
                      defaults: Partial;
                      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 default<
        Conf extends Partial<
            {
                defaults: Partial;
                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: Partial,
      parentView: default<
          Partial<
              {
                  defaults: Partial;
                  enabled: boolean;
                  name: string;
                  position: vec3;
                  rotation: quat;
                  scale: number;
              },
          >,
      >,
  ): void

  Parameters

  • defaults: Partial
  • parentView: default<
        Partial<
            {
                defaults: Partial;
                enabled: boolean;
                name: string;
                position: vec3;
                rotation: quat;
                scale: number;
            },
        >,
    >

  Returns void

ProtectedrecursivelySetChildProperty

• recursivelySetChildProperty<
      FieldName extends keyof default,
      FieldType extends
      
              | string
              | number
              | boolean
              | vec4
              | vec3
              | quat
              | vec3[]
              | PublicApi<boolean>
              | (() => boolean)
              | (() => boolean)
              | (() => SceneObject)
              | (() => void)
              | ((color: vec4) => void)
              | ((index: number, newPos: vec3) => void)
              | ((a: number) => void)
              | ((callback: OnDestroyCallback) => void)
              | ((parent: SceneObject) => this)
              | (() => 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 default
  • FieldType extends
        | string
        | number
        | boolean
        | vec4
        | vec3
        | quat
        | vec3[]
        | PublicApi<boolean>
        | (() => boolean)
        | (() => boolean)
        | (() => SceneObject)
        | (() => void)
        | ((color: vec4) => void)
        | ((index: number, newPos: vec3) => void)
        | ((a: number) => void)
        | ((callback: OnDestroyCallback) => void)
        | ((parent: SceneObject) => this)
        | (() => 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

setSolidColor

• setSolidColor(color: vec4): void

  Sets line to a single solid color instead of a gradient

  Parameters

  • color: vec4

    color of the line

  Returns void

updateVertexPosition

• updateVertexPosition(index: number, newPos: vec3): void

  Updates position of point (in this._points) at the indicated index

  Parameters

  • index: number

    (index in the points[] array) of the vertex to be changed
  • newPos: vec3

    the vertex's new position

  Returns void