action.md

ngui/action

create(json[,parent])

• 通過json數(shù)據(jù)創(chuàng)建動作，如果傳入的json為Action跳過創(chuàng)建過程

  如果傳入父動作，創(chuàng)建完成追加新創(chuàng)建的動作到parent結(jié)尾

• 如果傳入的數(shù)據(jù)是一個Array創(chuàng)建KeyframeAction并使用這個Array創(chuàng)建Frame

• 如果傳入的數(shù)據(jù)里有seq屬性創(chuàng)建SequenceAction

• 如果傳入的數(shù)據(jù)里有spawn屬性創(chuàng)建SpawnAction

• 如果傳入的數(shù)據(jù)里沒有seq也沒spawn創(chuàng)建KeyframeAction，

對像的內(nèi)部屬性frame如果為Array，那么用這個Array創(chuàng)建Frame

• @arg json {Object}
• @arg [parent] {GroupAction}
• @ret {Action}

Example:

var act1 = action.create([
    { time:0, x:0 },
    { time:1000, x:100 },
]);
var act1 = action.create({
    delay: 1000,
    frame: [
        { time:0, x:0, curve: 'linear', },
        { time:1000, x:100 },
    ]
});
// 創(chuàng)建SequenceAction并有兩子KeyframeAction
var act2 = action.create({
    loop: -1,
    seq: [
        {
            frame: [
                { time:0, x: 0 },
                { time:1000, x: 100 },
            ]
        },
        [
            { time:0, x: 100 },
            { time:1000, x: 0 },
        ]
    ]
})

transition(view,style[,delay[,cb]])

transition(view,style[,cb])

• 通過樣式創(chuàng)建視圖樣式過渡動作并播放這個動作，完成后回調(diào)

Callback: cb()

• @arg view {View}
• @arg style {Object}
• @arg [delay] {uint} ms
• @arg [cb] {Function}
• @ret {KeyframeAction}

Example:

// 1秒后過渡完成并回調(diào)
action.transition(view, {
    time: 1000,
    y: 100, 
    x: 100,
}, ()={
    console.log('view transition end');
})
// 延時1秒后開始播放，并使用線性過渡
action.transition(view2, {
    time: 1000,
    curve: 'linear',
    y: 100, 
    x: 100,
}, 1000)

Class: Action

• abstract class

• 動作基礎(chǔ)類型，這是個抽象類型沒有構(gòu)造函數(shù)

Action.play()

• 播放動作

Action.stop()

• 停止動作

Action.seek(time)

• 跳轉(zhuǎn)到目標(biāo)time時間，調(diào)用后會重置loopd

• 不包含延時時間，如果想在延時之前，可傳入負(fù)數(shù)time

• @arg time {int} ms

Action.seekPlay(time)

• 跳轉(zhuǎn)到目標(biāo)time時間，并開始播放，調(diào)用后會重置loopd

• @arg time {int} ms

Action.seekStop(time)

• 跳轉(zhuǎn)到目標(biāo)time時間，并停止播放，調(diào)用后會重置loopd

• @arg time {int} ms

Action.clear()

• 清空動作,清空動作后會立即停止動作

Action.loop

• 動作循環(huán)播放的次數(shù)，-1表示無限循環(huán)

• {int}

Get: Action.loopd

• 當(dāng)前動作已經(jīng)循環(huán)播放的次數(shù)

• {uint}

Action.delay

• 延時播放

• {uint} ms

Get: Action.delayd

• 延時過去的時間

• {uint} ms

Action.speed

• 播放速率，默認(rèn)為1.0，可設(shè)置的范圍在0.1到10.0之間

• {float} 0.1-10

Action.playing

• 是否播放中，設(shè)置action.playing = true相當(dāng)調(diào)用action.play()

• {bool}

Get: Action.duration

• 當(dāng)前動作的時長不包括延時，對于SpawnAction取最長的子動作

• {uint} ms

Get: Action.parent

• 父動作，如果沒有父動作返回null

• {GroupAction}

Class: GroupAction

• abstract class
• extends Action

• 動作集合，這是個抽象類型沒有構(gòu)造函數(shù)

Get: GroupAction.length

• {uint}

  GroupAction.append(child)

• 追加子動作到結(jié)尾

• @arg child {Action}

  GroupAction.insert(index, child)

• 插入子動作到index的位置

• @arg index {uint}

• @arg child {Action}

  GroupAction.removeChild(index)

• 通過index刪除子動作

• @arg index {uint}

  GroupAction.children(index)

• 獲取子動作

• @arg index {uint}
• @ret {Action}

Class: SpawnAction

• extends GroupAction

• 并行子動作實現(xiàn)，所有的動作并行一起播放

SpawnAction.spawn(index)

• 返回子動作children(index)的別名函數(shù)

• @arg index {uint}
• @ret {Action}

Class: SequenceAction

• extends GroupAction

• 串行子動作實現(xiàn)，子動作一個接一個串行播放

SequenceAction.seq(index)

• 返回子動作children(index)的別名函數(shù)

• @arg index {uint}
• @ret {Action}

Class: KeyframeAction

• extends Action

• 關(guān)鍵幀動作, 不能包含子動作

KeyframeAction.hasProperty(name)

• 測試當(dāng)前是否添加了屬性名name

• @arg name {PropertyName}
• @ret {bool}

KeyframeAction.matchProperty(name)

• 測試屬性名稱是否與當(dāng)前綁定的視圖匹配

• @arg name {PropertyName}
• @ret {bool}

KeyframeAction.frame(index)

• 通過索引獲取關(guān)鍵幀

• @arg index {uint}
• @ret {Frame}

KeyframeAction.add([time[,curve]])

• 通過time時間與曲線curve添加關(guān)鍵幀，并返回關(guān)鍵幀

• arg [time=0] {uint} 不傳入time默認(rèn)為0

• arg [curve='ease'] {Curve} 不傳入curve默認(rèn)為EASE

  可使用 LINEAR、EASE、EASE_IN、EASE_OUT、EASE_IN_OUT

或 'linear'、'ease'、'easeIn'、'easeOut'、'easeInOut' 做為參數(shù)。

• @ret {Frame}

KeyframeAction.add([style])

• 通過style對像屬性添加關(guān)鍵幀，并返回關(guān)鍵幀

• arg [style] {Object}
• @ret {Frame}

Get: KeyframeAction.first

• 第一個關(guān)鍵幀

• {Frame}

Get: KeyframeAction.last

• 最后一個關(guān)鍵幀

• {Frame}

Get: KeyframeAction.length

• 關(guān)鍵幀數(shù)量

• {uint}

Get: KeyframeAction.position

• 當(dāng)前關(guān)鍵幀的播放位置，-1表示還未開始播放

• {int}

Get: KeyframeAction.time

• 當(dāng)前播放時間time

• {uint} ms

Class: Frame

• 關(guān)鍵幀

Frame.fetch([view])

• 通過視圖抓取樣式屬性填充到當(dāng)前frame

  如果不傳入視圖抓取當(dāng)前綁定的視圖樣式屬性

• @arg [view] {View}

Frame.flush()

• 恢復(fù)當(dāng)前關(guān)鍵幀樣式屬性為默認(rèn)值

Get: Frame.index

• 關(guān)鍵幀所在的動作中的索引位置

• {uint}

Frame.time

• 關(guān)鍵幀的所在動作中的時間time

• {uint} ms

Get: Frame.host

• 關(guān)鍵幀所在的動作KeyframeAction

• {KeyframeAction}

Frame.curve

• 當(dāng)前關(guān)鍵幀到下一個關(guān)鍵幀的過渡曲線

可使用 LINEAR、EASE、EASE_IN、EASE_OUT、EASE_IN_OUT

或 'linear'、'ease'、'easeIn'、'easeOut'、'easeInOut' 做為值設(shè)置。

• {Curve}

Frame.translate

• {Vec2}

Frame.scale

• {Vec2}

Frame.skew

• {Vec2}

Frame.origin

• {Vec2}

Frame.margin

• {Value}

Frame.border

• {Border}

Frame.borderWidth

• {float}

Frame.borderColor

• {Color}

Frame.borderWadius

• {float}

Frame.minWidth

• {Value}

Frame.minHeight

• {Value}

Frame.start

• {Vec2}

Frame.ratio

• {Vec2}

Frame.width

• {Value|float}

Frame.height

• {Value|float}

Frame.x

• {float}

Frame.y

• {float}

Frame.scaleX

• {float}

Frame.scaleY

• {float}

Frame.skewX

• {float}

Frame.skewY

• {float}

Frame.originX

• {float}

Frame.originY

• {float}

Frame.rotateZ

• {float}

Frame.opacity

• {float}

Frame.visible

• {bool}

Frame.marginLeft

• {Value}

Frame.marginTop

• {Value}

Frame.marginRight

• {Value}

Frame.marginBottom

• {Value}

Frame.borderLeft

• {Border}

Frame.borderTop

• {Border}

Frame.borderRight

• {Border}

Frame.borderBottom

• {Border}

Frame.borderLeftWidth

• {float}

Frame.borderTopWidth

• {float}

Frame.borderRightWidth

• {float}

Frame.borderBottomWidth

• {float}

Frame.borderLeftColor

• {Color}

Frame.borderTopColor

• {Color}

Frame.borderRightColor

• {Color}

Frame.borderBottomColor

• {Color}

Frame.borderRadiusLeftTop

• {float}

Frame.borderRadiusRightTop

• {float}

Frame.borderRadiusRightBottom

• {float}

Frame.borderRadiusLeftBottom

• {float}

Frame.backgroundColor

• {Color}

Frame.newline

• {bool}

Frame.contentAlign

• {ContentAlign}

Frame.textAlign

• {TextAlign}

Frame.maxWidth

• {Value}

Frame.maxHeight

• {Value}

Frame.startX

• {float}

Frame.startY

• {float}

Frame.ratioX

• {float}

Frame.ratioY

• {float}

Frame.repeat

• {Repeat}

Frame.textBackgroundColor

• {TextColor}

Frame.textColor

• {TextColor}

Frame.textSize

• {TextSize}

Frame.textStyle

• {TextStyle}

Frame.textFamily

• {TextFamily}

Frame.textLineHeight

• {TextLineHeight}

Frame.textShadow

• {TextShadow}

Frame.textDecoration

• {TextDecoration}

Frame.textOverflow

• {TextOverflow}

Frame.textWhiteSpace

• {TextWhiteSpace}

Frame.alignX

• {Align}

Frame.alignY

• {Align}

Frame.shadow

• {Shadow}

Frame.src

• {String}

Frame.backgroundImage

• {String}

LINEAR

EASE

EASE_IN

EASE_OUT

EASE_IN_OUT