Skip to content

feat: add/remove instantiated scenes from the engine #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
browles wants to merge 1 commit into from
Closed

feat: add/remove instantiated scenes from the engine #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 43 additions & 4 deletions core/FamousEngine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
/**
* The MIT License (MIT)
*
*
* Copyright (c) 2015 Famous Industries Inc.
*
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Expand Down Expand Up @@ -354,6 +354,45 @@ FamousEngine.prototype.createScene = function createScene (selector) {
return this._scenes[selector];
};

/**
* Introduce an already instantiated scene to the engine.
*
* @method
*
* @param {Scene} scene the scene to reintroduce to the engine
*
* @return {FamousEngine} this
*/
FamousEngine.prototype.addScene = function addScene (scene) {
var selector = scene._selector;

var current = this._scenes[selector];
if (current && current !== scene) current.dismount();
if (!scene.isMounted()) scene.mount();
this._scenes[selector] = scene;
return this;
};

/**
* Remove a scene.
*
* @method
*
* @param {Scene} scene the scene to remove from the engine
*
* @return {FamousEngine} this
*/
FamousEngine.prototype.removeScene = function removeScene (scene) {
var selector = scene._selector;

var current = this._scenes[selector];
if (current && current === scene) {
if (scene.isMounted()) scene.dismount();
delete this._scenes[selector];
}
return this;
};

/**
* Starts the engine running in the Main-Thread.
* This effects **every** updateable managed by the Engine.
Expand Down
74 changes: 52 additions & 22 deletions core/test/FamousEngine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
/**
* The MIT License (MIT)
*
*
* Copyright (c) 2015 Famous Industries Inc.
*
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Expand Down Expand Up @@ -44,7 +44,7 @@ test('FamousEngine', function(t) {
t.test('requestUpdate method (basic)', function(t) {
t.plan(4);
t.equal(typeof FamousEngine.requestUpdate, 'function', 'FamousEngine.requestUpdate should be a function');

FamousEngine.getChannel().onmessage = function(commands) {
t.deepEqual(
commands,
Expand Down Expand Up @@ -80,27 +80,27 @@ test('FamousEngine', function(t) {
t.test('requestUpdate method (nested)', function(t) {
t.plan(1);
var executionOrder = [];

FamousEngine.requestUpdate(onUpdateWrap(function() {
executionOrder.push(0);

FamousEngine.requestUpdate(onUpdateWrap(function() {
executionOrder.push(2);

FamousEngine.requestUpdate(onUpdateWrap(function() {
executionOrder.push(3);
}));
}));
}));

FamousEngine.requestUpdate(onUpdateWrap(function() {
executionOrder.push(1);
}));

FamousEngine.step(0);
FamousEngine.step(1);
FamousEngine.step(2);

t.deepEqual(executionOrder, [ 0, 1, 2, 3 ]);
});

Expand All @@ -112,7 +112,7 @@ test('FamousEngine', function(t) {
FamousEngine.step(10);
}, 'FamousEngine.requestUpdate method should not throw an error when being invoked');
});

t.test('requestUpdateOnNextTick method', function(t) {
t.equal(typeof FamousEngine.requestUpdateOnNextTick, 'function', 'FamousEngine.requestUpdateOnNextTick should be a function');
var executionOrder = [];
Expand All @@ -125,7 +125,7 @@ test('FamousEngine', function(t) {
FamousEngine.requestUpdateOnNextTick(onUpdateWrap(function() {
executionOrder.push(1);
}));

t.deepEqual(executionOrder, []);
FamousEngine.step(0);
t.deepEqual(executionOrder, [ 0, 1 ]);
Expand All @@ -144,31 +144,61 @@ test('FamousEngine', function(t) {
t.equal(FamousEngine.getClock().now(), 125);
FamousEngine.getChannel().postMessage(['FRAME', 126]);
t.equal(FamousEngine.getClock().now(), 126);

t.end();
});

t.test('createScene method', function(t) {
t.equal(typeof FamousEngine.createScene, 'function', 'FamousEngine.createScene should be a function');
var scene0 = FamousEngine.createScene('.div-0');
var scene1 = FamousEngine.createScene('.div-1');

t.equal(scene0.constructor, Scene, 'FamousEngine.createScene should return Scene instances');
t.equal(scene1.constructor, Scene, 'FamousEngine.createScene should return Scene instances');
t.notEqual(scene0, scene1, 'FamousEngine.createScene being invoked on two different selectors should return different scene instances');


FamousEngine.getChannel().onmessage = function() {};
FamousEngine.step(0);
t.end();
});

t.test('addScene method', function(t) {
t.equal(typeof FamousEngine.addScene, 'function', 'FamousEngine.addScene should be a function');
var scene0 = FamousEngine.createScene('.div-1');
var scene1 = new Scene('.div-1', FamousEngine);
scene1.dismount();

FamousEngine.addScene(scene0);
t.assert(scene0.isMounted(), 'FamousEngine.addScene should mount the added scene');
t.assert(!scene1.isMounted(), 'FamousEngine.addScene should dismount a scene if one exists at the selector');
t.assert(FamousEngine._scenes['.div-1'] === scene0, 'FamousEngine.addScene should track scenes correctly');

FamousEngine.getChannel().onmessage = function() {};
FamousEngine.step(0);
t.end();
});


t.test('removeScene method', function(t) {
t.equal(typeof FamousEngine.removeScene, 'function', 'FamousEngine.removeScene should be a function');
var scene0 = FamousEngine.createScene('.div-0');

FamousEngine.removeScene(scene0);

t.assert(!scene0.isMounted(), 'FamousEngine.removeScene should dismount the removed scene');
t.assert(FamousEngine._scenes['.div-0'] == null, 'FamousEngine.removeScene should remove references to the scene');

FamousEngine.getChannel().onmessage = function() {};
FamousEngine.step(0);
t.end();
});

t.test('getClock method', function(t) {
t.plan(3);
t.equal(typeof FamousEngine.getClock, 'function', 'FamousEngine.getClock should be a function');
t.equal(FamousEngine.getClock().constructor, Clock, 'FamousEngine.getClock should return clock instance');
t.equal(FamousEngine.getClock(), FamousEngine.getClock(), 'FamousEngine.getClock should return clock singleton');
});

t.test('step method', function(t) {
t.plan(3);
t.equal(typeof FamousEngine.step, 'function', 'FamousEngine.step should be a function');
Expand All @@ -183,17 +213,17 @@ test('FamousEngine', function(t) {
t.equal(FamousEngine.getClock().getTime(), 3141, 'FamousEngine.step should update clock');
FamousEngine.message(3142);
FamousEngine.step(3143);

t.deepEqual(
receivedMessages,
[ [ 'TIME', 3141, 'm', 'and', 'ms' ], [ 'TIME', 3143, 3142 ] ]
);
});

t.test('handleFrame method', function(t) {
t.plan(2);
t.equal(typeof FamousEngine.handleFrame, 'function', 'FamousEngine.handleFrame should be a function');

// complete received command would be ['FRAME', 10]
FamousEngine.handleFrame([10]);
t.equal(FamousEngine.getClock().getTime(), 10, 'FamousEngine.handleFrame should update internal clock');
Expand Down