Home Reference Source
import UiSprite from 'oxygen-core/components/UiSprite.js'
public class | source

UiSprite

Extends:

ComponentVerticesRenderer → UiSprite

Static Member Summary

Static Public Members
public static get

propsTypes: {"visible": *, "shader": *, "overrideUniforms": *, "overrideSamplers": *, "layers": *, "overrideBaseTexture": string, "overrideBaseFiltering": string, "camera": string, "width": string, "height": string, "widthAnchor": string, "heightAnchor": string, "xOrigin": string, "yOrigin": string, "topOffset": string, "bottomOffset": string, "leftOffset": string, "rightOffset": string, "topBorder": string, "bottomBorder": string, "leftBorder": string, "rightBorder": string, "atlas": string, "color": string}

Static Method Summary

Static Public Methods
public static

factory(): *

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

atlas: *

public set
public get
public set
public get
public set
public get
public get
public get

camera: *

public set
public get

color: *

public set
public get

height: *

public set
public get
public set
public
public get
public set
public get
public set
public get
public set
public get
public set
public
public
public get
public set
public get
public set
public get
public set
public get
public set
public
public get

width: *

public set
public get
public set
public get

xOrigin: *

public set
public get

yOrigin: *

public set

Method Summary

Public Methods
public
public

ensureVertices(renderer: *)

public

onAction(name: *, args: ...*): *

public
public

onCameraChanged(camera: *)

public

onPropertySerialize(name: *, value: *): *

public

onRender(gl: *, renderer: *, deltaTime: *, layer: *)

public

Inherited Summary

From class Component
public static get
public static

Component factory.

public get
public

[name]: *

public

deserialize(json: *)

Deserialize JSON properties into this component.

public

Destructor (dispose internal resources and detach from entity).

public

onAction(name: string, args: *)

Called when action arrived.

public

onAlterActionArguments(name: string, args: *): array | undefined

Called when asked to alter arrived action parameters.

public

Called after attached to entity.

public

Called before detached from entity.

public

onPropertySerialize(name: string, value: *): *

Called when property is serialized.

public

onPropertySetup(name: string, value: *)

Called when given property is deserialized.

public

serialize(): *

Serialize component into JSON data.

From class VerticesRenderer
public static get
public static get
public static get

propsTypes: {"visible": string, "shader": string, "vertices": string, "indices": string, "verticesUsage": string, "indicesUsage": string, "overrideUniforms": string, "overrideSamplers": string, "renderMode": string, "layers": string}

public static

factory(): *

public get

indices: *

public set
public get
public set
public get
public set
public get
public set
public get
public set
public get
public set
public get

shader: *

public set
public get
public set
public get
public set
public get

visible: *

public set
public
public

onAction(name: *, args: ...*): *

public

onPreview(gl: *, renderer: *, deltaTime: *)

public

onPropertySerialize(name: *, value: *): *

public

onRender(gl: *, renderer: *, deltaTime: *, layer: *)

public

onRenderLayer(gl: *, renderer: *, deltaTime: *, layer: *)

public
public

updateIndicesChunk(data: *, offset: *, size: number)

public

updateVerticesChunk(data: *, offset: *, size: number)

Static Public Members

public static get propsTypes: {"visible": *, "shader": *, "overrideUniforms": *, "overrideSamplers": *, "layers": *, "overrideBaseTexture": string, "overrideBaseFiltering": string, "camera": string, "width": string, "height": string, "widthAnchor": string, "heightAnchor": string, "xOrigin": string, "yOrigin": string, "topOffset": string, "bottomOffset": string, "leftOffset": string, "rightOffset": string, "topBorder": string, "bottomBorder": string, "leftBorder": string, "rightBorder": string, "atlas": string, "color": string} source

Override:

VerticesRenderer#propsTypes

Static Public Methods

public static factory(): * source

Component factory.

Override:

VerticesRenderer#factory

Return:

*

Public Constructors

public constructor() source

Constructor.

Override:

VerticesRenderer#constructor

Public Members

public get atlas: * source

public set atlas source

public get bottomBorder: * source

public set bottomBorder source

public get bottomOffset: * source

public set bottomOffset source

public get cachedHeight: * source

public get cachedWidth: * source

public get camera: * source

public set camera source

public get color: * source

public set color source

public get height: * source

public set height source

public get heightAnchor: * source

public set heightAnchor source

public indices: number[] source

Override:

VerticesRenderer#indices

public get leftBorder: * source

public set leftBorder source

public get leftOffset: * source

public set leftOffset source

public get overrideBaseFiltering: * source

public set overrideBaseFiltering source

public get overrideBaseTexture: * source

public set overrideBaseTexture source

public overrideSamplers: * source

Override:

VerticesRenderer#overrideSamplers

public overrideUniforms: * source

Override:

VerticesRenderer#overrideUniforms

public get rightBorder: * source

public set rightBorder source

public get rightOffset: * source

public set rightOffset source

public get topBorder: * source

public set topBorder source

public get topOffset: * source

public set topOffset source

public vertices: undefined[] source

Override:

VerticesRenderer#vertices

public get width: * source

public set width source

public get widthAnchor: * source

public set widthAnchor source

public get xOrigin: * source

public set xOrigin source

public get yOrigin: * source

public set yOrigin source

Public Methods

public dispose() source

Destructor (dispose internal resources and detach from entity).

Override:

VerticesRenderer#dispose

public ensureVertices(renderer: *) source

Params:

NameTypeAttributeDescription
renderer *

public onAction(name: *, args: ...*): * source

Called when action arrived.

Override:

VerticesRenderer#onAction

Params:

NameTypeAttributeDescription
name *
args ...*

Return:

*

public onAttach() source

Called after attached to entity.

Override:

Component#onAttach

public onCameraChanged(camera: *) source

Params:

NameTypeAttributeDescription
camera *

public onPropertySerialize(name: *, value: *): * source

Called when property is serialized.

Override:

VerticesRenderer#onPropertySerialize

Params:

NameTypeAttributeDescription
name *
value *

Return:

*

public onRender(gl: *, renderer: *, deltaTime: *, layer: *) source

Override:

VerticesRenderer#onRender

Params:

NameTypeAttributeDescription
gl *
renderer *
deltaTime *
layer *

public recalculateSize() source