AR_Engine_SDK
Functions | Variables
XEAnimController.lua File Reference
类 XEAnimController 继承关系图:
Inheritance graph

Functions

function XEAnimController new () end
 
function XEAnimController NavigateToHead () end
 
function XEAnimController NavigateToTail () end
 
function XEAnimController BroadcastStepMove () end
 
function XEAnimController BroadcastPlayState (state) end
 
function XEAnimController BroadcastPlayOneTimeFinished (bReversePlaying) end
 
function XEAnimController GetCurTime () end
 
function XEAnimController SetManaulStartTime (nTime) end
 
function XEAnimController GetManualStartTime () end
 
function XEAnimController SetManualEndTime (nTime) end
 
function XEAnimController GetManualEndTime () end
 
function XEAnimController SetManualTimeMode (bManual) end
 
function XEAnimController IsManualTimeMode () end
 
function XEAnimController IsCallbackSafeLocked () end
 
function XEAnimController Tick (fInterval) end
 
function XEAnimController Play () end
 
function XEAnimController GetTimeLength () end
 
function XEAnimController AssginAnimControllerForModelComponent (pComponent) end
 
function XEAnimController AssginAnimListForModelComponent (pComponent) end
 
function XEAnimController LoadAnimation (pAssetName, pComponent) end
 
function XEAnimController UnloadAnimation (pComponent) end
 
function XEAnimController LoadLayerAnimations (pLayerName, arrAreaNames, arrAssetNames, pComponent, bReload) end
 
function XEAnimController UnloadLayerAnimations (pLayerName, pComponent) end
 
function XEAnimController LoadVideo (pAssetName, pComponent) end
 
function XEAnimController UnloadVideo (pComponent) end
 

Variables

 XEAnimController = {}
 

Function Documentation

◆ AssginAnimControllerForModelComponent()

function XEAnimController AssginAnimControllerForModelComponent ( pComponent  )

如果模型组件pComponent不存在动画控制器，创建一个动画控制器，并返回;如果已经存在，直接返回

Parameters
pComponentXEModelComponent
Returns
XEAnimController

◆ AssginAnimListForModelComponent()

function XEAnimController AssginAnimListForModelComponent ( pComponent  )

如果模型组件pComponent动画播放列表不存在，创建一个（调用的是XEModelComponent::AssignAnimPlayList()）

Parameters
pComponentXEModelComponent
Returns
XEAnimComponentPlayList 动画播放列表指针

◆ BroadcastPlayOneTimeFinished()

function XEAnimController BroadcastPlayOneTimeFinished ( bReversePlaying  )

通知监听者一次播放结束

Parameters
bReversePlayingboolean
Returns
void

◆ BroadcastPlayState()

function XEAnimController BroadcastPlayState ( state  )

通知监听者当前的播放状态改变为state

Parameters
statenumber 动画控制状态Unknow/Play/Pause/Stop
Returns
void

◆ BroadcastStepMove()

function XEAnimController BroadcastStepMove ( )

通知监听者跳跃到cur time

Returns
void

◆ GetCurTime()

function XEAnimController GetCurTime ( )

获取当前时刻

Returns
number

◆ GetManualEndTime()

function XEAnimController GetManualEndTime ( )

获取动画手动播放区域结束时间，一般编辑器端使用

Returns
number

◆ GetManualStartTime()

function XEAnimController GetManualStartTime ( )

获取动画手动播放区域起始时间，一般编辑器端使用

Returns
number

◆ GetTimeLength()

function XEAnimController GetTimeLength ( )

获取动画播放区域长度

Returns
number

◆ IsCallbackSafeLocked()

function XEAnimController IsCallbackSafeLocked ( )

这个变量是为了保证在Listener的响应函数里，如果没有先UnloadAnimation，就再次调用LoadAnimation导致错误的情况！

Returns
boolean
Attention
forbidden to delete this in callback, if it is true!

◆ IsManualTimeMode()

function XEAnimController IsManualTimeMode ( )

获取动画是否是手动模式

Returns
boolean

◆ LoadAnimation()

function XEAnimController LoadAnimation ( pAssetName  ,
pComponent   
)

给某个模型组件加载单个动画资源（可以是.seq or .montage or .blend）

Parameters
pAssetNamestring 这里需要是动画资源路径
pComponentXEModelComponent 要加载动画的模型组件
Returns
boolean 是否加载成功

◆ LoadLayerAnimations()

function XEAnimController LoadLayerAnimations ( pLayerName  ,
arrAreaNames  ,
arrAssetNames  ,
pComponent  ,
bReload   
)

给某个模型组件加载一层动画资源（可以是.seq or .montage）

Parameters
pLayerNamestring 要加载的层名称
arrAreaNamesstring[] 要加载的动画区域名称数组
arrAssetNamesstring[] 要加载的动画路径名称数组
pComponentXEModelComponent 要加载动画的模型组件
bReloadboolean 是否需要重新加载该层动画资源，true:需要重新加载（如果该层动画不存在，或者该层动画有增减变化，则需要重新加载）；false:不需要重新加载
Returns
boolean 是否加载成功

◆ LoadVideo()

function XEAnimController LoadVideo ( pAssetName  ,
pComponent   
)

给某个模型组件加载单个视频资源（.mov格式）

Parameters
pAssetNamestring 视频资源路径
pComponentXEPrimitiveComponent 要加载视频的模型组件
Returns
boolean 是否加载成功

◆ NavigateToHead()

function XEAnimController NavigateToHead ( )

跳到动画播放起始处。手动模式：t = 播放区域起始处；非手动模式：t = 0

Returns
void

◆ NavigateToTail()

function XEAnimController NavigateToTail ( )

跳到动画播放末尾处。手动模式：t = 播放区域末尾处；非手动模式：t = 动画长度

Returns
void

◆ new()

function XEAnimController new ( )

XEAnimController_new00

Returns
XEAnimController

◆ Play()

function XEAnimController Play ( )

从头播放，如果当前长度为0，则不允许播放

Returns
void

◆ SetManaulStartTime()

function XEAnimController SetManaulStartTime ( nTime  )

设置动画手动播放区域起始时间，一般编辑器端使用

Parameters
nTimenumber
Returns
void

◆ SetManualEndTime()

function XEAnimController SetManualEndTime ( nTime  )

设置动画手动播放区域结束时间，一般编辑器端使用

Parameters
nTimenumber
Returns
void

◆ SetManualTimeMode()

function XEAnimController SetManualTimeMode ( bManual  )

设置动画是否是手动模式

Parameters
bManualboolean 是否为手动模式，true:手动模式（一般编辑器端使用）；false:非手动模式。
Returns
void

◆ Tick()

function XEAnimController Tick ( fInterval  )

更新动画控制器，如果是Play模式，这里控制动画播放

Parameters
fIntervalnumber 帧间隔，单位是毫秒
Returns
void

◆ UnloadAnimation()

function XEAnimController UnloadAnimation ( pComponent  )

卸载某个模型组件的所有动画资源

Parameters
pComponentXEModelComponent 要卸载动画的模型组件
Returns
boolean 是否卸载成功

◆ UnloadLayerAnimations()

function XEAnimController UnloadLayerAnimations ( pLayerName  ,
pComponent   
)

卸载某个模型组件的某层动画资源

Parameters
pLayerNamestring 要卸载的层名称
pComponentXEModelComponent 要卸载动画的模型组件
Returns
boolean 是否卸载成功

◆ UnloadVideo()

function XEAnimController UnloadVideo ( pComponent  )

卸载某个模型组件的所有视频资源

Parameters
pComponentXEPrimitiveComponent 要卸载视频的模型组件
Returns
boolean 是否卸载成功

Variable Documentation

◆ XEAnimController

XEAnimController = {}
Generated by   doxygen 1.8.15