import RenderableText from 'seed-engine/src/component/RenderableText.js'

public class | source

RenderableText

Extends:

Updateable → Component → Renderable → Renderable2DMultitex → RenderableText

RenderableText is a renderable component which renders a line of text from a collection of string data. The string data is loaded into the GPU using textures

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	className: string
public	fontTexture: *
public	renderableTextID: *
public	shaderFontData: *[]
public	textAlign: number
public	textData: {"text": , "textPixelArray": , "textPixelWidth": *}

Method Summary

Public Methods
public	buildShaderTileData()
public	onPause()
public	onUnpause()
public	setGridData()
public	setText(textString: , fontScale: )
public	setTextAlign(textAlign: *)
public	setUniformData(positionMatrix: *): boolean

Inherited Summary

From class Updateable
public	deregister: *
public	hasPaused: boolean
public	hasStarted: boolean
public	id: *
public	destructor() 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	onPause() Called when the object is intended to be paused.
public	onStart() Called when the the object is first introduced.
public	onUnpause() Called when the object is to be unpaused from paused state.
public	onUpdate() 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	unpause() 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	className: string
public	isUnique: *
public	onAddComponent() Called when the component is successfully added to a GameObject.

From class Renderable
public	color: *
public	depth: number
public	deregisterViewports: {}
public	primitiveCount: number
public	primitiveType: *
public	program: *
public	renderPositions: number[]
public	textures: *[]
private	_matrixOriginOffset: *
private	_matrixPosition: *
private	_matrixRotation: *
private	_matrixScale: *
private	_subSpriteData: number[]
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	onAddComponent() Called immediatly after the Render component is added to a game object.
public	onEnd()
public	removeFromViewports() Removes the renderable from all viewports.
public	requestRedraw()
public	setColor(r: , g: , b: , a: )
public	setDepth(depth: *)
public	setOriginOffset(point: Point) 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

From class Renderable2DMultitex
public	className: string
public	textures: *[]
public	addTexture(textureObject: textureJSONObject) Adds a texture to this renderable.
public	removeTexture(textureIndex: number) Removes the nth texture from this component.
public	removeTextures() Removes all textures from this renderable.

Public Constructors

public constructor() source

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

Override:

Renderable2DMultitex#constructor

Public Members

public className: string source

Override:

Renderable2DMultitex#className

public fontTexture: * source

public renderableTextID: * source

public shaderFontData: *[] source

public textAlign: number source

public textData: {"text": , "textPixelArray": , "textPixelWidth": *} source

Public Methods

public buildShaderTileData() source

public onPause() source

Called when the object is intended to be paused.

Override:

Updateable#onPause

public onUnpause() source

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

Override:

Updateable#onUnpause

public setGridData() source

public setText(textString: , fontScale: ) source

Params:

Name	Type	Attribute	Description
textString	*
fontScale	*

public setTextAlign(textAlign: *) source

Params:

Name	Type	Attribute	Description
textAlign	*

public setUniformData(positionMatrix: *): boolean source

Override:

Renderable#setUniformData

Params:

Name	Type	Attribute	Description
positionMatrix	*

Return:

boolean

RenderableText

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public className: string source

Override:

public fontTexture: * source

public renderableTextID: * source

public shaderFontData: *[] source

public textAlign: number source

public textData: {"text": *, "textPixelArray": *, "textPixelWidth": *} source

Public Methods

public buildShaderTileData() source

public onPause() source

Override:

public onUnpause() source

Override:

public setGridData() source

public setText(textString: *, fontScale: *) source

Params:

public setTextAlign(textAlign: *) source

Params:

public setUniformData(positionMatrix: *): boolean source

Override:

Params:

Return:

public textData: {"text": , "textPixelArray": , "textPixelWidth": *} source

public setText(textString: , fontScale: ) source