+Show TOC
×Hide TOC

IFrameBeacon

Kind of class:	interface
Inherits from:	none
Implemented by:	FLVBeacon FPSBeacon MSBeacon
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.transitions.IFrameBeacon
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 IFrameBeacon} defines basic rules for tween synchronizer implementation.
 * 
 * <p>Take a look at {@link com.bourre.transitions.FPSBeacon} and 
 * {@link com.bourre.transitions.MSBeacon} for concrete implementation.
 * 
 * @author Francis Bourre
 * @version 1.0
 */
import com.bourre.transitions.IFrameListener;

interface com.bourre.transitions.IFrameBeacon 
{
    /**
     * Starts the process.
     */
    public function start() : Void;
    
    /**
     * Stops the process.
     */
    public function stop() : Void;
    
    /**
     * Indicates if FPSBeacon's running.
     * 
     * @return {@code true} if {@code FPSBeacon} is running, either {@code false}
     */
    public function isPlaying() : Boolean;
    
    /**
     * Adds listener for receiving all {@code IFrameBeacon} events.
     * 
     * @param oL Listener object which implements {@link IFrameListener} interface.
     */
    public function addFrameListener(oL:IFrameListener) : Void;
    
    /**
     * Removes passed-in listener for receiving all {@code IFrameBeacon} events.
     * 
     * @param oL Listener object which implements {@link IFrameListener} interface.
     */
    public function removeFrameListener(oL:IFrameListener) : Void;
}

IFrameBeacon defines basic rules for tween synchronizer implementation.

Take a look at FPSBeacon and
MSBeacon for concrete implementation.

Summary

Instance methods

start
stop
isPlaying
addFrameListener
removeFrameListener

Instance methods

addFrameListener

function addFrameListener (

oL:IFrameListener) : Void

Adds listener for receiving all IFrameBeacon events.

Parameters:

oL:

Listener object which implements IFrameListener interface.

isPlaying

function isPlaying (

) : Boolean

Indicates if FPSBeacon's running.

Returns:

true if FPSBeacon is running, either false

removeFrameListener

function removeFrameListener (

oL:IFrameListener) : Void

Removes passed-in listener for receiving all IFrameBeacon events.

Parameters:

oL:

Listener object which implements IFrameListener interface.

start

function start (

) : Void

Starts the process.

stop

function stop (

) : Void

Stops the process.