Skip to content
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

Started cleaning some things in the state machine. #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Started cleaning some things in the state machine. #6

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
269 changes: 239 additions & 30 deletions src/goo/fsmpack/statemachine/Machine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ define([], function (

function Machine(name) {
this.name = name;
this._states = {};
this._fsm = null;
this.initialState = 'entry';
this.currentState = null;
Expand All @@ -13,18 +14,23 @@ define([], function (

Machine.prototype.setRefs = function (parentFSM) {
this._fsm = parentFSM;
var keys = Object.keys(this._states);
for (var i = 0; i < keys.length; i++) {
var state = this._states[keys[i]];
this.forEachState(function (state) {
state.setRefs(parentFSM);
}
});
};

/**
* Updates the state machine and triggers any state changes that might need
* to occur.
*
* @returns {boolean}
* Whether a jump ocurred.
*/
Machine.prototype.update = function () {
if (this.currentState) {
var jump = this.currentState.update();

if (jump && this.contains(jump)) {
if (jump && this.hasState(jump)) {
this.currentState.kill();
this.setState(this._states[jump]);
}
Expand All @@ -33,21 +39,32 @@ define([], function (
}
};

Machine.prototype.contains = function (uuid) {
return !!this._states[uuid];
};

/**
* Enters the specified state of the machine.
*
* @param {State} state
* The state which is to be entered.
*
* @returns {Machine}
* The machine itself.
*/
Machine.prototype.setState = function (state) {
// change state
this.currentState = state;

// reset initial state of child machines
this.currentState.reset();

// do on enter of new state
this.currentState.enter();

return this;
};

/**
* Resets the machine to its default state.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.reset = function () {
// reset self
this.currentState = this._states[this.initialState];
Expand All @@ -56,76 +73,268 @@ define([], function (
if (this.currentState) {
this.currentState.reset();
}

return this;
};

/**
* Kills the machine.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.kill = function () {
if (this.currentState) {
this.currentState.kill();
}

return this;
};

/**
* Marks all the states in the machine as ready.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.ready = function () {
var keys = Object.keys(this._states);
for (var i = 0; i < keys.length; i++) {
var state = this._states[keys[i]];
this.forEachState(function (state) {
state.ready();
}
});

return this;
};

/**
* Cleans up all the states of the machine.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.cleanup = function () {
var keys = Object.keys(this._states);
for (var i = 0; i < keys.length; i++) {
var state = this._states[keys[i]];
this.forEachState(function (state) {
state.cleanup();
}
});

return this;
};

/**
* Enters the current state of the machine.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.enter = function () {
if (this.currentState) {
this.currentState.enter();
}

return this;
};

/**
* Gets the current state of the machine.
*
* @return {State}
*/
Machine.prototype.getCurrentState = function () {
return this.currentState;
};

/**
* Adds the specified state to the machine.
*
* @param {State} state
* The state which is to be added.
*
* @returns {Machine}
* The machine itself.
*/
Machine.prototype.addState = function (state) {
if (!this._states) {
this._states = {};
if (!this.hasStates()) {
this.initialState = state.uuid;
}
state.parent = this;
state._fsm = this._fsm;
state.setParentFSM(this._fsm);
this._states[state.uuid] = state;

return this;
};

/**
* Removes the machine from its parent machine.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.removeFromParent = function () {
if (this.parent) {
this.parent.removeMachine(this);
}

return this;
};

/**
* Recursively removes all the states from the machine.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.recursiveRemove = function () {
var keys = Object.keys(this._states);
for (var i = 0; i < keys.length; i++) {
var state = this._states[keys[i]];
this.forEachState(function (state) {
state.recursiveRemove();
}
});
this._states = {};

return this;
};

/**
* Removes the state with the specified id from the machine.
*
* @param {string} id
* The identifier of the state which is to be removed.
*
* @return {Machine}
* The machine itself.
*/
Machine.prototype.removeState = function (id) {
if (!this._states[id]) { return; }
if (this.initialState === id) { throw new Error('Cannot remove initial state'); }
if (!this.hasState(id)) { return; }
if (this.initialState === id) {
throw new Error('Cannot remove initial state');
}

if (this.currentState === this._states[id]) {
this.reset();
}
delete this._states[id];

return this;
};

/**
* Sets the initial state of the machine.
*
* @param {string} initialState
* The identifier of the state which is to be set as the initial one.
*
* @returns {Machine}
* The state machine itself.
*/
Machine.prototype.setInitialState = function (initialStateId) {
this.initialState = initialStateId;
return this;
};

/**
* Gets the state that has the specified identifier, if it is in the machine.
*
* @param {string} id
* The identifier of the state which is to be returned.
*
* @return {State}
*/
Machine.prototype.getState = function (id) {
return this._states[id];
};

/**
* Gets a an object with all the states where the key is the state id and
* the value is the state itself.
*
* @return {object}
*/
Machine.prototype.getStates = function () {
return this._states;
};

/**
* Gets all the states in the machine as an array.
*
* @return {State[]}
*/
Machine.prototype.getStateArray = function () {
var states = [];
this.forEachState(function(state) {
states.push(state);
});
return states;
};

/**
* Gets an array with the ids of all the states that are in the machine.
*
* @return {string[]}
*/
Machine.prototype.getStateIds = function () {
return Object.keys(this._states);
};

/**
* Gets whether the machine has a state with the specified identifier.
*
* @param {string} id
* The identifier of the state which is to be checked.
*
* @return {Boolean}
* True if the machine has the specified state and false otherwise.
*/
Machine.prototype.hasState = function (id) {
return Boolean(this.getState(id));
};

Machine.prototype.contains = function (id) {
return this.hasState(id);
};

/**
* Gets whether the machine has any states.
*
* @return {Boolean}
*/
Machine.prototype.hasStates = function () {
return this.getStateIds().length > 0;
};

/**
* Applies the specified function for each state in the machine.
*
* @param {Function} fn
* Function which is to be called for each state. It receives the
* state in the first parameter and the state id in the second one.
*/
Machine.prototype.forEachState = function (fn) {
var ids = this.getStateIds();
for (var i = 0; i < ids.length; ++i) {
var id = ids[i];
fn(this.getState(id), id);
}
};

/**
* Sets the state machine component to which this machine belongs.
*
* @param {fsm} fsm
* The state machine component to which the machine belongs.
*
* @returns {Machine}
* The machine itself.
*/
Machine.prototype.setParentFSM = function (fsm) {
this._fsm;
return this;
};

Machine.prototype.setInitialState = function (initialState) {
this.initialState = initialState;
/**
* Gets the state machine component to which the machine belongs.
*
* @return {StateMachineComponent}
* The state machine component to which the machine belongs.
*/
Machine.prototype.getParentFSM = function () {
return this._fsm;
};

return Machine;
Expand Down
24 changes: 24 additions & 0 deletions src/goo/fsmpack/statemachine/State.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,5 +232,29 @@ define([
ArrayUtils.remove(this._machines, machine);
};

/**
* Sets the state machine component to which this machine belongs.
*
* @param {fsm} fsm
* The state machine component to which the machine belongs.
*
* @returns {Machine}
* The machine itself.
*/
State.prototype.setParentFSM = function (fsm) {
this._fsm;
return this;
};

/**
* Gets the state machine component to which the machine belongs.
*
* @return {StateMachineComponent}
* The state machine component to which the machine belongs.
*/
State.prototype.getParentFSM = function () {
return this._fsm;
};

return State;
});
Loading