AR_Engine_SDK
函数 | 变量
XESoftSkeleton.lua 文件参考

#include <XESoftSkeleton.h>

XESoftBone 的协作图:
Collaboration graph

#include <XESoftSkeleton.h>

类 XESoftBoneChain 继承关系图:
Inheritance graph

#include <XESoftSkeleton.h>

类 XESoftSkeleton 继承关系图:
Inheritance graph

函数

function XESoftBoneChain new (pSoftSkeleton, pRootBone) end
 
function XESoftBoneChain LoadPropertyPrefab (szFile) end
 
function XESoftBoneChain GetSoftBones () end
 
function XESoftBoneChain Tick (fDelta, pBaseCamera) end
 
function XESoftBoneChain GetRootBone () end
 
function XESoftBoneChain GetUpdateRate () end
 
function XESoftBoneChain SetUpdateRate (fUpdateRate) end
 
function XESoftBoneChain GetDamping () end
 
function XESoftBoneChain SetDamping (fDamping) end
 
function XESoftBoneChain GetDampingCurve () end
 
function XESoftBoneChain LoadDampingCurve (szFile) end
 
function XESoftBoneChain GetDampingCurveFile () end
 
function XESoftBoneChain GetElasticity () end
 
function XESoftBoneChain SetElasticity (fElasticity) end
 
function XESoftBoneChain GetElasticityCurve () end
 
function XESoftBoneChain LoadElasticityCurve (szFile) end
 
function XESoftBoneChain GetElasticityCurveFile () end
 
function XESoftBoneChain GetStiffness () end
 
function XESoftBoneChain SetStiffness (fStiffness) end
 
function XESoftBoneChain GetStiffnessCurve () end
 
function XESoftBoneChain LoadStiffnessCurve (szFile) end
 
function XESoftBoneChain GetStiffnessCurveFile () end
 
function XESoftBoneChain GetInert () end
 
function XESoftBoneChain SetInert (fInert) end
 
function XESoftBoneChain GetInertCurve () end
 
function XESoftBoneChain LoadInertCurve (szFile) end
 
function XESoftBoneChain GetInertCurveFile () end
 
function XESoftBoneChain GetRadius () end
 
function XESoftBoneChain SetRadius (fRadius) end
 
function XESoftBoneChain GetRadiusCurve () end
 
function XESoftBoneChain LoadRadiusCurve (szFile) end
 
function XESoftBoneChain GetRadiusCurveFile () end
 
function XESoftBoneChain GetEndLength () end
 
function XESoftBoneChain SetEndLength (fEndLength) end
 
function XESoftBoneChain GetEndOffset () end
 
function XESoftBoneChain SetEndOffset (vEndOffset) end
 
function XESoftBoneChain GetGravity () end
 
function XESoftBoneChain SetGravity (vGravity) end
 
function XESoftBoneChain GetForce () end
 
function XESoftBoneChain SetForce (vForce) end
 
function XESoftBoneChain GetFreezeAxis () end
 
function XESoftBoneChain SetFreezeAxis (eFreeAxis) end
 
function XESoftBoneChain GetColliderBoneNames () end
 
function XESoftBoneChain SetColliderBoneNum (nNum) end
 
function XESoftBoneChain SetColliderBoneName (nIndex, szName) end
 
function XESoftBoneChain GetDistanceDisable () end
 
function XESoftBoneChain SetDistanceDisable (bSet) end
 
function XESoftBoneChain GetDistanceToCamera () end
 
function XESoftBoneChain SetDistanceToCamera (fDistance) end
 
function XESoftBoneChain IsPlaneCollider () end
 
function XESoftBoneChain SetPlaneCollider (bPlaneCollider) end
 
function XESoftBoneChain GetPlaneRadius () end
 
function XESoftBoneChain SetPlaneRadius (fPlaneRadius) end
 
function XESoftBoneChain GetPlaneRadiusCurve () end
 
function XESoftBoneChain LoadPlaneRadiusCurve (szFile) end
 
function XESoftBoneChain GetPlaneRadiusCurveFile () end
 
function XESoftBoneChain GetPlaneDirection () end
 
function XESoftBoneChain SetPlaneDirection (eDirection) end
 
function XESoftBoneChain GetPlaneOffset () end
 
function XESoftBoneChain SetPlaneOffset (fPlaneOffset) end
 
function XESoftBoneChain BindModelComponentColliders (pModelComponent) end
 
function XESoftBoneChain RemoveModelComponentColliders () end
 
function XESoftBoneChain ResetSoftBonePosition () end
 
function XESoftBoneChain SetWeight (fWeight) end
 
function XESoftBoneChain GetWeight () end
 
function XESoftBoneChain SetCustomCollider (customColliders) end
 
function XESoftBoneChain SetExclusionBoneNames (aExclusionName) end
 
function XESoftSkeleton new (pModelInstance) end
 
function XESoftSkeleton Load (szFile) end
 
function XESoftSkeleton GetAssetPath () end
 
function XESoftSkeleton AddSoftBoneChain (szBoneName) end
 
function XESoftSkeleton RemoveSoftBoneChain (szBoneName) end
 
function XESoftSkeleton GetSoftBoneChainNum () end
 
function XESoftSkeleton GetSoftBoneChain (nIndex) end
 
function XESoftSkeleton GetSoftBoneChain (szBoneName) end
 
function XESoftSkeleton GetSoftBoneChainWithAnyChildBone (szBoneName) end
 
function XESoftSkeleton Enable (bEnable) end
 
function XESoftSkeleton IsEnable () end
 
function XESoftSkeleton Reset () end
 
function XESoftSkeleton UpdateProperty () end
 

变量

 XESoftBoneChain = {}
 

函数说明

◆ AddSoftBoneChain()

function XESoftSkeleton AddSoftBoneChain ( szBoneName  )

设置一条软骨

参数
szBoneNamestring 根骨骼名称
返回
number xbool是否设置成功

◆ BindModelComponentColliders()

function XESoftSkeleton BindModelComponentColliders ( pModelComponent  )

绑定一个模型上的骨骼碰状体

参数
pModelComponentXEModelComponent
返回
void

◆ Enable()

function XESoftSkeleton Enable ( bEnable  )

设置是否起作用

参数
bEnableboolean 是否起作用
返回
void

◆ GetAssetPath()

function XESoftSkeleton GetAssetPath ( )

获取Asset文件路径

返回
string XString资源文件路径

◆ GetColliderBoneNames()

function XESoftBoneChain GetColliderBoneNames ( )

需要从哪些骨骼上取碰撞体,获取这些骨骼名称

返回
string[] eFreeAxis轴向限制

◆ GetDamping()

function XESoftBoneChain GetDamping ( )

获取软骨信息:阻尼

返回
number 阻尼

◆ GetDampingCurve()

function XESoftBoneChain GetDampingCurve ( )

获取软骨信息:阻尼曲线

返回
XRawDistributionFloat 阻尼曲线

◆ GetDampingCurveFile()

function XESoftBoneChain GetDampingCurveFile ( )

获取软骨信息:阻尼曲线资源文件

返回
string 阻尼曲线资源文件

◆ GetDistanceDisable()

function XESoftBoneChain GetDistanceDisable ( )

是否随距离失效

返回
boolean 是否随距离失效

◆ GetDistanceToCamera()

function XESoftBoneChain GetDistanceToCamera ( )

设置是否随距离失效

返回
number

◆ GetElasticity()

function XESoftBoneChain GetElasticity ( )

获取软骨信息:弹性

返回
number 弹性

◆ GetElasticityCurve()

function XESoftBoneChain GetElasticityCurve ( )

获取软骨信息:弹性曲线

返回
XRawDistributionFloat 弹性曲线

◆ GetElasticityCurveFile()

function XESoftBoneChain GetElasticityCurveFile ( )

获取软骨信息:弹性曲线资源文件

返回
string 弹性曲线资源文件

◆ GetEndLength()

function XESoftBoneChain GetEndLength ( )

获取软骨信息:EndLength

返回
number EndLength

◆ GetEndOffset()

function XESoftBoneChain GetEndOffset ( )

获取软骨信息:EndOffset

返回
XVECTOR3 EndOffset

◆ GetForce()

function XESoftBoneChain GetForce ( )

获取软骨信息:附加力

返回
XVECTOR3 附加力

◆ GetFreezeAxis()

function XESoftBoneChain GetFreezeAxis ( )

获取软骨信息:轴向限制

返回
number 轴向限制

◆ GetGravity()

function XESoftBoneChain GetGravity ( )

获取软骨信息:重力

返回
XVECTOR3 重力

◆ GetInert()

function XESoftBoneChain GetInert ( )

获取软骨信息:惰性

返回
number 惰性

◆ GetInertCurve()

function XESoftBoneChain GetInertCurve ( )

获取软骨信息:惰性曲线

返回
XRawDistributionFloat 惰性曲线

◆ GetInertCurveFile()

function XESoftBoneChain GetInertCurveFile ( )

获取软骨信息:惰性曲线资源文件

返回
string 惰性曲线资源文件

◆ GetPlaneDirection()

function XESoftBoneChain GetPlaneDirection ( )

获取软骨信息:面碰撞方向

返回
number 面碰撞方向

◆ GetPlaneOffset()

function XESoftBoneChain GetPlaneOffset ( )

获取软骨信息:面碰撞偏移

返回
number 面碰撞偏移

◆ GetPlaneRadius()

function XESoftBoneChain GetPlaneRadius ( )

获取软骨信息:面碰撞半径

返回
number 面碰撞半径

◆ GetPlaneRadiusCurve()

function XESoftBoneChain GetPlaneRadiusCurve ( )

获取软骨信息:面碰撞半径曲线

返回
XRawDistributionFloat 面碰撞半径曲线

◆ GetPlaneRadiusCurveFile()

function XESoftBoneChain GetPlaneRadiusCurveFile ( )

获取软骨信息:面碰撞半径曲线资源文件

返回
string 面碰撞半径曲线资源文件

◆ GetRadius()

function XESoftBoneChain GetRadius ( )

获取软骨信息:半径

返回
number 半径

◆ GetRadiusCurve()

function XESoftBoneChain GetRadiusCurve ( )

获取软骨信息:半径曲线

返回
XRawDistributionFloat 半径曲线

◆ GetRadiusCurveFile()

function XESoftBoneChain GetRadiusCurveFile ( )

获取软骨信息:半径曲线资源文件

返回
string 半径曲线资源文件

◆ GetRootBone()

function XESoftBoneChain GetRootBone ( )

获得根骨骼

返回
XBone XBone根骨骼

◆ GetSoftBoneChain() [1/2]

function XESoftSkeleton GetSoftBoneChain ( nIndex  )

XESoftSkeleton_GetSoftBoneChain00

参数
nIndexnumber
返回
XESoftBoneChain

◆ GetSoftBoneChain() [2/2]

function XESoftSkeleton GetSoftBoneChain ( szBoneName  )

根据根骨骼名字获取一条软骨

参数
szBoneNamestring 根骨骼名称
返回
XESoftBoneChain

◆ GetSoftBoneChainNum()

function XESoftSkeleton GetSoftBoneChainNum ( )

XESoftSkeleton_GetSoftBoneChainNum00

返回
number

◆ GetSoftBoneChainWithAnyChildBone()

function XESoftSkeleton GetSoftBoneChainWithAnyChildBone ( szBoneName  )

根据任意一个子骨骼名字获取一条软骨

参数
szBoneNamestring 根骨骼名称
返回
XESoftBoneChain

◆ GetSoftBones()

function XESoftBoneChain GetSoftBones ( )

获取所有数组

返回
XESoftBone[] 软骨数组

◆ GetStiffness()

function XESoftBoneChain GetStiffness ( )

获取软骨信息:刚度

返回
number 刚度

◆ GetStiffnessCurve()

function XESoftBoneChain GetStiffnessCurve ( )

获取软骨信息:刚度曲线

返回
XRawDistributionFloat 刚度曲线

◆ GetStiffnessCurveFile()

function XESoftBoneChain GetStiffnessCurveFile ( )

获取软骨信息:刚度曲线资源文件

返回
string 刚度曲线资源文件

◆ GetUpdateRate()

function XESoftBoneChain GetUpdateRate ( )

获取软骨信息:更新频率,1秒钟更新多少次

返回
number 更新频率

◆ GetWeight()

function XESoftBoneChain GetWeight ( )

获取权重值

返回
number 权重值

◆ IsEnable()

function XESoftSkeleton IsEnable ( )

获取是否起作用

返回
boolean 是否起作用

◆ IsPlaneCollider()

function XESoftBoneChain IsPlaneCollider ( )

获取软骨信息:是否是面碰撞

返回
boolean 是否是面碰撞

◆ Load()

function XESoftSkeleton Load ( szFile  )

XESoftSkeleton_Load00

参数
szFilestring
返回
number

◆ LoadDampingCurve()

function XESoftBoneChain LoadDampingCurve ( szFile  )

设置软骨信息:阻尼曲线

参数
szFilestring
返回
boolean

◆ LoadElasticityCurve()

function XESoftBoneChain LoadElasticityCurve ( szFile  )

设置软骨信息:弹性曲线

参数
szFilestring
返回
boolean

◆ LoadInertCurve()

function XESoftBoneChain LoadInertCurve ( szFile  )

设置软骨信息:惰性曲线

参数
szFilestring
返回
boolean

◆ LoadPlaneRadiusCurve()

function XESoftBoneChain LoadPlaneRadiusCurve ( szFile  )

设置软骨信息:面碰撞半径曲线

参数
szFilestring 面碰撞半径曲线
返回
boolean

◆ LoadPropertyPrefab()

function XESoftBoneChain LoadPropertyPrefab ( szFile  )

读取软骨信息:加载一个prefab，一次性读取所有属性

参数
szFilestring prefab文件（xml）
返回
boolean

◆ LoadRadiusCurve()

function XESoftBoneChain LoadRadiusCurve ( szFile  )

设置软骨信息:半径曲线

参数
szFilestring
返回
boolean

◆ LoadStiffnessCurve()

function XESoftBoneChain LoadStiffnessCurve ( szFile  )

设置软骨信息:刚度曲线

参数
szFilestring
返回
boolean

◆ new() [1/2]

function XESoftSkeleton new ( pModelInstance  )

XESoftSkeleton_new00

参数
pModelInstanceIXModelInstance
返回
XESoftSkeleton

◆ new() [2/2]

function XESoftBoneChain new ( pSoftSkeleton  ,
pRootBone   
)

XESoftBoneChain_new00

参数
pSoftSkeletonXESoftSkeleton
pRootBoneXBone
返回
XESoftBoneChain

◆ RemoveModelComponentColliders()

function XESoftSkeleton RemoveModelComponentColliders ( )

取消骨骼碰撞体ModelCompoennt

返回
void

◆ RemoveSoftBoneChain()

function XESoftSkeleton RemoveSoftBoneChain ( szBoneName  )

取消一条软骨

参数
szBoneNamestring 根骨骼名称
返回
boolean 是否成功移除

◆ Reset()

function XESoftSkeleton Reset ( )

重置软骨位置到当前骨骼位置

返回
void

◆ ResetSoftBonePosition()

function XESoftBoneChain ResetSoftBonePosition ( )

重置所有软骨位置

返回
void

◆ SetColliderBoneName()

function XESoftBoneChain SetColliderBoneName ( nIndex  ,
szName   
)

设置需要获取的某个骨骼的名称

参数
nIndexnumber
szNamestring
返回
void

◆ SetColliderBoneNum()

function XESoftBoneChain SetColliderBoneNum ( nNum  )

设置骨骼名称的数量

参数
nNumnumber
返回
void

◆ SetCustomCollider()

function XESoftBoneChain SetCustomCollider ( customColliders  )

XESoftBoneChain_SetCustomCollider00

参数
customCollidersCustomCollider[]
返回
void

◆ SetDamping()

function XESoftBoneChain SetDamping ( fDamping  )

设置软骨信息:阻尼

参数
fDampingnumber 阻尼
返回
void

◆ SetDistanceDisable()

function XESoftBoneChain SetDistanceDisable ( bSet  )

设置是否随距离失效

参数
bSetboolean
返回
void

◆ SetDistanceToCamera()

function XESoftBoneChain SetDistanceToCamera ( fDistance  )

设置失效距离

参数
fDistancenumber 失效距离
返回
void

◆ SetElasticity()

function XESoftBoneChain SetElasticity ( fElasticity  )

设置软骨信息:弹性

参数
fElasticitynumber 弹性
返回
void

◆ SetEndLength()

function XESoftBoneChain SetEndLength ( fEndLength  )

设置软骨信息:EndLength

参数
fEndLengthnumber EndLength
返回
void

◆ SetEndOffset()

function XESoftBoneChain SetEndOffset ( vEndOffset  )

设置软骨信息:EndOffset

参数
vEndOffsetXVECTOR3 EndOffset
返回
void

◆ SetExclusionBoneNames()

function XESoftBoneChain SetExclusionBoneNames ( aExclusionName  )

XESoftBoneChain_SetExclusionBoneNames00

参数
aExclusionNamestring[]
返回
void

◆ SetForce()

function XESoftBoneChain SetForce ( vForce  )

设置软骨信息:附加力

参数
vForceXVECTOR3 附加力
返回
void

◆ SetFreezeAxis()

function XESoftBoneChain SetFreezeAxis ( eFreeAxis  )

设置软骨信息:轴向限制

参数
eFreeAxisnumber 轴向限制
返回
void

◆ SetGravity()

function XESoftBoneChain SetGravity ( vGravity  )

设置软骨信息:重力

参数
vGravityXVECTOR3 重力
返回
void

◆ SetInert()

function XESoftBoneChain SetInert ( fInert  )

设置软骨信息:惰性

参数
fInertnumber 惰性
返回
void

◆ SetPlaneCollider()

function XESoftBoneChain SetPlaneCollider ( bPlaneCollider  )

设置软骨信息:是否是面碰撞

参数
bPlaneColliderboolean 是否是面碰撞
返回
void

◆ SetPlaneDirection()

function XESoftBoneChain SetPlaneDirection ( eDirection  )

设置软骨信息:面碰撞方向

参数
eDirectionnumber 面碰撞方向
返回
void

◆ SetPlaneOffset()

function XESoftBoneChain SetPlaneOffset ( fPlaneOffset  )

设置软骨信息:面碰撞偏移

参数
fPlaneOffsetnumber 面碰撞偏移
返回
void

◆ SetPlaneRadius()

function XESoftBoneChain SetPlaneRadius ( fPlaneRadius  )

设置软骨信息:面碰撞半径

参数
fPlaneRadiusnumber 面碰撞半径
返回
void

◆ SetRadius()

function XESoftBoneChain SetRadius ( fRadius  )

设置软骨信息:半径

参数
fRadiusnumber 半径
返回
void

◆ SetStiffness()

function XESoftBoneChain SetStiffness ( fStiffness  )

设置软骨信息:刚度

参数
fStiffnessnumber 刚度
返回
void

◆ SetUpdateRate()

function XESoftBoneChain SetUpdateRate ( fUpdateRate  )

设置软骨信息:更新频率,1秒钟更新多少次

参数
fUpdateRatenumber 更新频率
返回
void

◆ SetWeight()

function XESoftBoneChain SetWeight ( fWeight  )

设置权重值

参数
fWeightnumber 权重值
返回
void

◆ Tick()

function XESoftSkeleton Tick ( fDelta  ,
pBaseCamera   
)

更新

参数
fDeltanumber 更新间隔
pBaseCameraXBaseCamera
返回
void

◆ UpdateProperty()

function XESoftSkeleton UpdateProperty ( )

更新所有软骨的属性

返回
void

变量说明

◆ XESoftBoneChain

XESoftBoneChain = {}
制作者 doxygen 1.9.1