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

Functions

function XEPinchSkeletonComponent new () end
 
function XEPinchSkeletonComponent Render (pViewport) end
 
function XEPinchSkeletonComponent Tick (fDel, bForceTick) end
 
function XEPinchSkeletonComponent Empty () end
 
function XEPinchSkeletonComponent BindFromParent () end
 @type string 名称 More...
 
function XEPinchSkeletonComponent Bind (pModelIns) end
 
function XEPinchSkeletonComponent Unbind () end
 
function XEPinchSkeletonComponent LoadPinchParamConfig (pSkePinchCfgPath) end
 
function XEPinchSkeletonComponent ApplyPinchParamFromCfg (pSkePinchParamInsCfgPath) end
 
function XEPinchSkeletonComponent ResetPinchParams (pPinchNodeName) end
 
function XEPinchSkeletonComponent SetPinchParam (pinchParam) end
 
function XEPinchSkeletonComponent SetPinchParams (pinchParams) end
 
function XEPinchSkeletonComponent GetPinchParam (pParamName, pinchParam) end
 
function XEPinchSkeletonComponent GetPinchParam (pParamName) end
 
function XEPinchSkeletonComponent GetPinchParamsByArray () end
 
function XEPinchSkeletonComponent VerifyPinchNode (pPinchNodeName) end
 
function XEPinchSkeletonComponent UpdateValueFromExistence (pPinchNodeName) end
 
function XEPinchSkeletonComponent SyncValueToPinchControl () end
 
function XEPinchSkeletonComponent GetPinchParamCMMS (pPinchNodeName) end
 
function XEPinchSkeletonComponent GetPinchParamCMMSArray () end
 
function XEPinchSkeletonComponent SetPinchParamConfigPath (pPath) end
 
function XEPinchSkeletonComponent GetPinchParamConfigPath () end
 
function XEPinchSkeletonComponent GetPinchControl () end
 
function XEPinchSkeletonComponent GetModelInstance () end
 

Variables

 XEPinchSkeletonComponent = {}
 

Function Documentation

◆ ApplyPinchParamFromCfg()

function XEPinchSkeletonComponent ApplyPinchParamFromCfg ( pSkePinchParamInsCfgPath  )

加载并应用实例配置文件（xpc.instance文件）

Parameters
pSkePinchParamInsCfgPathstring 实例配置xpc.instance文件路径
Returns
boolean 是否成功

◆ Bind()

function XEPinchSkeletonComponent Bind ( pModelIns  )

骨头捏造控制器绑定到模型实例上

Parameters
pModelInsIXModelInstance 模型实例指针
Returns
boolean 是否成功
Attention
调用此函数之前，需要保证已经设置了骨头捏造配置文件路径

◆ BindFromParent()

function XEPinchSkeletonComponent BindFromParent ( )

@type string 名称

@type number 最小值 @type number 最大值 @type number 步进 @type number 当前值 骨头捏造控制器绑定到组件的父节点模型实例上

Returns
boolean 是否成功
Attention
调用此函数之前，需要保证已经设置了骨头捏造配置文件路径

◆ Empty()

function XEPinchSkeletonComponent Empty ( )

清空当前组件及实例

Returns
void

◆ GetModelInstance()

function XEPinchSkeletonComponent GetModelInstance ( )

获取当前模型实例指针

Returns
IXModelInstance

◆ GetPinchControl()

function XEPinchSkeletonComponent GetPinchControl ( )

获取骨头捏造控制器指针

Returns
XPinchFaceControl

◆ GetPinchParam() [1/2]

function XEPinchSkeletonComponent GetPinchParam ( pParamName  ,
pinchParam   
)

获取某个构件参数值

Parameters
pParamNamestring [in]要获取的构件参数名称
pinchParamXPinchParam [out]构件参数值
Returns
boolean 是否成功

◆ GetPinchParam() [2/2]

function XEPinchSkeletonComponent GetPinchParam ( pParamName  )

XEPinchSkeletonComponent_GetPinchParam01

Parameters
pParamNamestring
Returns
XPinchParam
boolean

◆ GetPinchParamCMMS()

function XEPinchSkeletonComponent GetPinchParamCMMS ( pPinchNodeName  )

获取某个构件参数全信息结构体（包括该参数的最小值/最大值/当前值/步长等）

Parameters
pPinchNodeNamestring
Returns
XEPinchSkeletonComponent__PinchParamCurMinMaxStep 参数信息结构体指针

◆ GetPinchParamCMMSArray()

function XEPinchSkeletonComponent GetPinchParamCMMSArray ( )

获取所有构件参数全信息结构体（包括该参数的最小值/最大值/当前值/步长等）

Returns
PinchParamCurMinMaxStep[] 参数全信息结构体数组

◆ GetPinchParamConfigPath()

function XEPinchSkeletonComponent GetPinchParamConfigPath ( )

获取骨头捏造配置文件路径

Returns
string

◆ GetPinchParamsByArray()

function XEPinchSkeletonComponent GetPinchParamsByArray ( )

获取所有构件参数值

Returns
XPinchParam[] 所有构件参数值数组

◆ LoadPinchParamConfig()

function XEPinchSkeletonComponent LoadPinchParamConfig ( pSkePinchCfgPath  )

加载骨头捏造配置文件（xpc文件）

Parameters
pSkePinchCfgPathstring 骨头捏造配置xpc文件路径
Returns
boolean 是否加载成功

◆ new()

function XEPinchSkeletonComponent new ( )

XEPinchSkeletonComponent_new00

Returns
XEPinchSkeletonComponent

XEPinchSkeletonComponent_PinchParamCurMinMaxStep_new00

Returns
XEPinchSkeletonComponent__PinchParamCurMinMaxStep

◆ Render()

function XEPinchSkeletonComponent Render ( pViewport  )

渲染当前组件，此函数每帧都会被 XEActor 调用

Parameters
pViewportXEViewport
Returns
void

◆ ResetPinchParams()

function XEPinchSkeletonComponent ResetPinchParams ( pPinchNodeName  )

重置构件参数

Parameters
pPinchNodeNamestring 构件参数节点名称，如果此项为空，则重置所有构件参数；否则，只重置该构件参数节点
Returns
boolean 是否成功

◆ SetPinchParam()

function XEPinchSkeletonComponent SetPinchParam ( pinchParam  )

设置某个构件参数值（设置到骨头捏造控制器）

Parameters
pinchParamXPinchParam 要设置的构件参数值
Returns
boolean 是否设置成功

◆ SetPinchParamConfigPath()

function XEPinchSkeletonComponent SetPinchParamConfigPath ( pPath  )

设置骨头捏造配置文件路径

Parameters
pPathstring
Returns
void

◆ SetPinchParams()

function XEPinchSkeletonComponent SetPinchParams ( pinchParams  )

设置多个构件参数值（设置到骨头捏造控制器）

Parameters
pinchParamsXPinchParam[] 要设置的构件参数值数组
Returns
boolean 是否设置成功

◆ SyncValueToPinchControl()

function XEPinchSkeletonComponent SyncValueToPinchControl ( )

同步组件内构件参数信息给骨头捏造控制器

Returns
boolean 是否成功

◆ Tick()

function XEPinchSkeletonComponent Tick ( fDel  ,
bForceTick   
)

更新当前组件的数据，此函数每帧都会被调用

Parameters
fDelnumber 每帧更新的时间间隔(ms)
bForceTickboolean 是否强制Tick.如果为true，不管当前组件是否隐藏，都会更新；如果为false，当前组件如果隐藏时不更新。
Returns
void

◆ Unbind()

function XEPinchSkeletonComponent Unbind ( )

骨头捏造控制器与模型实例解绑，并释放资源

Returns
boolean 是否解绑成功

◆ UpdateValueFromExistence()

function XEPinchSkeletonComponent UpdateValueFromExistence ( pPinchNodeName  )

由骨头捏造控制器更新组件内记录的构件参数节点信息

Parameters
pPinchNodeNamestring 构件参数节点名称，如果为空，更新全部构件参数节点信息；否则，只更新该构件参数节点信息
Returns
boolean 是否成功

◆ VerifyPinchNode()

function XEPinchSkeletonComponent VerifyPinchNode ( pPinchNodeName  )

判断某构件参数节点是否有效

Parameters
pPinchNodeNamestring
Returns
boolean 是否有效

Variable Documentation

◆ XEPinchSkeletonComponent

XEPinchSkeletonComponent = {}
Generated by   doxygen 1.8.15