Class MovieLoop

Object
   |
   +--ToolBase
         |
         +--MovieLoop

class MovieLoop

extends ToolBase

Defined in MovieLoop.js

Author: Adair

Field Detail

delay

Object delay

frameIncrement

Object frameIncrement

frameIsLoading

Object frameIsLoading

isRunning

Object isRunning

maxFrames

Object maxFrames

movieTimer

Object movieTimer

timestampIndex

Object timestampIndex

MovieLoop

MovieLoop(toolNode, model)

Controller for a movie loop. Set framesPerSec to control the frame rate and frameIncrement (+n/-n) to control the steps through the loop (n is number of frames to increment.

Parameters:
toolNode - The tool node from the config document for this tool
model - the model object that contains this tool

Author: Adair

init

void init(objRef)

initialize the movie loop. This only happens at the first bbox event, which shows us that the map is loaded.

nextFrame

void nextFrame(step)

Advances the frame array by the frame increment.

Parameters:
step - optional parameter to override default frame increment

pause

void pause()

Stops the JavaScript movie loop timer.

play

void play()

Starts the movie loop playing by using a JavaScript timer.

reset

void reset(objRef)

Resets the frame index to the firstFrame property

Parameters:
objRef - pointer to this object

setFrame

void setFrame(index)

Sets the frame to the specified index in the frame array

Parameters:
index - the 0-based frame index in the frame array

setFrameLimits

void setFrameLimits(objRef)

Listener fucntion to set the start and end frames based on the firstFrame and maxFrames property values.

Parameters:
objRef - pointer to this object

stop

void stop()

Stops the JavaScript movie loop timer and sets the index back to the first frame.

stopListener

void stopListener(objRef)

A "stopLoop" event listener to call the stop method

Parameters:
objRef - pointer to this object

uninit

void uninit(objRef)

set the initialized state of the movie loop to false