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

Functions

function XESoftBoneChain new (pSoftSkeleton, pRootBone) end
 
function XESoftBoneChain LoadPropertyPrefab (szFile) end
 
function XESoftBoneChain SavePhysicsPropertyPrefab (szFile) end
 
function XESoftBoneChain SaveColliderPropertyPrefab (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 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 Save (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
 

Variables

 XESoftBoneChain = {}
 

Function Documentation

◆ AddSoftBoneChain()

function XESoftSkeleton AddSoftBoneChain ( szBoneName  )

设置一条软骨

Parameters
szBoneNamestring 根骨骼名称
Returns
number xbool是否设置成功

◆ BindModelComponentColliders()

function XESoftSkeleton BindModelComponentColliders ( pModelComponent  )

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

Parameters
pModelComponentXEModelComponent
Returns
void

◆ Enable()

function XESoftSkeleton Enable ( bEnable  )

设置是否起作用

Parameters
bEnableboolean 是否起作用
Returns
void

◆ GetAssetPath()

function XESoftSkeleton GetAssetPath ( )

获取Asset文件路径

Returns
string XString资源文件路径

◆ GetColliderBoneNames()

function XESoftBoneChain GetColliderBoneNames ( )

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

Returns
string[] eFreeAxis轴向限制

◆ GetDamping()

function XESoftBoneChain GetDamping ( )

获取软骨信息:阻尼

Returns
number 阻尼

◆ GetDampingCurve()

function XESoftBoneChain GetDampingCurve ( )

获取软骨信息:阻尼曲线

Returns
XRawDistributionFloat 阻尼曲线

◆ GetDampingCurveFile()

function XESoftBoneChain GetDampingCurveFile ( )

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

Returns
string 阻尼曲线资源文件

◆ GetDistanceDisable()

function XESoftBoneChain GetDistanceDisable ( )

是否随距离失效

Returns
boolean 是否随距离失效

◆ GetDistanceToCamera()

function XESoftBoneChain GetDistanceToCamera ( )

设置是否随距离失效

Returns
number

◆ GetElasticity()

function XESoftBoneChain GetElasticity ( )

获取软骨信息:弹性

Returns
number 弹性

◆ GetElasticityCurve()

function XESoftBoneChain GetElasticityCurve ( )

获取软骨信息:弹性曲线

Returns
XRawDistributionFloat 弹性曲线

◆ GetElasticityCurveFile()

function XESoftBoneChain GetElasticityCurveFile ( )

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

Returns
string 弹性曲线资源文件

◆ GetEndLength()

function XESoftBoneChain GetEndLength ( )

获取软骨信息:EndLength

Returns
number EndLength

◆ GetEndOffset()

function XESoftBoneChain GetEndOffset ( )

获取软骨信息:EndOffset

Returns
XVECTOR3 EndOffset

◆ GetForce()

function XESoftBoneChain GetForce ( )

获取软骨信息:附加力

Returns
XVECTOR3 附加力

◆ GetFreezeAxis()

function XESoftBoneChain GetFreezeAxis ( )

获取软骨信息:轴向限制

Returns
number 轴向限制

◆ GetGravity()

function XESoftBoneChain GetGravity ( )

获取软骨信息:重力

Returns
XVECTOR3 重力

◆ GetInert()

function XESoftBoneChain GetInert ( )

获取软骨信息:惰性

Returns
number 惰性

◆ GetInertCurve()

function XESoftBoneChain GetInertCurve ( )

获取软骨信息:惰性曲线

Returns
XRawDistributionFloat 惰性曲线

◆ GetInertCurveFile()

function XESoftBoneChain GetInertCurveFile ( )

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

Returns
string 惰性曲线资源文件

◆ GetRadius()

function XESoftBoneChain GetRadius ( )

获取软骨信息:半径

Returns
number 半径

◆ GetRadiusCurve()

function XESoftBoneChain GetRadiusCurve ( )

获取软骨信息:半径曲线

Returns
XRawDistributionFloat 半径曲线

◆ GetRadiusCurveFile()

function XESoftBoneChain GetRadiusCurveFile ( )

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

Returns
string 半径曲线资源文件

◆ GetRootBone()

function XESoftBoneChain GetRootBone ( )

获得根骨骼

Returns
XBone XBone根骨骼

◆ GetSoftBoneChain() [1/2]

function XESoftSkeleton GetSoftBoneChain ( nIndex  )

XESoftSkeleton_GetSoftBoneChain00

Parameters
nIndexnumber
Returns
XESoftBoneChain

◆ GetSoftBoneChain() [2/2]

function XESoftSkeleton GetSoftBoneChain ( szBoneName  )

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

Parameters
szBoneNamestring 根骨骼名称
Returns
XESoftBoneChain

◆ GetSoftBoneChainNum()

function XESoftSkeleton GetSoftBoneChainNum ( )

XESoftSkeleton_GetSoftBoneChainNum00

Returns
number

◆ GetSoftBoneChainWithAnyChildBone()

function XESoftSkeleton GetSoftBoneChainWithAnyChildBone ( szBoneName  )

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

Parameters
szBoneNamestring 根骨骼名称
Returns
XESoftBoneChain

◆ GetSoftBones()

function XESoftBoneChain GetSoftBones ( )

获取所有数组

Returns
XESoftBone[] 软骨数组

◆ GetStiffness()

function XESoftBoneChain GetStiffness ( )

获取软骨信息:刚度

Returns
number 刚度

◆ GetStiffnessCurve()

function XESoftBoneChain GetStiffnessCurve ( )

获取软骨信息:刚度曲线

Returns
XRawDistributionFloat 刚度曲线

◆ GetStiffnessCurveFile()

function XESoftBoneChain GetStiffnessCurveFile ( )

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

Returns
string 刚度曲线资源文件

◆ GetUpdateRate()

function XESoftBoneChain GetUpdateRate ( )

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

Returns
number 更新频率

◆ GetWeight()

function XESoftBoneChain GetWeight ( )

获取权重值

Returns
number 权重值

◆ IsEnable()

function XESoftSkeleton IsEnable ( )

获取是否起作用

Returns
boolean 是否起作用

◆ Load()

function XESoftSkeleton Load ( szFile  )

XESoftSkeleton_Load00

Parameters
szFilestring
Returns
number

◆ LoadDampingCurve()

function XESoftBoneChain LoadDampingCurve ( szFile  )

设置软骨信息:阻尼曲线

Parameters
szFilestring
Returns
boolean

◆ LoadElasticityCurve()

function XESoftBoneChain LoadElasticityCurve ( szFile  )

设置软骨信息:弹性曲线

Parameters
szFilestring
Returns
boolean

◆ LoadInertCurve()

function XESoftBoneChain LoadInertCurve ( szFile  )

设置软骨信息:惰性曲线

Parameters
szFilestring
Returns
boolean

◆ LoadPropertyPrefab()

function XESoftBoneChain LoadPropertyPrefab ( szFile  )

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

Parameters
szFilestring prefab文件(xml)
Returns
boolean

◆ LoadRadiusCurve()

function XESoftBoneChain LoadRadiusCurve ( szFile  )

设置软骨信息:半径曲线

Parameters
szFilestring
Returns
boolean

◆ LoadStiffnessCurve()

function XESoftBoneChain LoadStiffnessCurve ( szFile  )

设置软骨信息:刚度曲线

Parameters
szFilestring
Returns
boolean

◆ new() [1/2]

function XESoftBoneChain new ( pSoftSkeleton  ,
pRootBone   
)

XESoftBoneChain_new00

Parameters
pSoftSkeletonXESoftSkeleton
pRootBoneXBone
Returns
XESoftBoneChain

◆ new() [2/2]

function XESoftSkeleton new ( pModelInstance  )

XESoftSkeleton_new00

Parameters
pModelInstanceIXModelInstance
Returns
XESoftSkeleton

◆ RemoveModelComponentColliders()

function XESoftSkeleton RemoveModelComponentColliders ( )

取消骨骼碰撞体ModelCompoennt

Returns
void

◆ RemoveSoftBoneChain()

function XESoftSkeleton RemoveSoftBoneChain ( szBoneName  )

取消一条软骨

Parameters
szBoneNamestring 根骨骼名称
Returns
boolean 是否成功移除

◆ Reset()

function XESoftSkeleton Reset ( )

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

Returns
void

◆ ResetSoftBonePosition()

function XESoftBoneChain ResetSoftBonePosition ( )

重置所有软骨位置

Returns
void

◆ Save()

function XESoftSkeleton Save ( szFile  )

XESoftSkeleton_Save00

Parameters
szFilestring
Returns
boolean

◆ SaveColliderPropertyPrefab()

function XESoftBoneChain SaveColliderPropertyPrefab ( szFile  )

保存软骨信息:将所有碰撞属性值保存成一个prefab文件

Parameters
szFilestring prefab文件(xml)
Returns
boolean

◆ SavePhysicsPropertyPrefab()

function XESoftBoneChain SavePhysicsPropertyPrefab ( szFile  )

保存软骨信息:将所有物理属性值保存成一个prefab文件

Parameters
szFilestring prefab文件(xml)
Returns
boolean

◆ SetColliderBoneName()

function XESoftBoneChain SetColliderBoneName ( nIndex  ,
szName   
)

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

Parameters
nIndexnumber
szNamestring
Returns
void

◆ SetColliderBoneNum()

function XESoftBoneChain SetColliderBoneNum ( nNum  )

设置骨骼名称的数量

Parameters
nNumnumber
Returns
void

◆ SetCustomCollider()

function XESoftBoneChain SetCustomCollider ( customColliders  )

XESoftBoneChain_SetCustomCollider00

Parameters
customCollidersCustomCollider[]
Returns
void

◆ SetDamping()

function XESoftBoneChain SetDamping ( fDamping  )

设置软骨信息:阻尼

Parameters
fDampingnumber 阻尼
Returns
void

◆ SetDistanceDisable()

function XESoftBoneChain SetDistanceDisable ( bSet  )

设置是否随距离失效

Parameters
bSetboolean
Returns
void

◆ SetDistanceToCamera()

function XESoftBoneChain SetDistanceToCamera ( fDistance  )

设置失效距离

Parameters
fDistancenumber 失效距离
Returns
void

◆ SetElasticity()

function XESoftBoneChain SetElasticity ( fElasticity  )

设置软骨信息:弹性

Parameters
fElasticitynumber 弹性
Returns
void

◆ SetEndLength()

function XESoftBoneChain SetEndLength ( fEndLength  )

设置软骨信息:EndLength

Parameters
fEndLengthnumber EndLength
Returns
void

◆ SetEndOffset()

function XESoftBoneChain SetEndOffset ( vEndOffset  )

设置软骨信息:EndOffset

Parameters
vEndOffsetXVECTOR3 EndOffset
Returns
void

◆ SetExclusionBoneNames()

function XESoftBoneChain SetExclusionBoneNames ( aExclusionName  )

XESoftBoneChain_SetExclusionBoneNames00

Parameters
aExclusionNamestring[]
Returns
void

◆ SetForce()

function XESoftBoneChain SetForce ( vForce  )

设置软骨信息:附加力

Parameters
vForceXVECTOR3 附加力
Returns
void

◆ SetFreezeAxis()

function XESoftBoneChain SetFreezeAxis ( eFreeAxis  )

设置软骨信息:轴向限制

Parameters
eFreeAxisnumber 轴向限制
Returns
void

◆ SetGravity()

function XESoftBoneChain SetGravity ( vGravity  )

设置软骨信息:重力

Parameters
vGravityXVECTOR3 重力
Returns
void

◆ SetInert()

function XESoftBoneChain SetInert ( fInert  )

设置软骨信息:惰性

Parameters
fInertnumber 惰性
Returns
void

◆ SetRadius()

function XESoftBoneChain SetRadius ( fRadius  )

设置软骨信息:半径

Parameters
fRadiusnumber 半径
Returns
void

◆ SetStiffness()

function XESoftBoneChain SetStiffness ( fStiffness  )

设置软骨信息:刚度

Parameters
fStiffnessnumber 刚度
Returns
void

◆ SetUpdateRate()

function XESoftBoneChain SetUpdateRate ( fUpdateRate  )

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

Parameters
fUpdateRatenumber 更新频率
Returns
void

◆ SetWeight()

function XESoftBoneChain SetWeight ( fWeight  )

设置权重值

Parameters
fWeightnumber 权重值
Returns
void

◆ Tick()

function XESoftSkeleton Tick ( fDelta  ,
pBaseCamera   
)

更新

Parameters
fDeltanumber 更新间隔
pBaseCameraXBaseCamera
Returns
void

Variable Documentation

◆ XESoftBoneChain