+Show TOC
×Hide TOC

CommandFPS

Kind of class:	public class
Package:	com.bourre.commands
Inherits from:	none
Implements:	TickListener
Known subclasses:	CommandManagerFPS
Author:	Francis Bourre
Classpath:	com.bourre.commands.CommandFPS
File last modified:	Monday, 24 November 2008, 11:36:52

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.bourre.commands 
{
    import com.bourre.log.PixlibStringifier;
    import com.bourre.transitions.FPSBeacon;
    import com.bourre.transitions.TickListener;
    
    import flash.events.Event;    

    /**
     * @author     Francis Bourre
     */
    public class CommandFPS    implements TickListener
    {
        protected var _oT : Object;
        protected var _oS : Object;
        protected var _nID : Number;
        protected var _nL : Number;
        
        public function CommandFPS()
        {
            _oT = new Object();
            _oS = new Object();
            _nID = 0;
            _nL = 0;
            FPSBeacon.getInstance().addTickListener(this);
        }
        
        public function onTick( e : Event = null ) : void
        {
            for (var s:String in _oT) _oT[s].execute();
        }
        
        public function push(oC:Command) : String
        {
            return _push( oC, _getNameID() );
        }

        public function pushWithName(oC:Command, sN:String = null) : String
        {
            sN = (sN == null) ? _getNameID() : sN;
            return _push(oC, sN);
        }
        
        public function delay(oC:Command) : void
        {
            var sN:String = _getNameID();
            var d:Delegate = new Delegate( _delay, oC, sN);
            _oT[sN] = d;
        }
        
        public function remove(oC:Command) : Boolean
          {
            for(var s:String in _oT) if (_oT[s] == oC) return _remove(s);
            return false;
          }
    
        public function removeWithName(sN:String) : Boolean
        {
            return _oT.hasOwnProperty(sN) ? _remove(sN) : false;
        }
            
        public function stop(oC:Command) : Boolean
        {
            for (var s:String in _oT) if (_oT[s] == oC) return _stop(s);
            return false;
        }
        
        public function stopWithName(sN:String) : Boolean
        {
            return (_oT.hasOwnProperty(sN)) ? _stop(sN) : false;
        }
    
        public function resume(oC:Command) : Boolean
        {
            for (var s:String in _oS) if (_oS[s] == oC) return _resume(s);
            return false;
        }
        
        public function resumeWithName(sN:String) : Boolean
        {
            return (_oS.hasOwnProperty(sN)) ? _resume(sN) : false;
        }

        public function getLength() : Number
        {
            return _nL;
        }
        
        public function removeAll() : void
        {
            _oT = new Object();
            _oS = new Object();
            _nL = 0;
        }
        
        public function toString() : String 
        {
            return PixlibStringifier.stringify( this );
        }
        
        //
        protected function _push(oC:Command, sN:String) : String
        {
            if( _oT.hasOwnProperty( sN ) )
            {
                _oT[sN] = oC;
            }
            else
            {
                _oT[sN] = oC;
                _nL++;
            }
            
            oC.execute();
            return sN;
        }
        
        protected function _getNameID() : String
        {
            while (_oT.hasOwnProperty('_C_' + _nID)) _nID++;
            return '_C_' + _nID;
        }
        
        protected function _remove(s:String) : Boolean
        {
            delete _oT[s];
            _nL--;
            return true;
        }
        
        protected function _stop(s:String) : Boolean
        {
            _oS[s] = _oT[s];
            delete _oT[s];
            return true;
        }
        
        protected function _resume(s:String) : Boolean
        {
            var oC:Command = _oS[s];
            delete _oS[s];
            oC.execute();
            _oT[s] = oC;
            return true;
        }
        
        protected function _delay(oC:Command, sN:String) : void
        {
            removeWithName(sN);
            oC.execute();
        }
    }
}

Summary

Constructor

CommandFPS

Instance methods

push (oC:Command) : String
pushWithName (oC:Command, sN:String = null) : String
delay (oC:Command) : void
remove (oC:Command) : Boolean
removeWithName (sN:String) : Boolean
stop (oC:Command) : Boolean
stopWithName (sN:String) : Boolean
resume (oC:Command) : Boolean
resumeWithName (sN:String) : Boolean
getLength : Number
removeAll : void
toString : String

Event handlers

onTick (e:Event = null) : void
- Method called by the {VISDOC_CODE_BLOCK_5} for each

Constructor

CommandFPS

public function CommandFPS (

)

Instance methods

delay

public function delay (

oC:Command) : void

getLength

public function getLength (

) : Number

push

public function push (

oC:Command) : String

pushWithName

public function pushWithName (

oC:Command, sN:String = null) : String

remove

public function remove (

oC:Command) : Boolean

removeAll

public function removeAll (

) : void

removeWithName

public function removeWithName (

sN:String) : Boolean

resume

public function resume (

oC:Command) : Boolean

resumeWithName

public function resumeWithName (

sN:String) : Boolean

stop

public function stop (

oC:Command) : Boolean

stopWithName

public function stopWithName (

sN:String) : Boolean

toString

public function toString (

) : String

Event handlers

onTick

public function onTick (

e:Event = null) : void

Method called by the {VISDOC_CODE_BLOCK_5} for each
step of time according to its time slicing approach.

The {VISDOC_CODE_BLOCK_6} method is very similar to the
old {VISDOC_CODE_BLOCK_7} method, but doesn't specifically
occurs when entering in a new frame of a frame-based animation.
The tick could be the result of a {VISDOC_CODE_BLOCK_8} call,
or a change in the timecode of a video.

Parameters:

event dispatched by the beacon object

Specified by:

TickListener.onTick