+Show TOC
×Hide TOC

BasicTweenFLV

Kind of class:	class
Inherits from:	AbstractTween
Implements:	IFrameListener
Known subclasses:	TweenFLV
Classpath:	com.bourre.transitions.BasicTweenFLV
File last modified:	Wednesday, 31 October 2007, 07:35:30

► 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.
 */
 
/**
 * {@code BasicTweenFLV} is the basic class for {@code VideoDisplay} synchronisation tweening.
 * 
 * <p>Concrete implementation of {@link AbstractTween} class.
 * 
 * <p>Example
 * <code>
 *   var t : BasicTweenFLV = new BasicTweenFLV(vd, 0, mc, '_alpha', 0, 2000, 100);
 *   t.start();
 * </code>
 * 
 * @author Francis Bourre
 * @version 1.0
 */
import com.bourre.log.PixlibStringifier;
import com.bourre.medias.video.VideoDisplay;
import com.bourre.transitions.AbstractTween;
import com.bourre.transitions.FLVBeacon;
import com.bourre.transitions.IFrameListener;

class com.bourre.transitions.BasicTweenFLV 
    extends AbstractTween
    implements IFrameListener
{

    private var _nT : Number;
    private var _nVO : Number;
    private var _vd : VideoDisplay;
    
    
    //-------------------------------------------------------------------------
    // Public API
    //-------------------------------------------------------------------------
    
    /**
     * Constructs a new {@code BasicTweenFLV} instance.
     * 
     * @param vd     VideoDisplay listened.
     * @param offset shift with starting.
     * @param oT     Object which the Tween targets.
     * @param sP     Setter (method or property).
     * @param nE     Ending value of property.
     * @param nRate Length of time of the motion in milliseconds.
     * @param nS     Starting value of property (optional).
     * @param fE     Easing function (optional).
    */
    
    public function BasicTweenFLV( vd : VideoDisplay, offset : Number, oT, sP, nE:Number, nRate:Number, nS:Number, fE:Function)
    {
        super( oT, sP, nE, nRate, nS, fE );
        
        setVideoDisplay( vd );
        setStartVideoOffset( offset );
    }

    /**
     * Returns the string representation of this instance.
     * @return the string representation of this instance
     */
    public function toString() : String 
    {
        return PixlibStringifier.stringify( this );
    }

    /**
     * Start tweening.
     * 
     * <p>{@link AbstractTween#execute} overridding.
     * 
     * <p>{@link com.bourre.commands.Command} polymorphism.
     */
    public function execute() : Void
    {
        _nT = _nT ? _nT : FLVBeacon( _oBeacon ).getVideoDisplay().getPlayheadTime() || 0;
        super.execute();
    }
    
    /**
     * Returns the string representation of this instance.
     * @return the string representation of this instance
     */
    public function setVideoDisplay( vd : VideoDisplay ) : FLVBeacon
    {
        var flvBeacon : FLVBeacon = new FLVBeacon( vd );
        setFLVBeacon( flvBeacon );
        return flvBeacon;
    }
    
    public function getFLVBeacon() : FLVBeacon
    {
        return FLVBeacon(_oBeacon);
    }
    
    /**
     * Stops tweening.
     * 
     * <p>{@link AbstractTween#stop} overridding.
     */
    public function setFLVBeacon( flvBeacon : FLVBeacon ) : Void
    {
        _oBeacon = flvBeacon;
        onChangeVideoDisplay();
    }
    
    public function setStartVideoOffset( n : Number ) : Void
    {
        _nT = n;
    }
    
    public function onChangeVideoDisplay() : Void
    {
        _vd = getFLVBeacon().getVideoDisplay();
    }

    //-------------------------------------------------------------------------
    // Private implementation
    //-------------------------------------------------------------------------
    
    private function _isMotionFinished() : Boolean
    {
        return  _vd.getPlayheadTime() - _nT >= _nRate;
    }
    
    private function _onUpdate() : Void
    {
        var time : Number = _vd.getPlayheadTime();
        if(time>_nT) _oSetter.setValue( _fE( time - _nT, _nS, _nE - _nS, _nRate) );
    }
}

BasicTweenFLV is the basic