AR_Engine_SDK
载入中...
搜索中...
未找到
函数 | 变量
FxInstance.lua 文件参考

#include <FxInstance.h>

类 IFxTemplate 继承关系图:
Inheritance graph

#include <FxInstance.h>

类 IFxInstance 继承关系图:
Inheritance graph

#include <FxInstance.h>

类 IFxManager 继承关系图:
Inheritance graph

#include <FxInstance.h>

类 IXFXStatGroup 继承关系图:
Inheritance graph

函数

function IFxTemplate GetName () end
 
function IFxTemplate GetElementNum () end
 
function IFxTemplate GetElement (nIndex) end
 
function IFxTemplate AddElement (szName, eType) end
 
function IFxTemplate AddElement (pElement) end
 
function IFxTemplate RemoveElement (nIndex, bDelete) end
 
function IFxTemplate RemoveElement (pElement, bDelete) end
 
function IFxTemplate MoveElement (pElement, nMoveAmount) end
 
function IFxTemplate DumplicateElement (nIndex) end
 
function IFxTemplate DumplicateElement (pElement) end
 
function IFxTemplate GetFileVersion () end
 
function IFxInstance Play () end
 
function IFxInstance Pause () end
 
function IFxInstance IsPaused () end
 
function IFxInstance Stop (bClearNow) end
 
function IFxInstance Restart () end
 
function IFxInstance IsCompleted () end
 
function IFxInstance Set2DMode (b2DRenderMode) end
 
function IFxInstance Is2DMode () end
 
function IFxInstance Set2DModeLayerMask (pLayer) end
 
function IFxInstance EnableScreenMask (bEnable) end
 
function IFxInstance IsScreenMaskEnabled () end
 
function IFxInstance SetScreenMaskRegion (vRegion) end
 
function IFxInstance GetScreenMaskRegion () end
 
function IFxInstance GetAABB () end
 
function IFxInstance GetFxTemplate () end
 
function IFxInstance SetAnimTrailBindingSkeletonAndBones (pSkeleton, FirstBoneName, SecondBoneName) end
 
function IFxInstance SetBeamEmitterSourcePoints (EmitterName, Positions) end
 
function IFxInstance SetBeamEmitterTargetPoints (EmitterName, Positions) end
 
function IFxManager GetFxInstance (szFxTemplateFile, pLoadInfo) end
 
function IFxManager CreateFxInstance (szNewFxTemplateFile) end
 
function IFxManager SaveFxTemplate (szFxTemplateFile, pTemplate) end
 
function IFxManager SetBatchEnabled (bEnable) end
 
function IFxManager IsBatchEnabled () end
 
function IFxManager ForceBatchInSameLayer (bForce) end
 
function IFxManager IsForceBatchInSameLayer () end
 
function IFxManager SetMaxBatchedVertexNum (nMaxNum) end
 
function IFxManager GetMaxBatchedVertexNum () end
 
function IFxManager ReloadFxTemplate (szFxTemplateFile, pLoadInfo) end
 

变量

 IFxTemplate = {}
 

函数说明

◆ AddElement() [1/2]

function IFxTemplate AddElement ( pElement  )

添加粒子元素

参数
pElementFxElement 添加的粒子元素
返回
boolean 是否添加成功

◆ AddElement() [2/2]

function IFxTemplate AddElement ( szName  ,
eType   
)

添加粒子元素

参数
szNamestring 元素名称
eTypenumber 元素类型
返回
FxElement 添加的粒子元素指针

◆ CreateFxInstance()

function IFxManager CreateFxInstance ( szNewFxTemplateFile  )

新建一个特效实例，在内存中直接创建

参数
szNewFxTemplateFilestring 新建模板文件路径名
返回
IFxInstance 粒子特效实例指针

◆ DumplicateElement() [1/2]

function IFxTemplate DumplicateElement ( nIndex  )

复制某个粒子元素

参数
nIndexnumber 要复制的元素索引
返回
boolean 是否复制成功

◆ DumplicateElement() [2/2]

function IFxTemplate DumplicateElement ( pElement  )

复制某个粒子元素

参数
pElementFxElement 要复制的元素指针
返回
boolean 是否复制成功

◆ EnableScreenMask()

function IFxInstance EnableScreenMask ( bEnable  )

设置是否开启屏幕空间的裁剪

参数
bEnableboolean 是否开启
返回
void

◆ ForceBatchInSameLayer()

function IFxManager ForceBatchInSameLayer ( bForce  )

设置同一层级的粒子是否强制合批(不考虑先后顺序)

参数
bForceboolean
返回
void

◆ GetAABB()

function IFxInstance GetAABB ( )

获取粒子的AABB

返回
XCusAABB AABB

◆ GetElement()

function IFxTemplate GetElement ( nIndex  )

根据索引获取对应的粒子元素

参数
nIndexnumber 元素索引
返回
FxElement 粒子元素个数

◆ GetElementNum()

function IFxTemplate GetElementNum ( )

获取粒子元素个数

返回
number 粒子元素个数

◆ GetFileVersion()

function IFxTemplate GetFileVersion ( )

获取版本号

返回
number 是否复制成功

◆ GetFxInstance()

function IFxManager GetFxInstance ( szFxTemplateFile  ,
pLoadInfo   
)

根据模板文件创建一个特效实例

参数
szFxTemplateFilestring 模板文件路径名
pLoadInfostring
返回
IFxInstance 粒子特效实例指针

◆ GetFxTemplate()

function IFxInstance GetFxTemplate ( )

获取粒子特效实例模板指针

返回
IFxTemplate 粒子特效实例模板指针

◆ GetMaxBatchedVertexNum()

function IFxManager GetMaxBatchedVertexNum ( )

获取同一层级的粒子是否强制合批

返回
number 合批的最大顶点数

◆ GetName()

function IFxTemplate GetName ( )

获取名称

返回
string 名称字符串

◆ GetScreenMaskRegion()

function IFxInstance GetScreenMaskRegion ( )

获取屏幕空间的裁剪区域

返回
XVECTOR4 裁剪区域

◆ Is2DMode()

function IFxInstance Is2DMode ( )

是否为2D模式

返回
boolean 是否为2D模式

◆ IsBatchEnabled()

function IFxManager IsBatchEnabled ( )

获取是否合批渲染

返回
boolean 是否合批渲染

◆ IsCompleted()

function IFxInstance IsCompleted ( )

判断是否播放完毕

返回
boolean 是否播放完毕

◆ IsForceBatchInSameLayer()

function IFxManager IsForceBatchInSameLayer ( )

获取同一层级的粒子是否强制合批

返回
boolean 是否强制合批

◆ IsPaused()

function IFxInstance IsPaused ( )

判断是否暂定播放状态

返回
boolean 是否暂停

◆ IsScreenMaskEnabled()

function IFxInstance IsScreenMaskEnabled ( )

获取是否开启屏幕空间的裁剪

返回
boolean 是否开启

◆ MoveElement()

function IFxTemplate MoveElement ( pElement  ,
nMoveAmount   
)

移动某个粒子元素在数组中的位置

参数
pElementFxElement 要移动的元素指针
nMoveAmountnumber 移动距离，正数为向数组尾移动，负数为向数组头移动
返回
boolean 是否移动成功

◆ Pause()

function IFxInstance Pause ( )

暂停播放粒子特效

返回
void

◆ Play()

function IFxInstance Play ( )

播放粒子特效

返回
void

◆ ReloadFxTemplate()

function IFxManager ReloadFxTemplate ( szFxTemplateFile  ,
pLoadInfo   
)

重加载fx模板

参数
szFxTemplateFilestring
pLoadInfostring
返回
boolean 是否重加载成功

◆ RemoveElement() [1/2]

function IFxTemplate RemoveElement ( nIndex  ,
bDelete   
)

移除某个粒子元素

参数
nIndexnumber 要移除的元素索引
bDeleteboolean 是否同时销毁元素
返回
boolean 是否移除成功

◆ RemoveElement() [2/2]

function IFxTemplate RemoveElement ( pElement  ,
bDelete   
)

移除某个粒子元素

参数
pElementFxElement 要移除的元素指针
bDeleteboolean 是否同时销毁元素
返回
boolean 是否移除成功

◆ Restart()

function IFxInstance Restart ( )

重新从头播放粒子特效

返回
void

◆ SaveFxTemplate()

function IFxManager SaveFxTemplate ( szFxTemplateFile  ,
pTemplate   
)

将一个FxTemplate对象存到硬盘

参数
szFxTemplateFilestring 存储文件路径
pTemplateIFxTemplate 要存储的对象指针
返回
boolean 是否存储成功

◆ Set2DMode()

function IFxInstance Set2DMode ( b2DRenderMode  )

设置粒子是否为2D模式

参数
b2DRenderModeboolean 是否为2D模式
返回
void

◆ Set2DModeLayerMask()

function IFxInstance Set2DModeLayerMask ( pLayer  )

设置粒子的层级

参数
pLayernumber 在UI前（LO_BeforeUI）或UI后（LO_AfterUI），LO_BetweenUI在当前不起作用
返回
void

◆ SetAnimTrailBindingSkeletonAndBones()

function IFxInstance SetAnimTrailBindingSkeletonAndBones ( pSkeleton  ,
FirstBoneName  ,
SecondBoneName   
)

设置骨骼拖尾发射器使用的骨骼

参数
pSkeletonXSkeleton 指定的骨骼指针
FirstBoneNamestring 父关节名称
SecondBoneNamestring 子关节名称
返回
number 1:成功0:不包含骨骼拖尾发射器-1:骨骼错误-2:骨骼中找不到父关节-3:骨骼中找不到子关节-4:骨骼中父子关节均找不到

◆ SetBatchEnabled()

function IFxManager SetBatchEnabled ( bEnable  )

设置是否合批渲染

参数
bEnableboolean 是否合批渲染
返回
void

◆ SetBeamEmitterSourcePoints()

function IFxInstance SetBeamEmitterSourcePoints ( EmitterName  ,
Positions   
)

设置激光发射器发射点位置

参数
EmitterNamestring 发射器名称
PositionsXVECTOR3[] 位置信息
返回
boolean 是否成功

◆ SetBeamEmitterTargetPoints()

function IFxInstance SetBeamEmitterTargetPoints ( EmitterName  ,
Positions   
)

设置激光发射器目标点位置

参数
EmitterNamestring 发射器名称
PositionsXVECTOR3[] 位置信息
返回
boolean 是否成功

◆ SetMaxBatchedVertexNum()

function IFxManager SetMaxBatchedVertexNum ( nMaxNum  )

设置合批的最大顶点数

参数
nMaxNumnumber
返回
void

◆ SetScreenMaskRegion()

function IFxInstance SetScreenMaskRegion ( vRegion  )

设置屏幕空间的裁剪区域

参数
vRegionXVECTOR4 裁剪区域xy左下角坐标zw右上角坐标
返回
void

◆ Stop()

function IFxInstance Stop ( bClearNow  )

停止播放

参数
bClearNowboolean 是否立即清除资源，默认为false
返回
void

变量说明

◆ IFxTemplate

IFxTemplate = {}
制作者 doxygen 1.9.6