Home Reference Source Test
import Renderable2DMultitex from 'seed-engine/src/component/Renderable2DMultitex.js'
public class | source

Renderable2DMultitex

Extends:

UpdateableComponentRenderable → Renderable2DMultitex

Renderable2DMultitex is a renderable component, similar to the Renderable2D, except it supports multiple textures. The program assigned to this renderable computes what to do with the shaders passed.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public

textures: *[]

Method Summary

Public Methods
public

addTexture(textureObject: textureJSONObject)

Adds a texture to this renderable.

public

removeTexture(textureIndex: number)

Removes the nth texture from this component.

public

Removes all textures from this renderable.

Inherited Summary

From class Updateable
public
public
public
public

id: *

public

Cleanup code for when destroying an Updateable.

public

end()

Base call function for when this Updateable is to be ended.

public

onEnd()

Called when the object is being removed or cleaned up from usage.

public

Called when the object is intended to be paused.

public

Called when the the object is first introduced.

public

Called when the object is to be unpaused from paused state.

public

Called on every update within the game, once the object has had onStart called.

public

pause()

Base call function for when this Updateable is to be paused.

public

start()

Base call function for when this Updateable is to be started.

public

Base call function for when this Updateable is to be unpaused.

public

update()

Base call function for when this Updateable is to be updated.

From class Component
public
public
public

Called when the component is successfully added to a GameObject.

From class Renderable
public

color: *

public
public
public
public
public

program: *

public
public

textures: *[]

private
private
private
private
private
public

addToViewport(viewportID: number): *

Adds this component to another viewport to be drawn.

public

getMatrix(): *

Returns a joined matrix of position, scale, rotation and origin adjustment.

public

Called immediatly after the Render component is added to a game object.

public

onEnd()

public

Removes the renderable from all viewports.

public
public

setColor(r: *, g: *, b: *, a: *)

public

setDepth(depth: *)

public

Sets the origin offset matrix to the new position point assigned.

public

setPosition(point: Point)

Sets the position matrix to the new position point assigned.

public

setRotation(rotation: number)

Sets the rotation matrix to the new rotation value assigned.

public

setScale(scale: Point)

Sets the scale matrix to the new scale point assigned.

public

setSubIndex(spriteIndex: *)

public

setTexture(textureObject: *)

public

setUniformData(positionMatrix: *): boolean

Public Constructors

public constructor() source

Constructor for the Renderable component. Allows defaults to be assigned without having to call setter functions later.

Override:

Renderable#constructor

Public Members

public className: string source

Override:

Component#className

public textures: *[] source

Override:

Renderable#textures

Public Methods

public addTexture(textureObject: textureJSONObject) source

Adds a texture to this renderable.

Params:

NameTypeAttributeDescription
textureObject textureJSONObject

Texture reference object, from TextureManager.

public removeTexture(textureIndex: number) source

Removes the nth texture from this component. Textures are pushed to end of list when added.

Params:

NameTypeAttributeDescription
textureIndex number

Index of texture to remove.

public removeTextures() source

Removes all textures from this renderable.