# Two.ImageSequence

Extends: Two.Rectangle

A convenient package to display still or animated images organized as a series of still images.

Source

# Constructor

Argument Description
paths A list of URLs or Two.Textures.
ox The initial x position of the Two.ImageSequence.
oy The initial y position of the Two.ImageSequence.
frameRate The frame rate at which the images should playback at.

# Properties

A list of properties that are on every Two.ImageSequence.

image-sequence.js:169

# DefaultFrameRate

default frame rate that Two.ImageSequence.frameRate is set to when instantiated.

image-sequence.js:182

# fromObject

Returns: Two.ImageSequence

Argument Description
obj Object notation of a Two.ImageSequence to create a new instance

Create a new Two.ImageSequence from an object notation of a Two.ImageSequence.

image-sequence.js:188

nota-bene

Works in conjunction with Two.ImageSequence.toObject

# textures

A list of textures to be used as frames for animating the Two.ImageSequence.

image-sequence.js:137

# frameRate

The number of frames to animate against per second.

image-sequence.js:152

# index

The index of the current tile of the sprite to display. Defaults to 0.

image-sequence.js:162

# copy

Argument Description
imageSequence The reference Two.ImageSequence

Copy the properties of one Two.ImageSequence onto another.

image-sequence.js:206

# play

Argument Description
firstFrame The index of the frame to start the animation with.
lastFrame The index of the frame to end the animation with. Defaults to the last item in the Two.ImageSequence.textures.
onLastFrame Optional callback function to be triggered after playing the last frame. This fires multiple times when the image sequence is looped.

Initiate animation playback of a Two.ImageSequence.

image-sequence.js:225

# pause

Halt animation playback of a Two.ImageSequence.

image-sequence.js:259

# stop

Halt animation playback of a Two.ImageSequence and set the current frame back to the first frame.

image-sequence.js:269

# clone

Returns: Two.ImageSequence

Argument Description
parent The parent group or scene to add the clone to.

Create a new instance of Two.ImageSequence with the same properties of the current image sequence.

image-sequence.js:281

# toObject

Returns: Object

Return a JSON compatible plain object that represents the path.

image-sequence.js:309

# dispose

Returns: Two.ImageSequence

Release the image sequence's renderer resources and detach all events. This method stops any running animation, clears animation callbacks, unbinds textures collection events, and disposes individual textures (calling dispose() for thorough cleanup) while preserving the renderer type for potential re-attachment to a new renderer.

image-sequence.js:328

← Two.SVGRenderer →