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

AtlasSprite

Extends:

ComponentVerticesRendererRectangleRendererSprite → AtlasSprite

Atlas sprite renderer.

Example:

const component = new AtlasSprite();
component.deserialize({ shader: 'shader://sprite.json', atlas: 'atlas://sheet.json:box.png' });

Static Member Summary

Static Public Members
public static get

Static Method Summary

Static Public Methods
public static

Component factory.

Constructor Summary

Public Constructor
public

Constructor.

Member Summary

Public Members
public get
public set
public
public
public
public
public get
public set
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)

From class RectangleRenderer
public static get

propsTypes: {"visible": *, "shader": *, "overrideUniforms": *, "overrideSamplers": *, "layers": *, "width": string, "height": string, "xOffset": string, "yOffset": string, "xOrigin": string, "yOrigin": string, "color": string}

public static

factory(): *

public get

color: *

public set
public get

height: *

public set
public get

width: *

public set
public get

xOffset: *

public set
public get

xOrigin: *

public set
public get

yOffset: *

public set
public get

yOrigin: *

public set
public
public
public
public

ensureVertices(renderer: *)

public
public

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

public

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

From class Sprite
public static get

propsTypes: {"visible": *, "shader": *, "overrideUniforms": *, "overrideSamplers": *, "layers": *, "width": *, "height": *, "xOffset": *, "yOffset": *, "xOrigin": *, "yOrigin": *, "color": *, "overrideBaseTexture": string, "overrideBaseFiltering": string, "frameTopLeft": string, "frameBottomRight": string}

public static

factory(): *

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

ensureVertices(renderer: *)

public

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

Static Public Members

public static get propsTypes: * source

Override:

Sprite#propsTypes

Static Public Methods

public static factory(): AtlasSprite source

Component factory.

Override:

Sprite#factory

Return:

AtlasSprite

Component instance.

Public Constructors

public constructor() source

Constructor.

Override:

Sprite#constructor

Public Members

public get atlas: string | null source

public set atlas: string | null source

public frameBottomRight: number[] source

Override:

Sprite#frameBottomRight

public frameTopLeft: number[] source

Override:

Sprite#frameTopLeft

public height: number source

Override:

RectangleRenderer#height

public overrideBaseTexture: string source

Override:

Sprite#overrideBaseTexture

public get scale: number source

public set scale: number source

public width: number source

Override:

RectangleRenderer#width