forked from jywarren/image-sequencer
-
Notifications
You must be signed in to change notification settings - Fork 210
Development
Chinmay Pandhare edited this page May 30, 2017
·
3 revisions
- One Sequencer instance must be capable of handling multiple images
- Images should have a Unique ID
- GPU Acceleration where applicable
- Modules need to be implemented
- addStep, removeStep, insertStep should support JSON type I/O.
This module is responsible for defining all the core functions of the library : addStep/addSteps, removeStep/removeSteps, insertStep/insertSteps, run.
It Contains the Function ImageSequencer which is responsible for initiating a sequencer when it is run, like:
sequencer = ImageSequencer();
. sequencer
is initialized as:
sequencer = {
options: [Object],
loadImage: [Function],
images: [Object],
modules: [Object],
ui: [Object],
addStep: [Function],
removeStep: [Function],
insertStep: [Function],
run: [Function]
}
- options: Contains preferences/settings for the functioning of the Image Sequencer. Also contains the image URLs inputted by the user.
options = {
inBrowser: [Bool], //stores if the user is a browser
}
- addStep/addSteps: adds step/s.
- accepted parameters : either an image module-name pair or a JSON of multiple images with one or more modules each. The image name may be omitted if there is only one image. the 'addStep' and 'addSteps' would be a single function. the extra 's' is just for aesthetics.
addStep('module-1')
addSteps(['module-1', 'module-2', ...])
addStep('image1','module-1')
addSteps('image1',['module-1', 'module-2', ...])
addSteps({image1: 'module-1', image2: 'module-2', ... })
addSteps({image1: ['module-1','module-2'], image2: ['module-3','module-4'], ...})
- return value : none.
- actions : adds another step to the image sequencer under the specified/default image/s.
- accepted parameters : either an image module-name pair or a JSON of multiple images with one or more modules each. The image name may be omitted if there is only one image. the 'addStep' and 'addSteps' would be a single function. the extra 's' is just for aesthetics.