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

Functions

function XBone new () end
 
function XBone Init (pSkeleton) end
 
function XBone Release () end
 
function XBone Duplicate (pDstSkeleton) end
 
function XBone Load (pFile) end
 
function XBone Save (pFile) end
 
function XBone SetName (szName) end
 
function XBone GetName () end
 
function XBone GetSkeleton () end
 
function XBone SetSkeleton (pSkeleton) end
 
function XBone IsAnimDriven () end
 
function XBone Update (nDeltaTime) end
 
function XBone GetParent () end
 
function XBone SetParent (iParent) end
 
function XBone GetParentPtr () end
 
function XBone GetRootBonePtr () end
 
function XBone AddChild (iChild) end
 
function XBone GetChild (iIndex) end
 
function XBone GetChildNum () end
 
function XBone GetChildPtr (iIndex) end
 
function XBone GetFirstController () end
 
function XBone SetFirstController (pController) end
 
function XBone ResetRelativeTM () end
 
function XBone SetRelativeTM (mat) end
 
function XBone SetRelativeTM (quRot, vTrans) end
 
function XBone GetRelativeTM () end
 
function XBone GetRelativeQuat () end
 
function XBone SetUpToParentTM (matUpToParent) end
 
function XBone GetUpToParentTM () end
 
function XBone GetUpToRootTM () end
 
function XBone GetLocalAbsTM () end
 
function XBone GetAbsoluteTM () end
 
function XBone GetNoScaleAbsTM () end
 
function XBone SetLocalAbsTM (mat) end
 
function XBone SetAbsoluteTM (mat) end
 
function XBone IsInheritScale () end
 
function XBone SetInheritScale (InheritScale) end
 
function XBone SetLocalSF (vScale) end
 
function XBone GetLocalSF () end
 
function XBone SetGlobalSF (vScale) end
 
function XBone GetGlobalSF () end
 
function XBone GetBoneColliders () end
 
function XBone AddBoneCollider () end
 
function XBone RemoveBoneCollider (nIndex) end
 
function XBone GetBoneCollider (nIndex) end
 
function XBone GetBoneInitTM () end
 
function XBone SetBoneInitTM (mat) end
 
function XBone GetOriginalMatrix () end
 
function XBone SetOriginalMatrix (mat) end
 
function XBone GetOriginalPos () end
 
function XBone GetOriginalDir () end
 

Variables

 XBone = {}
 
 XBone__XBoneRenderData = {}
 
XBone XBoneRenderData = XBone__XBoneRenderData
 
XBone__XBoneRenderData sphere = {}
 @type XCusSphere More...
 
XBone__XBoneRenderData cones = {}
 @type XCusCone[] More...
 
XBone__XBoneRenderData color = {}
 @type XCOLORBASE More...
 
 XBone__XBoneColliderRenderData = {}
 
XBone XBoneColliderRenderData = XBone__XBoneColliderRenderData
 
XBone__XBoneColliderRenderData capsules = {}
 @type XCusCapsule[] More...
 
XBone__XBoneColliderRenderData szBoneName = ''
 @type string @readonly More...
 
 XBone__BoneState = {}
 
XBone BoneState = XBone__BoneState
 
XBone__BoneState quOrientation = {}
 @type XQUATERNION More...
 
XBone__BoneState vPos = {}
 @type XVECTOR3 More...
 
XBone__BoneState fWeight = 0
 @type number More...
 
XBone__BoneState iBlendMode = 0
 @type number More...
 
 XBone__BoneCollider = {}
 
XBone BoneCollider = XBone__BoneCollider
 
XBone__BoneCollider vCenter = {}
 @type XVECTOR3 More...
 
XBone__BoneCollider fRadius = 0
 @type number More...
 
XBone__BoneCollider fHeight = 0
 @type number More...
 
XBone__BoneCollider vRotate = {}
 @type XVECTOR3 More...
 
XBone__BoneCollider bBoundOutside = false
 @type boolean More...
 
XBone FLAG_FAKEBONE = 0
 
XBone FLAG_FLIPPED = 0
 
XBone BM_NORMAL = 0
 
XBone BM_COMBINE = 0
 
XBone BM_EXCLUSIVE = 0
 
XBone BM_ABSTRACK = 0
 
XBone TRANS_POS_X = 0
 
XBone TRANS_POS_Y = 0
 
XBone TRANS_POS_Z = 0
 
XBone TRANS_POS = 0
 
XBone TRANS_ORI = 0
 
XBone TRANS_ALL = 0
 

Function Documentation

◆ AddBoneCollider()

function XBone AddBoneCollider ( )

添加一个碰撞体,返回指针

Returns
XBone__BoneCollider 碰撞体

◆ AddChild()

function XBone AddChild ( iChild  )

给当前骨头添加子骨头

Parameters
iChildnumber 子骨头索引
Returns
boolean

◆ Duplicate()

function XBone Duplicate ( pDstSkeleton  )

克隆骨头信息

Parameters
pDstSkeletonXSkeleton
Returns
XBone 克隆的骨头指针

◆ GetAbsoluteTM()

function XBone GetAbsoluteTM ( )

获取骨头的绝对空间的矩阵，一般为世界空间的矩阵

Returns
XMATRIX4 骨头的绝对空间矩阵

◆ GetBoneCollider()

function XBone GetBoneCollider ( nIndex  )

根据索引获取一个碰撞体

Parameters
nIndexnumber
Returns
XBone__BoneCollider

◆ GetBoneColliders()

function XBone GetBoneColliders ( )

获取碰撞体信息

Returns
BoneCollider[] 碰撞体

◆ GetBoneInitTM()

function XBone GetBoneInitTM ( )

[为引擎内部模块间调用接口]

Returns
XMATRIX4

◆ GetChild()

function XBone GetChild ( iIndex  )

获取当前骨头某个子骨头索引

Parameters
iIndexnumber [in]要获取的子节点的存储索引
Returns
number 获取到的子骨头节点索引

◆ GetChildNum()

function XBone GetChildNum ( )

获取当前骨头所有子节点个数

Returns
number 当前骨头所有子节点个数

◆ GetChildPtr()

function XBone GetChildPtr ( iIndex  )

获取子骨头指针

Parameters
iIndexnumber 子骨头索引
Returns
XBone 子骨头指针

◆ GetFirstController()

function XBone GetFirstController ( )

获取骨头控制器。注意：骨头更新时，会调用控制器，参与骨头各矩阵的计算

Returns
XBoneControllerBase 骨头控制器

◆ GetGlobalSF()

function XBone GetGlobalSF ( )

获取全局空间的缩放信息， 全局可理解为相对骨架根空间上的缩放信息

Returns
XVECTOR3

◆ GetLocalAbsTM()

function XBone GetLocalAbsTM ( )

获取骨头的本地模型空间矩阵

Returns
XMATRIX4 骨头的本地模型空间矩阵

◆ GetLocalSF()

function XBone GetLocalSF ( )

获取本地空间的缩放信息

Returns
XVECTOR3 本地空间的缩放信息

◆ GetName()

function XBone GetName ( )

获取骨头名称

Returns
string 骨头名称

◆ GetNoScaleAbsTM()

function XBone GetNoScaleAbsTM ( )

获取骨头的模型空间矩阵（不包含缩放信息）

Returns
XMATRIX4 骨头的模型空间矩阵（不包含缩放信息）

◆ GetOriginalDir()

function XBone GetOriginalDir ( )

[为引擎内部模块间调用接口]

Returns
XQUATERNION

◆ GetOriginalMatrix()

function XBone GetOriginalMatrix ( )

[为引擎内部模块间调用接口]

Returns
XMATRIX4

◆ GetOriginalPos()

function XBone GetOriginalPos ( )

[为引擎内部模块间调用接口]

Returns
XVECTOR3

◆ GetParent()

function XBone GetParent ( )

获取骨头的父节点索引

Returns
number 骨头的父节点索引

◆ GetParentPtr()

function XBone GetParentPtr ( )

获取骨头的父节点骨头指针指针

Returns
XBone 骨头的父节点骨头指针指针

◆ GetRelativeQuat()

function XBone GetRelativeQuat ( )

获取骨头相对矩阵的旋转四元数信息

Returns
XQUATERNION 骨头相对矩阵的旋转四元数信息

◆ GetRelativeTM()

function XBone GetRelativeTM ( )

获取骨头的相对矩阵

Returns
XMATRIX4 骨头的相对矩阵

◆ GetRootBonePtr()

function XBone GetRootBonePtr ( )

获取骨头的根节点骨头指针指针

Returns
XBone 骨头的根节点骨头指针

◆ GetSkeleton()

function IXModelInstance GetSkeleton ( )

获取骨头关联的骨架指针

Returns
XSkeleton 骨架指针

获取模型骨架对象

Returns
XSkeleton 模型骨架对象

◆ GetUpToParentTM()

function XBone GetUpToParentTM ( )

获取到父骨头空间的矩阵

Returns
XMATRIX4 到父骨头空间的矩阵

◆ GetUpToRootTM()

function XBone GetUpToRootTM ( )

获取到根骨头空间的矩阵

Returns
XMATRIX4 到根骨头空间的矩阵

◆ Init()

function XBone Init ( pSkeleton  )

根据骨架初始化骨头信息

Parameters
pSkeletonXSkeleton 骨架指针
Returns
boolean 是否初始化成功

◆ IsAnimDriven()

function XBone IsAnimDriven ( )

骨骼更新时，是否受骨架中高度偏移的影响，为xtrue时，会在骨头位置更新时，叠加骨架的高度偏移， [为引擎内部模块间调用接口]

Returns
boolean

◆ IsInheritScale()

function XBone IsInheritScale ( )

父子骨头之间，是否继承缩放信息

Returns
boolean 是否继承缩放信息

◆ Load()

function XBone Load ( pFile  )

从文件加载

Parameters
pFileXFileBase 文件指针
Returns
boolean 是否加载成功

◆ new()

function XBone new ( )

XBone_new00

Returns
XBone

◆ Release()

function XBone Release ( )

释放

Returns
void

◆ RemoveBoneCollider()

function XBone RemoveBoneCollider ( nIndex  )

添加一个碰撞体,返回指针

Parameters
nIndexnumber 删除的碰撞体索引
Returns
void 碰撞体

◆ ResetRelativeTM()

function XBone ResetRelativeTM ( )

重置骨头的相对矩阵. 使用m_matOriginRel来重置相对矩阵

Returns
void

◆ Save()

function XBone Save ( pFile  )

保存到文件

Parameters
pFileXFileBase 文件指针
Returns
boolean 是否保存成功

◆ SetAbsoluteTM()

function XBone SetAbsoluteTM ( mat  )

设置绝对空间的矩阵

Parameters
matXMATRIX4 绝对空间矩阵
Returns
void

◆ SetBoneInitTM()

function XBone SetBoneInitTM ( mat  )

[为引擎内部模块间调用接口]

Parameters
matXMATRIX4
Returns
void

◆ SetFirstController()

function XBone SetFirstController ( pController  )

设置骨头控制器。

Parameters
pControllerXBoneControllerBase 骨头控制器
Returns
void

◆ SetGlobalSF()

function XBone SetGlobalSF ( vScale  )

设置全局空间的缩放信息， 全局可理解为相对骨架根空间上的缩放信息

Parameters
vScaleXVECTOR3 全局空间的缩放信息
Returns
void

◆ SetInheritScale()

function XBone SetInheritScale ( InheritScale  )

设置父子骨头间是否继承缩放信息

Parameters
InheritScaleboolean 是否继承缩放信息
Returns
void

◆ SetLocalAbsTM()

function XBone SetLocalAbsTM ( mat  )

设置本地空间的矩阵

Parameters
matXMATRIX4 本地空间矩阵
Returns
void

◆ SetLocalSF()

function XBone SetLocalSF ( vScale  )

设置本地空间的缩放信息，可理解为骨头上设置的缩放信息

Parameters
vScaleXVECTOR3 本地空间的缩放信息
Returns
void

◆ SetName()

function XBone SetName ( szName  )

设置骨头名称

Parameters
szNamestring 骨头名称
Returns
void

◆ SetOriginalMatrix()

function XBone SetOriginalMatrix ( mat  )

[为引擎内部模块间调用接口]

Parameters
matXMATRIX4
Returns
void

◆ SetParent()

function XBone SetParent ( iParent  )

设置骨头的父节点索引

Parameters
iParentnumber 骨头的父节点索引
Returns
void

◆ SetRelativeTM() [1/2]

function XBone SetRelativeTM ( mat  )

设置骨头的相对矩阵

Parameters
matXMATRIX4 骨头的相对矩阵
Returns
void

◆ SetRelativeTM() [2/2]

function XBone SetRelativeTM ( quRot  ,
vTrans   
)

设置骨头的相对矩阵

Parameters
quRotXQUATERNION 骨头相对矩阵的旋转四元数信息
vTransXVECTOR3 骨头相对矩阵的平移信息
Returns
void

◆ SetSkeleton()

function XBone SetSkeleton ( pSkeleton  )

设置骨头关联的骨架指针

Parameters
pSkeletonXSkeleton 骨架指针
Returns
void

◆ SetUpToParentTM()

function XBone SetUpToParentTM ( matUpToParent  )

设置到父骨头空间的矩阵,但是不影响相对矩阵

Parameters
matUpToParentXMATRIX4 设置到父骨头空间的矩阵
Returns
void

◆ Update()

function XBone Update ( nDeltaTime  )

骨头更新,更新骨头的各矩阵信息， 绝对矩阵，父骨头空间矩阵等都会更新

Parameters
nDeltaTimenumber
Returns
boolean 是否更新成功

Variable Documentation

◆ bBoundOutside

XBone__BoneCollider bBoundOutside = false

@type boolean

◆ BM_ABSTRACK

XBone BM_ABSTRACK = 0

◆ BM_COMBINE

XBone BM_COMBINE = 0

◆ BM_EXCLUSIVE

XBone BM_EXCLUSIVE = 0

◆ BM_NORMAL

XBone BM_NORMAL = 0

◆ BoneCollider

XBone BoneCollider = XBone__BoneCollider

◆ BoneState

XBone BoneState = XBone__BoneState

◆ capsules

XBone__XBoneColliderRenderData capsules = {}

@type XCusCapsule[]

◆ color

XBone__XBoneRenderData color = {}

@type XCOLORBASE

◆ cones

XBone__XBoneRenderData cones = {}

@type XCusCone[]

◆ fHeight

XBone__BoneCollider fHeight = 0

@type number

◆ FLAG_FAKEBONE

XBone FLAG_FAKEBONE = 0

◆ FLAG_FLIPPED

XBone FLAG_FLIPPED = 0

◆ fRadius

XBone__BoneCollider fRadius = 0

@type number

◆ fWeight

XBone__BoneState fWeight = 0

@type number

◆ iBlendMode

XBone__BoneState iBlendMode = 0

@type number

◆ quOrientation

XBone__BoneState quOrientation = {}

@type XQUATERNION

◆ sphere

XBone__XBoneRenderData sphere = {}

@type XCusSphere

◆ szBoneName

XBone__XBoneColliderRenderData szBoneName = ''

@type string @readonly

◆ TRANS_ALL

XBone TRANS_ALL = 0

◆ TRANS_ORI

XBone TRANS_ORI = 0

◆ TRANS_POS

XBone TRANS_POS = 0

◆ TRANS_POS_X

XBone TRANS_POS_X = 0

◆ TRANS_POS_Y

XBone TRANS_POS_Y = 0

◆ TRANS_POS_Z

XBone TRANS_POS_Z = 0

◆ vCenter

XBone__BoneCollider vCenter = {}

@type XVECTOR3

◆ vPos

XBone__BoneState vPos = {}

@type XVECTOR3

◆ vRotate

XBone__BoneCollider vRotate = {}

@type XVECTOR3

◆ XBone

XBone = {}

◆ XBone__BoneCollider

XBone__BoneCollider = {}

◆ XBone__BoneState

XBone__BoneState = {}

◆ XBone__XBoneColliderRenderData

XBone__XBoneColliderRenderData = {}

◆ XBone__XBoneRenderData

XBone__XBoneRenderData = {}

◆ XBoneColliderRenderData

XBone XBoneColliderRenderData = XBone__XBoneColliderRenderData

◆ XBoneRenderData

XBone XBoneRenderData = XBone__XBoneRenderData
Generated by   doxygen 1.8.15