Repository

ImageSequenceTexture

Extends:

Component → ImageSequenceTexture

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public
public
public
public
public
public
public
public
public
public
public

timer: *

Method Summary

Public Methods
public

Get the current Image Sequence frame Texture

public

loop(count: Number)

Loop the image sequence for a given number of iterations (once play() is called).

public

pause the Image Sequence.

public

play()

play the Image Sequence.

public

setCurrentFrame(frame: *)

Set the current frame to force the play head, can be used on pause to manually control the play head

public

setEnterFrame(frame: Integer)

Set the starting frame of the current loaded sequence.

public

setMode(mode: String)

Set the sequence playing mode.

public

setOutFrame(frame: Integer)

Set the ending frame of the current loaded sequence.

public
public

stop()

stop the Image Sequence.

public

update the Image sequence.

Inherited Summary

From class Component
public
public
public

events: *

public

id: *

public

name: *

private

_nexts: *[]

private
public
public

chain(component: Component)

Adds a component to this chained component array

public

Returns the array of attached children components

public

off()

Deactivate the component

public

on()

Activate the component A call to this method calls the setup method if it has not been run yet

public

Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism

public

preLoad the component This empty method is usually overriden to perform setup actions for the component.

public

Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism

public

Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly

public

Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Public Constructors

public constructor(params: Object) source

Override:

Component#constructor

Params:

NameTypeAttributeDescription
paramsObject

Parameters object, given by the constructor.

params.fpsNumber

the frame per second of this sequence

params.sequenceModeString

the mode of playing for this sequence. One of "forward", "backward", "pingpong", "random".

params.directionNumber

the direction of the play head. 1 for forward, -1 for backward

params.lapsToDoNumber

the number of loop to do before to stop the animation

params.texturesArray <Texture>

the texture array that make the image sequence

Public Members

public currentFrame: number source

public direction: * source

public enterFrame: number source

public frameCount: * source

public frameRate: * source

public laps: number source

public lapsToDo: * source

public outFrame: * source

public playing: boolean source

public sequenceMode: * source

public textures: * source

public timer: * source

Public Methods

public getCurrentTexture(): Texture source

Get the current Image Sequence frame Texture

Return:

Texture

the texture

public loop(count: Number) source

Loop the image sequence for a given number of iterations (once play() is called).

Params:

NameTypeAttributeDescription
countNumber

: -1 means infinity.

public pause() source

pause the Image Sequence.

public play() source

play the Image Sequence.

public setCurrentFrame(frame: *) source

Set the current frame to force the play head, can be used on pause to manually control the play head

Params:

NameTypeAttributeDescription
frame*

public setEnterFrame(frame: Integer) source

Set the starting frame of the current loaded sequence.

Params:

NameTypeAttributeDescription
frameInteger

starting frame.

public setMode(mode: String) source

Set the sequence playing mode.

Params:

NameTypeAttributeDescription
modeString

playing mode : "forward", "backward", "pingpong", "random".

public setOutFrame(frame: Integer) source

Set the ending frame of the current loaded sequence.

Params:

NameTypeAttributeDescription
frameInteger

ending frame.

public setup() source

Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly

Override:

Component#setup

public stop() source

stop the Image Sequence. The image frame is resetted.

public updateSequence() source

update the Image sequence. You have to call this once per frame for the Image sequence Texture to update and run its own logic.