Packagejp.naggg.framework
Classpublic dynamic class Progress
InheritanceProgress Inheritance flash.display.MovieClip

ローディングの進捗表示アニメーションを行うクラスです． 　（MVCで言うところの V のみを担当し、MとCは別で管理してください） オプションで速度摩擦や最大速度の指定が可能ですので、 実際のローディング状況とズレた、「滑らかな」アニメーションを作れます． 外部からの指定は、読込にあわせて targetValue のみを設定すればＯＫです． このクラス単体での使用（Flash IDE から基本クラスに設定）も考えて、 柔軟に記述ができるように動的クラスとして定義しています． 最適な使い方は、サブクラスを作り、そのイベントハンドラのオーバーライドを行う方法です． TODO stop() や reset() の実装？

View the examples


Public Properties
 PropertyDefined By
  friction : Number = 0.1
速度摩擦 、0 ～ 1
Progress
  ignoreFrictionValue : Number = 1
速度摩擦を無視する value の閾値
Progress
  maxSpeed : Number = 0.1
速度の最大値 、0 ～ 1
Progress
  speed : Number = 0
速度 、0 ～ 1
Progress
  targetValue : Number
目標進捗値です．0 ～ 1 の数値で指定します．
Progress
  value : Number
[read-only] 進捗値、設定はできません．0 ～ 1 の数値です．
Progress
Protected Properties
 PropertyDefined By
  _targetValue : Number = 0
進捗の目標値 0 ～ 1
Progress
  _value : Number = 0
進捗値 0 ～ 1
Progress
Public Methods
 MethodDefined By
  
Progress(friction:Number = 0.1, maxSpeed:Number = 1, ignoreFrictionValue:Number = 1)
Progress
  
init(friction:Number = 0.1, maxSpeed:Number = 1, ignoreFrictionValue:Number = 1):void
初期化を行います． コンストラクタを任意で呼びたい場合に活用します．
Progress
  
onComplete():void
アニメーション終了時に一度だけ呼ばれます． 表示を更新する関数で、サブクラスで肉付けしてください． このクラス内では具体的な内容は記述していません．（抽象メソッド）
Progress
  
onProgress():void
アニメーション中に呼ばれます． 表示を更新する関数で、サブクラスで肉付けしてください． このクラス内では具体的な内容は記述していません．（抽象メソッド）
Progress
  
onStart():void
アニメーション開始時に一度だけ呼ばれます． 表示を更新する関数で、サブクラスで肉付けしてください． このクラス内では具体的な内容は記述していません．（抽象メソッド）
Progress
  
reset():void
リセットします．その際、onStart が実行されます．
Progress
  
start():void
アニメーションを開始します．
Progress
  
toString():String
[override] 文字列表現を返します．
Progress
Protected Methods
 MethodDefined By
  
calculate(evt:Event):void
EnterFrameで呼び出され計算を行います．
Progress
  
completeHandler(evt:Event):void
すべてのロードを終えたとき．
Progress
  
progressHandler(evt:ProgressEvent):void
ロードの進捗中．
Progress
Protected Constants
 ConstantDefined By
  JUDGE_NUMBER : Number = 0.0005
[static] 減速計算の判定
Progress
Property Detail
_targetValueproperty
protected var _targetValue:Number = 0

進捗の目標値 0 ～ 1

_valueproperty 
protected var _value:Number = 0

進捗値 0 ～ 1

frictionproperty 
public var friction:Number = 0.1

速度摩擦 、0 ～ 1

ignoreFrictionValueproperty 
public var ignoreFrictionValue:Number = 1

速度摩擦を無視する value の閾値

maxSpeedproperty 
public var maxSpeed:Number = 0.1

速度の最大値 、0 ～ 1

speedproperty 
public var speed:Number = 0

速度 、0 ～ 1

targetValueproperty 
targetValue:Number

目標進捗値です．0 ～ 1 の数値で指定します．


Implementation
    public function get targetValue():Number
    public function set targetValue(value:Number):void
valueproperty 
value:Number  [read-only]

進捗値、設定はできません．0 ～ 1 の数値です．


Implementation
    public function get value():Number
Constructor Detail
Progress()Constructor
public function Progress(friction:Number = 0.1, maxSpeed:Number = 1, ignoreFrictionValue:Number = 1)

Parameters
friction:Number (default = 0.1) — 目標進捗値への減速摩擦係数、デフォルトは0.1
 
maxSpeed:Number (default = 1) — 目標進捗への増加速度の最大値、デフォルトは1（最大速度なしを意味）
 
ignoreFrictionValue:Number (default = 1) — 速度摩擦を無視する value の閾値
Method Detail
calculate()method
protected function calculate(evt:Event):void

EnterFrameで呼び出され計算を行います．

Parameters

evt:Event

completeHandler()method 
protected function completeHandler(evt:Event):void

すべてのロードを終えたとき．

Parameters

evt:Event

init()method 
public function init(friction:Number = 0.1, maxSpeed:Number = 1, ignoreFrictionValue:Number = 1):void

初期化を行います． コンストラクタを任意で呼びたい場合に活用します．

Parameters

friction:Number (default = 0.1) — 目標進捗値への減速摩擦係数、デフォルトは0.1
 
maxSpeed:Number (default = 1) — 目標進捗への増加速度の最大値、デフォルトは1（最大速度なしを意味）
 
ignoreFrictionValue:Number (default = 1) — 速度摩擦を無視する value の閾値

onComplete()method 
public function onComplete():void

アニメーション終了時に一度だけ呼ばれます． 表示を更新する関数で、サブクラスで肉付けしてください． このクラス内では具体的な内容は記述していません．（抽象メソッド）

onProgress()method 
public function onProgress():void

アニメーション中に呼ばれます． 表示を更新する関数で、サブクラスで肉付けしてください． このクラス内では具体的な内容は記述していません．（抽象メソッド）

onStart()method 
public function onStart():void

アニメーション開始時に一度だけ呼ばれます． 表示を更新する関数で、サブクラスで肉付けしてください． このクラス内では具体的な内容は記述していません．（抽象メソッド）

progressHandler()method 
protected function progressHandler(evt:ProgressEvent):void

ロードの進捗中．

Parameters

evt:ProgressEvent

reset()method 
public function reset():void

リセットします．その際、onStart が実行されます．

start()method 
public function start():void

アニメーションを開始します．

toString()method 
override public function toString():String

文字列表現を返します．

Returns
String
Constant Detail
JUDGE_NUMBERConstant
protected static const JUDGE_NUMBER:Number = 0.0005

減速計算の判定

Examples




Sat Oct 9 2010, 05:10 PM +09:00