Class ElementCore

constructor

• new ElementCore(
      element: Lightning.Element<
          Lightning.Element.TemplateSpecLoose,
          Lightning.Element.TypeConfigLoose,
      >,
  ): Lightning.ElementCore

• Parameters

  • element: Lightning.Element<
        Lightning.Element.TemplateSpecLoose,
        Lightning.Element.TypeConfigLoose,
    >

  Returns Lightning.ElementCore

_brx

_bry

_h

_texturizer

_ulx

_uly

_w

_withinBoundsMargin

alpha

• get alpha(): number

• Returns number

• set alpha(v: number): void

• Parameters

  • v: number

  Returns void

boundsMargin

• get boundsMargin(): null | [number, number, number, number]

• Returns null | [number, number, number, number]

• set boundsMargin(v: null | [number, number, number, number]): void

• Parameters

  • v: null | [number, number, number, number]

  Returns void

clipbox

• get clipbox(): boolean

• Returns boolean

• set clipbox(v: boolean): void

• Parameters

  • v: boolean

  Returns void

clipping

• get clipping(): boolean

• Returns boolean

• set clipping(v: boolean): void

• Parameters

  • v: boolean

  Returns void

colorBl

• get colorBl(): number

• Returns number

• set colorBl(v: number): void

• Parameters

  • v: number

  Returns void

colorBr

• get colorBr(): number

• Returns number

• set colorBr(v: number): void

• Parameters

  • v: number

  Returns void

colorUl

• get colorUl(): number

• Returns number

• set colorUl(v: number): void

• Parameters

  • v: number

  Returns void

colorUr

• get colorUr(): number

• Returns number

• set colorUr(v: number): void

• Parameters

  • v: number

  Returns void

displayedTextureSource

• get displayedTextureSource(): Lightning.types.TextureSource

• Returns Lightning.types.TextureSource

element

• get element(): Lightning.Element<
      Lightning.Element.TemplateSpecLoose,
      Lightning.Element.TypeConfigLoose,
  >

• Returns Lightning.Element<
      Lightning.Element.TemplateSpecLoose,
      Lightning.Element.TypeConfigLoose,
  >

flex

• get flex(): Flex

• Returns Flex

• set flex(v: Flex): void

• Parameters

  • v: Flex

  Returns void

flexItem

• get flexItem(): FlexItem

• Returns FlexItem

• set flexItem(flexItem: FlexItem): void

• Parameters

  • flexItem: FlexItem

  Returns void

forceZIndexContext

• get forceZIndexContext(): boolean

• Returns boolean

• set forceZIndexContext(v: boolean): void

• Parameters

  • v: boolean

  Returns void

funcH

• get funcH(): undefined | (parentHeight: number) => number

• Returns undefined | (parentHeight: number) => number

• set funcH(v: undefined | (parentHeight: number) => number): void

• Parameters

  • v: undefined | (parentHeight: number) => number

  Returns void

funcW

• get funcW(): undefined | (parentWidth: number) => number

• Returns undefined | (parentWidth: number) => number

• set funcW(v: undefined | (parentWidth: number) => number): void

• Parameters

  • v: undefined | (parentWidth: number) => number

  Returns void

h

• get h(): number

• Returns number

isRoot

• get isRoot(): boolean

• Returns boolean

mount

• get mount(): number

• Returns number

• set mount(v: number): void

• Parameters

  • v: number

  Returns void

mountX

• get mountX(): number

• Returns number

• set mountX(v: number): void

• Parameters

  • v: number

  Returns void

mountY

• get mountY(): number

• Returns number

• set mountY(v: number): void

• Parameters

  • v: number

  Returns void

offsetX

• get offsetX(): number | (parentWidth: number) => number

• Returns number | (parentWidth: number) => number

• set offsetX(v: number | (parentWidth: number) => number): void

• Parameters

  • v: number | (parentWidth: number) => number

  Returns void

offsetY

• get offsetY(): number | (parentHeight: number) => number

• Returns number | (parentHeight: number) => number

• set offsetY(v: number | (parentHeight: number) => number): void

• Parameters

  • v: number | (parentHeight: number) => number

  Returns void

onAfterCalcs

• set onAfterCalcs(
      f:
          | undefined
          | OnAfterCalcsCallback<
              Lightning.Element<
                  Lightning.Element.TemplateSpecLoose,
                  Lightning.Element.TypeConfigLoose,
              >,
          >,
  ): void

• Parameters

  • f:
        | undefined
        | OnAfterCalcsCallback<
            Lightning.Element<
                Lightning.Element.TemplateSpecLoose,
                Lightning.Element.TypeConfigLoose,
            >,
        >

  Returns void

onAfterUpdate

• set onAfterUpdate(
      f:
          | undefined
          | OnAfterUpdateCallback<
              Lightning.Element<
                  Lightning.Element.TemplateSpecLoose,
                  Lightning.Element.TypeConfigLoose,
              >,
          >,
  ): void

• Parameters

  • f:
        | undefined
        | OnAfterUpdateCallback<
            Lightning.Element<
                Lightning.Element.TemplateSpecLoose,
                Lightning.Element.TypeConfigLoose,
            >,
        >

  Returns void

onUpdate

• set onUpdate(
      f:
          | undefined
          | OnUpdateCallback<
              Lightning.Element<
                  Lightning.Element.TemplateSpecLoose,
                  Lightning.Element.TypeConfigLoose,
              >,
          >,
  ): void

• Parameters

  • f:
        | undefined
        | OnUpdateCallback<
            Lightning.Element<
                Lightning.Element.TemplateSpecLoose,
                Lightning.Element.TypeConfigLoose,
            >,
        >

  Returns void

pivot

• get pivot(): number

• Returns number

• set pivot(v: number): void

• Parameters

  • v: number

  Returns void

pivotX

• get pivotX(): number

• Returns number

• set pivotX(v: number): void

• Parameters

  • v: number

  Returns void

pivotY

• get pivotY(): number

• Returns number

• set pivotY(v: number): void

• Parameters

  • v: number

  Returns void

renderContext

• get renderContext(): RenderContext

• Returns RenderContext

rotation

• get rotation(): number

• Returns number

• set rotation(v: number): void

• Parameters

  • v: number

  Returns void

rtl

• get rtl(): boolean

• Returns boolean

• set rtl(value: boolean): void

• Parameters

  • value: boolean

  Returns void

scale

• get scale(): number

• Returns number

• set scale(v: number): void

• Parameters

  • v: number

  Returns void

scaleX

• get scaleX(): number

• Returns number

• set scaleX(v: number): void

• Parameters

  • v: number

  Returns void

scaleY

• get scaleY(): number

• Returns number

• set scaleY(v: number): void

• Parameters

  • v: number

  Returns void

shader

• get shader(): undefined | Lightning.types.Shader

• Returns undefined | Lightning.types.Shader

• set shader(v: undefined | Lightning.types.Shader): void

• Parameters

  • v: undefined | Lightning.types.Shader

  Returns void

texturizer

• get texturizer(): ElementTexturizer

• Returns ElementTexturizer

visible

• get visible(): boolean

• Returns boolean

• set visible(v: boolean): void

• Parameters

  • v: boolean

  Returns void

w

• get w(): number

• Returns number

x

• get x(): number

• Returns number

y

• get y(): number

• Returns number

zIndex

• get zIndex(): number

• Returns number

• set zIndex(v: number): void

• Parameters

  • v: number

  Returns void

collectAtCoord

• collectAtCoord(x: number, y: number, children: Lightning.ElementCore[]): void

• Fill the array children with all the ElementCore instances (including itself and its children) that intersect the point (x, y)

  To enforce z-sorting, the result should be sorted using ElementCore.sortZIndexedChildren.

  Parameters

  • x: number
  • y: number
  • children: Lightning.ElementCore[]

  Returns void

disableFuncH

• disableFuncH(): void

• Returns void

disableFuncW

• disableFuncW(): void

• Returns void

getAbsoluteCoords

• getAbsoluteCoords(relX: number, relY: number): [number, number]

• Parameters

  • relX: number
  • relY: number

  Returns [number, number]

getCornerPoints

• getCornerPoints(): [
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
  ]

• Returns [number, number, number, number, number, number, number, number]

getRenderHeight

• getRenderHeight(): number

• Returns number

getRenderTextureCoords

• getRenderTextureCoords(relX: number, relY: number): [number, number]

• Parameters

  • relX: number
  • relY: number

  Returns [number, number]

getRenderWidth

• getRenderWidth(): number

• Returns number

inBound

• inBound(tx: number, ty: number): boolean

• Parameters

  • tx: number
  • ty: number

  Returns boolean

inScissor

• inScissor(): boolean

• Returns boolean

setAsRoot

• setAsRoot(): void

• Returns void

setDimensions

• setDimensions(w: number, h: number, isEstimate?: boolean): boolean

• Parameters

  • w: number
  • h: number
  • OptionalisEstimate: boolean

  Returns boolean

setDisplayedTextureSource

• setDisplayedTextureSource(textureSource?: Lightning.types.TextureSource): void

• Parameters

  • OptionaltextureSource: Lightning.types.TextureSource

  Returns void

setHasRenderUpdates

• setHasRenderUpdates(type: number): void

• Parameters

  • type: number

  Returns void

setTextureCoords

• setTextureCoords(ulx: number, uly: number, brx: number, bry: number): void

• Parameters

  • ulx: number
  • uly: number
  • brx: number
  • bry: number

  Returns void

update

• update(): void

• Returns void

StaticsortZIndexedChildren

• sortZIndexedChildren(a: Lightning.ElementCore, b: Lightning.ElementCore): number

• Parameters

  • a: Lightning.ElementCore
  • b: Lightning.ElementCore

  Returns number