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

#include <XEActor.h>

类 XEActor 继承关系图:
Inheritance graph

函数

function XEActor Tick (fDelMs, bForceTick) end
 
function XEActor GetTypeName () end
 
function XEActor PostInitialized () end
 
function XEActor GetRenderOrderFactor () end
 
function XEActor PresentPhysics (fDel) end
 
function XEActor RenderDrawDebug (pViewport) end
 
function XEActor SetRootComponent (pRootComponent) end
 
function XEActor AttachToActor (pActor) end
 
function XEActor AttachToActor (pActor, attachRules) end
 
function XEActor AttachToActorNode (pParentActor, szBindNodeName) end
 
function XEActor AttachToActorNode (pParentActor, szBindNodeName, attachRules) end
 
function XEActor DetachFromActor () end
 
function XEActor DetachFromActor (detachRules) end
 
function XEActor GetCusAABB () end
 
function XEActor RayPick (hr) end
 
function XEActor RayPick (hr, vScreenPoint, viewport) end
 
function XEActor RayPick (vScreenPoint, pViewport) end
 
function XEActor FocusActor (bFocus) end
 
function XEActor OnSocketTick (pBindSocketIns, matWorld) end
 
function XEActor OnSocketRender (pBindSocketIns) end
 
function XEActor SetActorLocation (fX, fY, fZ) end
 
function XEActor SetActorLocation (loc) end
 
function XEActor SetActorRotation (fPitch, fYaw, fRoll) end
 
function XEActor SetActorRotation (rot) end
 
function XEActor SetDeleted (bDelete) end
 
function XEActor SetHidden (bHide) end
 
function XEActor SetHiddenInGame (bHide) end
 
function XEActor SetActorName (szActorName, pContext, bSameNameForbiden, bInAllLevels) end
 
function XEActor GetRootComponent () end
 
function XEActor GetBelongToChildActorComponent () end
 
function XEActor GetComponentOfIndex (nIndex) end
 
function XEActor GetParentActor () end
 
function XEActor GetChildActors () end
 
function XEActor GetAllChildActors () end
 
function XEActor GetActorLocation () end
 
function XEActor GetActorRotation () end
 
function XEActor GetActorScale () end
 
function XEActor SetActorScale (sca) end
 
function XEActor GetActorLocalLocation () end
 
function XEActor SetActorLocalLocation (location) end
 
function XEActor GetActorLocalRotation () end
 
function XEActor SetActorLocalRotation (quat) end
 
function XEActor GetActorLocalScale () end
 
function XEActor SetActorLocalScale (scale) end
 
function XEActor GetRawWorldTransform () end
 
function XEActor GetWorldTransform () end
 
function XEActor GetLocalTransform () end
 
function XEActor ChangeSubActorFilterPath (strParentOriginName, strParentNewName) end
 
function XEActor GetComponentValidIndex () end
 
function XEActor MergeToWorldTransform (toMatrix) end
 
function XEActor ApplyWorldTransform (matrix, bSyncGuestFromParent) end
 
function XEActor ApplyLocalTransform (matrix, bSyncGuestFromParent) end
 
function XEActor TravelToGuestWorld (pGuestWorld) end
 
function XEActor ReturnBackToOwnerWorld () end
 
function XEActor IsInGuestWorld () end
 
function XEActor GetActorShortName () end
 
function XEActor GetParentActorTypeFilterList () end
 
function XEActor AddParentActorTypeFilter (strActorType) end
 
function XEActor GetMergeRenderHidden (nBit) end
 
function XEActor SetMergeRenderHidden (nMergeBit, bHidden) end
 
function XEActor SetMergeRenderHiddenEnable (nMergeBit, bEnable) end
 
function XEActor ResetMergeRenderHidden () end
 
function XEActor UpdateLocalTransformForChildComponent () end
 
function XEActor SetTransformMergeMode (bMerge, bRecursion) end
 
function XEActor AddActorComponent (szType) end
 
function XEActor GetActorComponent (szType) end
 
function XEActor GetActorComponent (szType, runType) end
 
function XEActor GetActorForwardVector () end
 
function XEActor GetActorUpVector () end
 
function XEActor GetActorRightVector () end
 
function XEActor SetForwardDirAndUp (vForwardDir, vUp) end
 
function XEActor SetPositionAndForwardDirUp (vPosition, vForwardDir, vUp) end
 
function XEActor RotateX (fDeltaRadian) end
 
function XEActor RotateY (fDeltaRadian) end
 
function XEActor RotateZ (fDeltaRadian) end
 
function XEActor RotateAxis (vRotateAxis, fDeltaRadian) end
 
function XEActor IsHidden () end
 
function XEActor IsHiddenInGame () end
 
function XEActor SetBoundingBoxColor (clVal) end
 
function XEActor GetBoundingBoxColor () end
 
function XEActor GetActorName () end
 
function XEActor GetActorIdString () end
 
function XEActor GetActorOriginalIdString () end
 
function XEActor SetActorTickEnabled (bEnable) end
 
function XEActor IsActorTickable () end
 
function XEActor SetOrder (nOrder) end
 
function XEActor GetOrder () end
 
function XEActor IsDeleted () end
 
function XEActor IsModified () end
 
function XEActor SetModified (bModified) end
 
function XEActor GetPickMask () end
 
function XEActor GetPickPriority () end
 
function XEActor IsPickEnable () end
 
function XEActor SetPickMask (nMask) end
 
function XEActor SetPickPriority (nPriority) end
 
function XEActor SetFilterPath (szFilterPath) end
 
function XEActor SetFilterPath (szFilterPath, bIsToLower) end
 
function XEActor GetFilterPath () end
 
function XEActor IsTransformMergeMode () end
 
function XEActor SetDrawDebugType (nDebug) end
 
function XEActor GetDrawDebugType () end
 
function XEActor IsDrawAuxiliary () end
 
function XEActor IsBoundingBoxVisible () end
 
function XEActor IsDummyShapeVisible () end
 
function XEActor GetCollisionChannel () end
 
function XEActor SetCollisionChannel (ccm) end
 
function XEActor ReCalculateParentMatrixByUserNode (pParentActor) end
 
function XEActor UpdateBindDataFromParentUserNode (bBindUserNodeData) end
 
function XEActor GetBindUserNodeData () end
 
function XEActor SetUpdateTranfromFromUserNode (bIsUpdate) end
 
function XEActor GetIsUpdateTranformFromUserNode () end
 
function XEActor IsChildActor (pChildActor) end
 
function XEActor GetOwner () end
 
function XEActor GetLevelOwner () end
 
function XEActor SpawnCloneActor (bSpawnChildren) end
 
function XEActor GeSerializeContent () end
 
function XEActor DeserializeFromContent (strContent) end
 
function XEActor SetPrefabInstance (pPrefabIns) end
 
function XEActor GetPrefabInstance () end
 
function XEActor IsPrefabInstanceRoot () end
 
function XEActor GetOwnerContainer () end
 
function XEActor SetOwnerContainer (pContainer) end
 
function XEActor GetRenderGroup () end
 
function XEActor SetRenderGroup (eARG) end
 
function XEActor SetOutlineVisible (bVisible) end
 
function XEActor GetOutlineComponent () end
 

变量

 XEActor = {}
 
XEActor EDD_DRAW_NONE = 0
 
XEActor EDD_DRAW_AUXILIARY = 0
 
XEActor EDD_DUMMY_SHAPE = 0
 
XEActor EDD_BOUNDINGBOX = 0
 
XEActor EDD_OUTLINE = 0
 

函数说明

◆ AddActorComponent()

function XEActor AddActorComponent ( szType  )

为当前XEActor添加指定类型的组件

参数
szTypestring 组件类型名称
返回
XEActorComponent 返回添加的组件指针

◆ AddParentActorTypeFilter()

function XEActor AddParentActorTypeFilter ( strActorType  )

添加过滤父Actor的类型, 如果在此列表中，则该类型Actor不允许挂载其他Actor

参数
strActorTypestring
返回
void

◆ ApplyLocalTransform()

function XEActor ApplyLocalTransform ( matrix  ,
bSyncGuestFromParent   
)

设置当前非头饰的XEActor的相对矩阵

参数
matrixXMATRIX4 设置当前非头饰的XEActor的相对矩阵
bSyncGuestFromParentboolean 是否同步更新与其关联的子Actor组件的世界矩阵（当本Actor作为子Actor组件嵌套到了其他Actor上，本Actor会记录这个子Actor组件）
返回
boolean 是否设置成功

◆ ApplyWorldTransform()

function XEActor ApplyWorldTransform ( matrix  ,
bSyncGuestFromParent   
)

设置当前非头饰的XEActor的世界矩阵

参数
matrixXMATRIX4 设置当前非头饰的XEActor的世界矩阵
bSyncGuestFromParentboolean 是否同步更新与其关联的子Actor组件的世界矩阵（当本Actor作为子Actor组件嵌套到了其他Actor上，本Actor会记录这个子Actor组件）
返回
boolean 是否设置成功

◆ AttachToActor() [1/2]

function XEActor AttachToActor ( pActor  )

根据指定的嵌套规则，将当前XEActor附加到指定XEActor(pActor)上，即父子Actor嵌套。

参数
pActorXEActor 当前XEActor将要附加到的XEActor，也就是pActor将变为当前XEActor的父节点。
返回
void
注意
此函数默认采用KeepWorld的嵌套规则，含义是子Actor附加到父Actor时，子Actor的世界状态（位置、朝向和大小）不改变。

◆ AttachToActor() [2/2]

function XEActor AttachToActor ( pActor  ,
attachRules   
)

附加到其他Actor,采用KeepWorld的嵌套规则，将当前 XEActor 附加到指定 XEActor(pActor)上，即父子 Actor 嵌套。

参数
pActorXEActor 当前XEActor将要附加到的XEActor，也就是pActor将变为当前XEActor的父节点。
attachRulesXEAttachRules 指定的父子Actor嵌套规则
返回
void
注意
目前XECoreSDK中支持三种父子嵌套的规则，分别是KeepRelative 、KeepWorld 、SnapToTarget，具体可参见 XEAttachRules 部分

◆ AttachToActorNode() [1/2]

function XEActor AttachToActorNode ( pParentActor  ,
szBindNodeName   
)

将当前 XEActor 附加到指定pParentActor的指定节点上，即父子Actor嵌套。如果父Actor不存在szBindNodeName对应的节点， 则父子嵌套失败。默认采用XEAttachRules::SnapToTargetNotIncludingScale 嵌套规则。 子 Actor 的平移和旋转采用父 Actor的节点的平移和旋转，子 Actor 的缩放还是采用自身的世界坐标系的缩放。

参数
pParentActorXEActor 当前XEActor将要附加到的XEActor，也就是pActor将变为当前XEActor的父节点。
szBindNodeNamestring 用于绑定子Actor的父Actor上的节点名称，可以是骨骼名称，也可以是槽名称。
返回
void
注意
此函数采用XEAttachRules::SnapToTargetNotIncludingScale 嵌套规则，表示子 Actor 附加到父 Actor 的指定节点时，

◆ AttachToActorNode() [2/2]

function XEActor AttachToActorNode ( pParentActor  ,
szBindNodeName  ,
attachRules   
)

根据指定的嵌套规则，将当前XEActor附加到指定pParentActor的指定节点上，即父子Actor嵌套。 如果父 Actor 不存在szBindNodeName对应的节点，则父子嵌套失败。

参数
pParentActorXEActor 当前XEActor将要附加到的XEActor，也就是pActor将变为当前XEActor的父节点。
szBindNodeNamestring 用于绑定子Actor的父Actor上的节点名称，可以是骨骼名称，也可以是槽名称。
attachRulesXEAttachRules 指定子Actor嵌套到父Actor指定节点的规则
返回
void

◆ ChangeSubActorFilterPath()

function XEActor ChangeSubActorFilterPath ( strParentOriginName  ,
strParentNewName   
)

修改子Actor的筛选路径

参数
strParentOriginNamestring 原始路径名
strParentNewNamestring 新路径名
返回
boolean

◆ DeserializeFromContent()

function XEActor DeserializeFromContent ( strContent  )

从序列化字符串中还原Actor的参数信息（Warning! 如果Actor已经被反序列化，则存在数据丢失或者冲突风险）

参数
strContentstring
返回
boolean

◆ DetachFromActor() [1/2]

function XEActor DetachFromActor ( )

采用KeepWorld规则解除当前Actor与其父Actor的父子关系，也就是保持当前Actor的世界状态不改变 并自动转移到所属的XELevel！

返回
void

◆ DetachFromActor() [2/2]

function XEActor DetachFromActor ( detachRules  )

根据指定的解除规则，解除当前Actor与其父Actor的父子关系 并自动转移到所属的XELevel！

参数
detachRulesXEDetachmentTransformRules 表示当前Actor与其父Actor解除父子关系时，当前Actor的世界状态如何改变的规则
返回
void
注意
目前XECoreSDK 支持两种解除父子关系的规则，分别是KeepRelative 和 KeepWorld，具体可参见 XEDetachmentTransformRules.

◆ FocusActor()

function XEActor FocusActor ( bFocus  )

聚焦当前Actor

参数
bFocusboolean
返回
void

◆ GeSerializeContent()

function XEActor GeSerializeContent ( )

获取Actor的序列化字符串(xml格式)

返回
string

◆ GetActorComponent() [1/2]

function XEActor GetActorComponent ( szType  )

XEActor_GetActorComponent00

参数
szTypestring
返回
XEActorComponent

◆ GetActorComponent() [2/2]

function XEActor GetActorComponent ( szType  ,
runType   
)

XEActor_GetActorComponent01

参数
szTypestring
runTypenumber
返回
XEActorComponent

◆ GetActorForwardVector()

function XEActor GetActorForwardVector ( )

获取当前Actor在世界坐标系下的朝向(Z)单位向量

返回
XVECTOR3

◆ GetActorIdString()

function XEActor GetActorIdString ( )

获取当前Actor的唯一Id字符串

返回
string

◆ GetActorLocalLocation()

function XEActor GetActorLocalLocation ( )

获取当前Actor相对于父Actor坐标系的局部坐标位置

返回
XVECTOR3

◆ GetActorLocalRotation()

function XEActor GetActorLocalRotation ( )

获取当前Actor相对于父Actor坐标系的局部坐标旋转

返回
XQUATERNION

◆ GetActorLocalScale()

function XEActor GetActorLocalScale ( )

获取当前Actor相对于父Actor坐标系的局部坐标缩放

返回
XVECTOR3

◆ GetActorLocation()

function XEActor GetActorLocation ( )

获取当前Actor在世界坐标系中的位置

返回
XVECTOR3

◆ GetActorName()

function XEActor GetActorName ( )

获取当前Actor名字

返回
string

◆ GetActorOriginalIdString()

function XEActor GetActorOriginalIdString ( )

获取当前Actor作为复制体时的来源ActorId字符串[运行时]

返回
string

◆ GetActorRightVector()

function XEActor GetActorRightVector ( )

获取当前Actor在世界坐标系下的向右(X)单位向量

返回
XVECTOR3

◆ GetActorRotation()

function XEActor GetActorRotation ( )

获取当前Actor在世界坐标系中的朝向

返回
XQUATERNION

◆ GetActorScale()

function XEActor GetActorScale ( )

获取当前Actor在世界坐标系中的缩放值

返回
XVECTOR3

◆ GetActorShortName()

function XEActor GetActorShortName ( )

获取当前Actor的短名字（只有名字，没有前缀）

返回
string

◆ GetActorUpVector()

function XEActor GetActorUpVector ( )

获取当前Actor在世界坐标系下的UP(Y)单位向量

返回
XVECTOR3

◆ GetAllChildActors()

function XEActor GetAllChildActors ( )

获取当前XEActor包含的所有子孙Actor，包括其子Actor包含的子孙Actor

返回
XEActor[]
void

◆ GetBelongToChildActorComponent()

function XEActor GetBelongToChildActorComponent ( )

获取当前Actor属于哪个Actor的子ActorComponent

返回
XEChildActorComponent

◆ GetBindUserNodeData()

function XEActor GetBindUserNodeData ( )

获取父子嵌套时挂载节点信息

返回
XEBindUserNodeData

◆ GetBoundingBoxColor()

function XEActor GetBoundingBoxColor ( )

获取当前Actor的包围盒颜色

返回
number

◆ GetChildActors()

function XEActor GetChildActors ( )

获取当前XEActor包含的直接子Actor，不包括其子Actor包含的子孙Actor

返回
XEActor[]
void

◆ GetCollisionChannel()

function XEActor GetCollisionChannel ( )

获取当前Actor的碰撞通道

返回
XECollisionChannelMeta

◆ GetComponentOfIndex()

function XEActor GetComponentOfIndex ( nIndex  )

根据索引获取该Actor的（子）组件

参数
nIndexnumber 索引
返回
XEActorComponent 获取到的组件指针

◆ GetComponentValidIndex()

function XEActor GetComponentValidIndex ( )

获取一个有效的组件索引值

返回
number

◆ GetCusAABB()

function XEActor GetCusAABB ( )

获取当前 XEActor 的 AABB 包围盒，并返回

返回
XCusAABB

◆ GetDrawDebugType()

function XEActor GetDrawDebugType ( )

获取当前Actor渲染的辅助类型

返回
number

◆ GetFilterPath()

function XEActor GetFilterPath ( )

获取筛选路径字符串

返回
string

◆ GetIsUpdateTranformFromUserNode()

function XEActor GetIsUpdateTranformFromUserNode ( )

是否根据挂载节点更新当前Actor的Transform

返回
boolean

◆ GetLevelOwner()

function XEActor GetLevelOwner ( )

获取当前Actor所在的关卡对象指针

返回
XELevel

◆ GetLocalTransform()

function XEActor GetLocalTransform ( )

获取当前XEActor的本地矩阵

返回
XMATRIX4

◆ GetMergeRenderHidden()

function XEActor GetMergeRenderHidden ( nBit  )

获取显隐的合并状态值，每两位组成一对， 高位表示该状态是否有效， 低位表示是否显示， 当所有有效位对应的显示状态为1时，隐藏，否则显示

参数
nBitnumber 要获取的位
返回
boolean 该位的显隐状态

◆ GetOrder()

function XEActor GetOrder ( )

获取当前XEActor的序号

返回
number

◆ GetOutlineComponent()

function XEActor GetOutlineComponent ( )

获取Outline组件

返回
XEOutlineComponent

◆ GetOwner()

function XEActor GetOwner ( )

获取当前Actor所属的世界对象指针

返回
XEWorld

◆ GetOwnerContainer()

function XEActor GetOwnerContainer ( )

获取拥有者Container

返回
XEActorContainer

◆ GetParentActor()

function XEActor GetParentActor ( )

获取当前Actor的父Actor

返回
XEActor

◆ GetParentActorTypeFilterList()

function XEActor GetParentActorTypeFilterList ( )

获取attach时过滤父Actor的类型

返回
string[]

◆ GetPickMask()

function XEActor GetPickMask ( )

获取当前XEActor的拾取掩码

返回
number

◆ GetPickPriority()

function XEActor GetPickPriority ( )

获取当前XEActor的拾取优先级

返回
number

◆ GetPrefabInstance()

function XEPrefabComponent GetPrefabInstance ( )

XEActor_GetPrefabInstance00

返回
XEPrefabInstance

XEPrefabActor_GetPrefabInstance01

返回
XEPrefabInstance

XEPrefabComponent_GetPrefabInstance01

返回
XEPrefabInstance

◆ GetRawWorldTransform()

function XEActor GetRawWorldTransform ( )

获取当前XEActor的原始世界矩阵，实际是从引擎获取当前实例的世界矩阵

返回
XMATRIX4

◆ GetRenderGroup()

function XEActor GetRenderGroup ( )

获取Actor的渲染分组

返回
number

◆ GetRenderOrderFactor()

function XEActor GetRenderOrderFactor ( )

获取Actor渲染顺序影响因子（位置的z分量）

返回
number

◆ GetRootComponent()

function XEActor GetRootComponent ( )

获取当前XEActor的根组件

返回
XEActorComponent

XEActor_GetRootComponent01

返回
XEActorComponent

◆ GetTypeName()

function XEActor GetTypeName ( )

获取当前XEActor的类型，如XECameraActor的类型是“CameraActor”；XEDirLightActor的类型是 “DirLightActor”。

返回
string

◆ GetWorldTransform()

function XEActor GetWorldTransform ( )

获取当前XEActor的世界矩阵

返回
XMATRIX4

◆ IsActorTickable()

function XEActor IsActorTickable ( )

获取当前Actor是否允许Tick

返回
boolean

◆ IsBoundingBoxVisible()

function XEActor IsBoundingBoxVisible ( )

包围盒是否可见

返回
boolean

◆ IsChildActor()

function XEActor IsChildActor ( pChildActor  )

判断某个Actor是否是当前Actor的子Actor

参数
pChildActorXEActor
返回
boolean

◆ IsDeleted()

function XEActor IsDeleted ( )

判断当前XEActor的是否被标记为已删除

返回
boolean

◆ IsDrawAuxiliary()

function XEActor IsDrawAuxiliary ( )

判断渲染辅助类型EDD_DRAW_AUXILIARY是否被标记

返回
boolean

◆ IsDummyShapeVisible()

function XEActor IsDummyShapeVisible ( )

Actor的示意图例/渲染示意形状是否可见

返回
boolean

◆ IsHidden()

function XEActor IsHidden ( )

获取当前Actor是否隐藏

返回
boolean

◆ IsHiddenInGame()

function XEActor IsHiddenInGame ( )

获取当前Actor是否在世界运行态时隐藏的状态

返回
boolean

◆ IsInGuestWorld()

function XEActor IsInGuestWorld ( )

当前Actor是否在其他世界，返回true，表示目前在其他世界；返回false，表示目前在自己所在的世界

返回
boolean

◆ IsModified()

function XEActor IsModified ( )

判断当前XEActor(包括它的组件)是否被标记为已修改

返回
boolean

◆ IsPickEnable()

function XEActor IsPickEnable ( )

判断当前XEActor的是否允许拾取

返回
boolean

◆ IsPrefabInstanceRoot()

function XEActor IsPrefabInstanceRoot ( )

Actor是否为Prefab实例的根Actor

返回
boolean

◆ IsTransformMergeMode()

function XEActor IsTransformMergeMode ( )

判断Transform是否处于合并模式

返回
boolean

◆ MergeToWorldTransform()

function XEActor MergeToWorldTransform ( toMatrix  )

设置当前代表头饰的XEActor的世界矩阵，目前此方法仅用于头饰模型，如果想为非头饰的模型设置世界矩阵，可通过调用ApplyWorldTransform函数。

参数
toMatrixXMATRIX4 设置当前代表头饰的XEActor的世界矩阵
返回
boolean 是否设置成功

◆ OnSocketRender()

function XEActor OnSocketRender ( pBindSocketIns  )

当当前XEActor被绑定到其他槽上时，用于渲染绑定物体

参数
pBindSocketInsXEBindSocketInstance 来源插槽
返回
void

◆ OnSocketTick()

function XEActor OnSocketTick ( pBindSocketIns  ,
matWorld   
)

当当前XEActor被绑定到其他槽上时，用于根据槽的变换更新当前XEActor的状态。

参数
pBindSocketInsXEBindSocketInstance
matWorldXMATRIX4 用于更新当前XEActor状态的世界矩阵
返回
void

◆ PostInitialized()

function XEActor PostInitialized ( )

在初始化完成后， 可能会进行一些后处理操作

返回
void

◆ PresentPhysics()

function XEActor PresentPhysics ( fDel  )

更新物理

参数
fDelnumber 间隔
返回
void

◆ RayPick() [1/3]

function XEActorComponent RayPick ( hr  )

对当前 XEActor 执行拾取运算，并返回拾取结果

参数
hrXEHitResult [in][out]拾取结果结构体，包含输入的射线起始位置和方向；输出的拾取到的XEActor、拾取到的3D场景的坐标点等，具体参考XEHitResult的介绍.
返回
boolean 是否拾取成功

射线拾取（只拾取当前组件，不包括child）

参数
hrXEHitResult [in][out]拾取结果结构体，包含输入的射线起始位置和方向；输出的拾取到的XEActor、拾取到的3D场景的坐标点等，具体参考XEHitResult的介绍.
返回
boolean 表示是否拾取到

◆ RayPick() [2/3]

function XEActor RayPick ( hr  ,
vScreenPoint  ,
viewport   
)

对当前 XEActor 执行拾取运算，并返回拾取结果

参数
hrXEHitResult [in][out]拾取结果结构体，包含输入的射线起始位置和方向；输出的拾取到的XEActor、拾取到的3D场景的坐标点等，具体参考XEHitResult的介绍.
vScreenPointXVECTOR2 拾取时的像素坐标，例如在编辑器的窗口中进行拾取时，鼠标的坐标.
viewportXViewport 当前拾取坐标所在窗口绑定的视口对象.
返回
boolean 是否拾取成功

◆ RayPick() [3/3]

function XEActor RayPick ( vScreenPoint  ,
pViewport   
)

对当前 XEActor 执行拾取运算，并返回拾取结果

参数
vScreenPointXVECTOR2 拾取时的像素坐标，例如在编辑器的窗口中进行拾取时，鼠标的坐.
pViewportXViewport 当前拾取坐标所在窗口绑定的视口对象.
返回
XEHitResult 拾取结果结构体，具体参考XEHitResult的介绍.

◆ ReCalculateParentMatrixByUserNode()

function XEActor ReCalculateParentMatrixByUserNode ( pParentActor  )

根据嵌套时选择的父Actor的骨骼或槽点，得到对应的矩阵信息

参数
pParentActorXEActor 当前Actor的父Actor
返回
XMATRIX4
boolean

◆ RenderDrawDebug()

function XEActor RenderDrawDebug ( pViewport  )

渲染当前XEActor的辅助元素，默认不渲染任何辅助元素，子类可重写此函数来渲染不同的元素，如相机Actor可渲染其视椎体的线框。

参数
pViewportXEViewport 当前Actor所属的世界对象绑定的视口指针
返回
void

◆ ResetMergeRenderHidden()

function XEActor ResetMergeRenderHidden ( )

重置显隐的合并状态值

返回
void

◆ ReturnBackToOwnerWorld()

function XEActor ReturnBackToOwnerWorld ( )

当前Actor回到自己的世界

返回
boolean 是否成功

◆ RotateAxis()

function XEActor RotateAxis ( vRotateAxis  ,
fDeltaRadian   
)

将当前XEActor绕vRotateAxis轴旋转fDeltaRadian弧度

参数
vRotateAxisXVECTOR3
fDeltaRadiannumber
返回
void

◆ RotateX()

function XEActor RotateX ( fDeltaRadian  )

将当前XEActor绕X轴旋转fDeltaRadian弧度。

参数
fDeltaRadiannumber
返回
void

◆ RotateY()

function XEActor RotateY ( fDeltaRadian  )

将当前XEActor绕Y轴旋转fDeltaRadian弧度。

参数
fDeltaRadiannumber
返回
void

◆ RotateZ()

function XEActor RotateZ ( fDeltaRadian  )

将当前XEActor绕Z轴旋转fDeltaRadian弧度。

参数
fDeltaRadiannumber
返回
void

◆ SetActorLocalLocation()

function XEActor SetActorLocalLocation ( location  )

获取当前Actor相对于父Actor坐标系的局部坐标位置

参数
locationXVECTOR3
返回
void

◆ SetActorLocalRotation()

function XEActor SetActorLocalRotation ( quat  )

设置当前Actor相对于父Actor坐标系的局部坐标旋转

参数
quatXQUATERNION
返回
void

◆ SetActorLocalScale()

function XEActor SetActorLocalScale ( scale  )

设置当前Actor相对于父Actor坐标系的局部坐标缩放

参数
scaleXVECTOR3
返回
void

◆ SetActorLocation() [1/2]

function XEActor SetActorLocation ( fX  ,
fY  ,
fZ   
)

设置当前XEActor在世界坐标系中的位置

参数
fXnumber 在世界中指定位置的x分量
fYnumber 在世界中指定位置的y分量
fZnumber 在世界中指定位置的z分量
返回
void

◆ SetActorLocation() [2/2]

function XEActor SetActorLocation ( loc  )

设置当前XEActor在世界坐标系中的位置

参数
locXVECTOR3 在世界中指定的位置
返回
void

◆ SetActorName()

function XEActor SetActorName ( szActorName  ,
pContext  ,
bSameNameForbiden  ,
bInAllLevels   
)

设置当前XEActor的名称, 子类可对此方法进行重载。注意， 改变Actor的名字的行为有风险！您需要在子类中解决名字改变带来的风险

参数
szActorNamestring 代表要为XEActor设置名称的字符串
pContextXEWorld 当前XEActor所属的世界指针，以允许该Actor在未指定所属世界时，外部传入一个世界上下文。
bSameNameForbidenboolean 是否禁止名称重复
bInAllLevelsboolean 是否修改所有Level中可能存在同名的actor，如果为false,则仅修改这个Actor所属Level
返回
boolean 表示设置是否成功

◆ SetActorRotation() [1/2]

function XEActor SetActorRotation ( fPitch  ,
fYaw  ,
fRoll   
)

设置当前XEActor在世界坐标系中的朝向

参数
fPitchnumber 在世界坐标系下，绕x轴旋转角(弧度制)
fYawnumber 在世界坐标系下，绕y轴旋转角(弧度制)
fRollnumber 在世界坐标系下，绕z轴旋转角(弧度制)
返回
void

◆ SetActorRotation() [2/2]

function XEActor SetActorRotation ( rot  )

设置当前XEActor在世界坐标系中的朝向

参数
rotXQUATERNION 代表当前XEActor在世界中朝向的四元数
返回
void

◆ SetActorScale()

function XEActor SetActorScale ( sca  )

设置当前Actor在世界坐标系中的缩放值

参数
scaXVECTOR3
返回
void

◆ SetActorTickEnabled()

function XEActor SetActorTickEnabled ( bEnable  )

设置当前Actor是否允许Tick

参数
bEnableboolean
返回
void

◆ SetBoundingBoxColor()

function XEActor SetBoundingBoxColor ( clVal  )

设置当前Actor的包围盒颜色

参数
clValnumber
返回
void

◆ SetCollisionChannel()

function XEActor SetCollisionChannel ( ccm  )

设置当前Actor的碰撞通道

参数
ccmXECollisionChannelMeta
返回
void

◆ SetDeleted()

function XEActor SetDeleted ( bDelete  )

设置删除状态

参数
bDeleteboolean 是否删除
返回
void

◆ SetDrawDebugType()

function XEActor SetDrawDebugType ( nDebug  )

设置当前Actor渲染的辅助类型

参数
nDebugnumber
返回
void

◆ SetFilterPath() [1/2]

function XEActor SetFilterPath ( szFilterPath  )

设置当前XEActor的筛选路径，默认把路径小写

参数
szFilterPathstring
返回
void

◆ SetFilterPath() [2/2]

function XEActor SetFilterPath ( szFilterPath  ,
bIsToLower   
)

设置当前XEActor的筛选路径

参数
szFilterPathstring
bIsToLowerboolean 是否把路径字符串小写
返回
void

◆ SetForwardDirAndUp()

function XEActor SetForwardDirAndUp ( vForwardDir  ,
vUp   
)

在世界坐标系下，设置当前XEActor的朝向向量和UP向量。通过设置朝向向量和UP向量设置当前XEActor的旋转朝向

参数
vForwardDirXVECTOR3
vUpXVECTOR3
返回
void

◆ SetHidden()

function XEActor SetHidden ( bHide  )

设置隐藏状态

参数
bHideboolean 是否隐藏
返回
void

◆ SetHiddenInGame()

function XEActor SetHiddenInGame ( bHide  )

设置当前Actor是否在世界运行态时隐藏

参数
bHideboolean
返回
void

◆ SetMergeRenderHidden()

function XEActor SetMergeRenderHidden ( nMergeBit  ,
bHidden   
)

设置显隐的合并状态值

参数
nMergeBitnumber
bHiddenboolean
返回
number 当前合并状态值

◆ SetMergeRenderHiddenEnable()

function XEActor SetMergeRenderHiddenEnable ( nMergeBit  ,
bEnable   
)

设置显隐的合并状态值的指定有效位是否有效

参数
nMergeBitnumber 要设置的位
bEnableboolean 要设置的显隐状态
返回
number 当前合并状态值

◆ SetModified()

function XEActor SetModified ( bModified  )

设置当前Actor是否被修改了

参数
bModifiedboolean
返回
void

◆ SetOrder()

function XEActor SetOrder ( nOrder  )

设置当前XEActor的序号，用于排序使用

参数
nOrdernumber
返回
void

◆ SetOutlineVisible()

function XEActor SetOutlineVisible ( bVisible  )

设置是否渲染Outline

参数
bVisibleboolean
返回
void

◆ SetOwnerContainer()

function XEActor SetOwnerContainer ( pContainer  )

设置拥有者Container

参数
pContainerXEActorContainer
返回
void

◆ SetPickMask()

function XEActor SetPickMask ( nMask  )

设置当前XEActor的拾取掩码

参数
nMasknumber
返回
void

◆ SetPickPriority()

function XEActor SetPickPriority ( nPriority  )

设置当前XEActor的拾取优先级

参数
nPrioritynumber
返回
void

◆ SetPositionAndForwardDirUp()

function XEActor SetPositionAndForwardDirUp ( vPosition  ,
vForwardDir  ,
vUp   
)

在世界坐标系下，设置当前XEActor的位置、朝向向量和UP向量，其中设置朝向向量和UP向量是为了计算当前XEActor的旋转状态

参数
vPositionXVECTOR3
vForwardDirXVECTOR3
vUpXVECTOR3
返回
void

◆ SetPrefabInstance()

function XEActor SetPrefabInstance ( pPrefabIns  )

将当前组件的Prefab实例指向pPrefabIns

参数
pPrefabInsXEPrefabInstance
返回
void

◆ SetRenderGroup()

function XEActor SetRenderGroup ( eARG  )

设置Actor的渲染分组

参数
eARGnumber
返回
void

◆ SetRootComponent()

function XEActor SetRootComponent ( pRootComponent  )

设置当前XEActor的根组件。 如果当前 XEActor 的根组件为空，则直接将pRootComponent赋值给根组件； 如果当前根组件不为空并且不是pRootComponent，则把当前XEActor的根组件修改为pRootComponent。

参数
pRootComponentXEActorComponent
返回
boolean 表示给当前XEActor根组件赋值成功或失败

◆ SetTransformMergeMode()

function XEActor SetTransformMergeMode ( bMerge  ,
bRecursion   
)

【适用于人脸追踪的3D头饰】 设置变换是否是合并模式

参数
bMergeboolean 是否合并，为xtrue时，将会被标记为变换合并模式，该模式会影响该Actor的变换行为，例如将会将自身坐标系变换到外部传递的坐标系内。
bRecursionboolean 是否递归影响其子节点
返回
void

◆ SetUpdateTranfromFromUserNode()

function XEActor SetUpdateTranfromFromUserNode ( bIsUpdate  )

设置是否根据挂载节点更新当前Actor的Transform

参数
bIsUpdateboolean
返回
void

◆ SpawnCloneActor()

function XEActor SpawnCloneActor ( bSpawnChildren  )

完整克隆并在Level中产出新的拷贝Actor对象，自动分配唯一名称，克隆的Actor对象将会储存在所属Level中

参数
bSpawnChildrenboolean 是否自动克隆子Actor实例
返回
XEActor XEActor克隆的Actor对象

◆ Tick()

function XEActor Tick ( fDelMs  ,
bForceTick   
)

更新当前XEActor帧

参数
fDelMsnumber 表示当前XEActor每帧更新的时间间隔(ms)
bForceTickboolean 是否强制Tick.如果为true，不管当前Actor是否隐藏，都会更新；如果为false，当前Actor如果隐藏时不更新。
返回
void

◆ TravelToGuestWorld()

function XEActor TravelToGuestWorld ( pGuestWorld  )

当前Actor离开自己的世界，到其他世界去

参数
pGuestWorldXEWorld 当前Actor去往的其他世界指针
返回
boolean 是否成功

◆ UpdateBindDataFromParentUserNode()

function XEActor UpdateBindDataFromParentUserNode ( bBindUserNodeData  )

更新父子嵌套的挂载节点信息

参数
bBindUserNodeDataXEBindUserNodeData
返回
void

◆ UpdateLocalTransformForChildComponent()

function XEActor UpdateLocalTransformForChildComponent ( )

更新当前Actor内记录的与其关联的子Actor组件的矩阵

返回
void

变量说明

◆ EDD_BOUNDINGBOX

XEActor EDD_BOUNDINGBOX = 0

◆ EDD_DRAW_AUXILIARY

XEActor EDD_DRAW_AUXILIARY = 0

◆ EDD_DRAW_NONE

XEActor EDD_DRAW_NONE = 0

◆ EDD_DUMMY_SHAPE

XEActor EDD_DUMMY_SHAPE = 0

◆ EDD_OUTLINE

XEActor EDD_OUTLINE = 0

◆ XEActor

XEActor = {}
制作者 doxygen 1.9.6