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

#include <XEWorld.h>

类 XEWorld 继承关系图:
Inheritance graph

#include <XEWorld.h>

XEWorld::RenderObjectsExclusiver 的协作图:
Collaboration graph

函数

function XEWorld Tick (fDelSecond) end
 
function XEWorld ReleaseActor (pActor) end
 
function XEWorld LoadScene (pRelativePath, bUseRelPathAsHome) end
 
function XEWorld CreateActor (strActorType) end
 
function XEWorld CreateActor (strActorType, strActorName) end
 
function XEWorld DeleteActor (pActor) end
 
function XEWorld UpdateNameOfActor (strActorOldName, strActorNewName) end
 
function XEWorld MergeActorHiddenStatus (pCurSelectActor) end
 
function XEWorld CreateLevel (strLevelName) end
 
function XEWorld DeleteLevel (pLevel) end
 
function XEWorld ClearLevels () end
 
function XEWorld AssignDefaultLevel () end
 
function XEWorld FindLevel (strLevelName) end
 
function XEWorld FindLevel (nLevelIndex) end
 
function XEWorld HasLevel (pLevel) end
 
function XEWorld GetLevelForActor (pActor) end
 
function XEWorld GetLevelCount () end
 
function XEWorld IsTickable () end
 
function XEWorld SetTickable (bEnable) end
 
function XEWorld IsTickPhysics () end
 
function XEWorld SetTickPhysicsable (bEnable) end
 
function XEWorld IsRenderPhysics () end
 
function XEWorld SetRenderPhysicsable (bEnable) end
 
function XEWorld ClearTickState () end
 
function XEWorld SetWorldMode (mode) end
 
function XEWorld GetWorldMode () end
 
function XEWorld SetWorldName (szName) end
 
function XEWorld GetWorldName () end
 
function XEWorld IsAssetRelativeToPackage () end
 
function XEWorld SetPreviewRenderMode (bSet) end
 
function XEWorld IsInPreviewRenderMode () end
 
function XEWorld IsLevelNeedRenderImmediately () end
 
function XEWorld GetSceneAssetPath () end
 
function XEWorld SetSceneAssetPath (pAssetPath) end
 
function XEWorld GetAssetPackage () end
 
function XEWorld SetAssetPackage (pPackagePath) end
 
function XEWorld FindActor (strActorName) end
 
function XEWorld FindActorByIdString (strActorIdString) end
 
function XEWorld FindActorByOriginalIdString (strActorIdString) end
 
function XEWorld HasActor (pActor, bIgnoreDeleted) end
 
function XEWorld GetActorCount (strActorType) end
 
function XEWorld GetActorsOfType (strActorType) end
 
function XEWorld GetActorValidName (strActorType) end
 
function XEWorld GetActorValidOrder () end
 
function XEWorld GetAllActors () end
 
function XEWorld GetActorFastMap () end
 
function XEWorld GetLevelValidName () end
 
function XEWorld VerifyAndReleaseTemporalObject (handle) end
 
function XEWorld RestoreActiveCamera (pViewport) end
 
function XEWorld GetOneActiveCamera () end
 
function XEWorld GetPhysicsSceneName () end
 
function XEWorld CreatePhysicsScene (szSceneName) end
 
function XEWorld GetPhysicsScene () end
 
function XEWorld GetOrCreatePhysicsScene () end
 
function XEWorld ReleasePhysicsScene () end
 
function XEWorld SetSceneType (eSceneType) end
 
function XEWorld GetSceneType () end
 
function XEWorld GetSceneVersionValue () end
 
function XEWorld GetSceneVersion () end
 
function XEWorld SetSceneVersion (strVersion) end
 
function XEWorld RayPick (vScreenPosition, HitResult, pHitResultList, pRayCollisionChannel, pActorsExclude) end
 
function XEWorld RayPick (HitResult, pHitResultList, pRayCollisionChannel, pActorsExclude) end
 
function XEWorld CopySelectedActors (aActors, bIsChangeCopyName, bIsResetActorProperty) end
 
function XEWorld PasteSelectedActors () end
 
function XEWorld ReAttachToActor (pSourceActor, pParentActor, pBindUesrNode) end
 
function XEWorld GetAttachedViewport () end
 
function XEWorld CreateSubview (szSubViewName) end
 
function XEWorld GetSubview (szSubViewName) end
 
function XEWorld GetSubviewByAlias (szSubviewAlias) end
 
function XEWorld ApplySubviewParam (pSubview) end
 
function XEWorld SetSubviewBgTexture (pSubview, pTex, fLeftTexcoord, fTopTexcoord, fWidthTexcoord, fHeightTexcoord) end
 
function XEWorld RemoveSubview (pSubview) end
 
function XEWorld ReleaseSubview (pSubview) end
 
function XEWorld GetAllSubviews () end
 
function XEWorld GetAllSubviewsFromAllWorld () end
 
function XEWorld ComponentSweepMulti (vOutHits, pShapeComp, vStart, vEnd, qRot) end
 
function XEWorld GetWorldParam () end
 

变量

 WM_EDITTING = 0
 
 WM_RUNTIME = 0
 
 XEWorld = {}
 

函数说明

◆ ApplySubviewParam()

function XEWorld ApplySubviewParam ( pSubview  )

将当前世界中视口的灯光、相机(如果子视图指定了内部相机，则使用内部相机)设置到指定子视图

参数
pSubviewXESubview 子视图对象
返回
boolean

◆ AssignDefaultLevel()

function XEWorld AssignDefaultLevel ( )

为世界分配默认关卡(关卡索引值为0),如果关卡不存在,则创建

返回
XELevel 关卡对象

◆ ClearLevels()

function XEWorld ClearLevels ( )

清空关卡

返回
void

◆ ClearTickState()

function XEWorld ClearTickState ( )

清除Tick状态（表示是否已经Tick）

返回
void

◆ ComponentSweepMulti()

function XEWorld ComponentSweepMulti ( vOutHits  ,
pShapeComp  ,
vStart  ,
vEnd  ,
qRot   
)

XEWorld_ComponentSweepMulti00

参数
vOutHitsXEHitResult[]
pShapeCompXEShapeComponent
vStartXVECTOR3
vEndXVECTOR3
qRotXQUATERNION
返回
boolean

◆ CopySelectedActors()

function XEWorld CopySelectedActors ( aActors  ,
bIsChangeCopyName  ,
bIsResetActorProperty   
)

当前所有关卡中, 拷贝选中的Actor

参数
aActorsXEActor[] 要拷贝的Actor列表
bIsChangeCopyNameboolean 是否改变Actor名称，默认为true
bIsResetActorPropertyboolean 是否重置Actor属性，默认为true
返回
void

◆ CreateActor() [1/2]

function XEWorld CreateActor ( strActorType  )

创建指定类型的XEActor,并添加进当前默认关卡中

参数
strActorTypestring Actor类型名称
返回
XEActor

◆ CreateActor() [2/2]

function XEWorld CreateActor ( strActorType  ,
strActorName   
)

创建指定类型和指定名称的XEActor,并添加进当前默认关卡中

参数
strActorTypestring Actor类型名称
strActorNamestring Actor名称
返回
XEActor

◆ CreateLevel()

function XEWorld CreateLevel ( strLevelName  )

创建一个关卡(世界中关卡>1将会有额外的序列化操作)

参数
strLevelNamestring 关卡名称
返回
XELevel 关卡对象

◆ CreatePhysicsScene()

function XEWorld CreatePhysicsScene ( szSceneName  )

根据给定的物理场景名称创建物理场景

参数
szSceneNamestring
返回
void

◆ CreateSubview()

function XEWorld CreateSubview ( szSubViewName  )

创建一个subview, 如果不指定subviewname, 则自动创建一个，前缀为SubView_[$snowid]

参数
szSubViewNamestring
返回
XESubview

◆ DeleteActor()

function XEWorld DeleteActor ( pActor  )

功能同ReleaseActor

参数
pActorXEActor
返回
void

◆ DeleteLevel()

function XEWorld DeleteLevel ( pLevel  )

从关卡队列中删除一个关卡

参数
pLevelXELevel 关卡对象
返回
boolean 是否成功

◆ FindActor()

function XEWorld FindActor ( strActorName  )

从当前所有关卡中,查找指定名称的XEActor

参数
strActorNamestring
返回
XEActor

◆ FindActorByIdString()

function XEWorld FindActorByIdString ( strActorIdString  )

从当前所有关卡中,查找指定IdString的XEActor

参数
strActorIdStringstring
返回
XEActor

◆ FindActorByOriginalIdString()

function XEWorld FindActorByOriginalIdString ( strActorIdString  )

从当前所有关卡中,查找指定IdString的来源Actor

参数
strActorIdStringstring
返回
XEActor

◆ FindLevel() [1/2]

function XEWorld FindLevel ( nLevelIndex  )

获取一个关卡

参数
nLevelIndexnumber 关卡索引
返回
XELevel 关卡对象

◆ FindLevel() [2/2]

function XEWorld FindLevel ( strLevelName  )

获取一个关卡

参数
strLevelNamestring 关卡名称
返回
XELevel 关卡对象

◆ GetActorCount()

function XEWorld GetActorCount ( strActorType  )

返回当前所有关卡中Actor的个数

参数
strActorTypestring
返回
number

◆ GetActorFastMap()

function XEWorld GetActorFastMap ( )

获取默认关卡中的Actor map,保存了Actor的名称和指针

返回
xhashtable_XString_and_XEActor_p_

◆ GetActorsOfType()

function XEWorld GetActorsOfType ( strActorType  )

查找当前所有关卡中某种类型的Actor

参数
strActorTypestring 要查找的Actor类型
返回
XEActor[]
void

◆ GetActorValidName()

function XEWorld GetActorValidName ( strActorType  )

获取当前所有关卡一个有效的Actor名称

参数
strActorTypestring
返回
string

◆ GetActorValidOrder()

function XEWorld GetActorValidOrder ( )

获取当前所有关卡一个有效的Actor排序索引

返回
number

◆ GetAllActors()

function XEWorld GetAllActors ( )

获取默认关卡中的全部Actor,注:该函数为版本兼容函数! 请在其关卡中获取

返回
XEActor[]

◆ GetAllSubviews()

function XEWorld GetAllSubviews ( )

获取所有子视图

返回
XESubview[]

◆ GetAllSubviewsFromAllWorld()

function XEWorld GetAllSubviewsFromAllWorld ( )

从所有世界中获取所有的subview

返回
XESubview[]

◆ GetAssetPackage()

function XEWorld GetAssetPackage ( )

获取Asset路径

返回
string

◆ GetAttachedViewport()

function XEWorld GetAttachedViewport ( )

获取当前所有关卡Attach的Viewport指针

返回
XEViewport

◆ GetLevelCount()

function XEWorld GetLevelCount ( )

获取该世界中的关卡数量

返回
number

◆ GetLevelForActor()

function XEWorld GetLevelForActor ( pActor  )

获取该世界中的Actor的所属关卡

参数
pActorXEActor 该世界中的Actor
返回
XELevel 关卡对象

◆ GetLevelValidName()

function XEWorld GetLevelValidName ( )

获取当前所有关卡一个有效的关卡名称

返回
string

◆ GetOneActiveCamera()

function XEWorld GetOneActiveCamera ( )

获取世界的一个激活相机

返回
XBaseCamera

◆ GetOrCreatePhysicsScene()

function XEWorld GetOrCreatePhysicsScene ( )

获取物理场景指针,如果为空,则创建一个空物理场景 新版本为效率考虑，不再默认创建物理场景

返回
IXPhysicsScene

◆ GetPhysicsScene()

function XEWorld GetPhysicsScene ( )

获取物理场景指针

返回
IXPhysicsScene

◆ GetPhysicsSceneName()

function XEWorld GetPhysicsSceneName ( )

获取物理场景名称

返回
string

◆ GetSceneAssetPath()

function XEWorld GetSceneAssetPath ( )

获取xscene文件路径

返回
string

◆ GetSceneType()

function XEWorld GetSceneType ( )

获取场景（或者说工程）类型（default/facetracker/mobile_ar）

返回
number

◆ GetSceneVersion()

function XEWorld GetSceneVersion ( )

获取工程版本号（XString）

返回
string

◆ GetSceneVersionValue()

function XEWorld GetSceneVersionValue ( )

获取工程版本号（xint32）

返回
number

◆ GetSubview()

function XEWorld GetSubview ( szSubViewName  )

根据名字找到subview

参数
szSubViewNamestring
返回
XESubview

◆ GetSubviewByAlias()

function XEWorld GetSubviewByAlias ( szSubviewAlias  )

根据subview的别名获取subview

参数
szSubviewAliasstring
返回
XESubview

◆ GetWorldMode()

function XEWorld GetWorldMode ( )

获取当前世界模式

返回
number

◆ GetWorldName()

function XEWorld GetWorldName ( )

获取当前世界名称

返回
string

◆ GetWorldParam()

function XEWorld GetWorldParam ( )

获取当前世界的世界属性结构体指针

返回
XEWorldParam

◆ HasActor()

function XEWorld HasActor ( pActor  ,
bIgnoreDeleted   
)

判断当前所有关卡中是否存在某个Actor 当为true时，表示查找时如果找到了该Actor，不论它是否被标记为删除，都返回true; 当为false时，表示即使查找到了该Actor，但是它被标记为删除，那么返回false。

参数
pActorXEActor 判断的Actor指针
bIgnoreDeletedboolean 是否忽略Actor被删除的标记，默认为true。
返回
boolean 是否找到

◆ HasLevel()

function XEWorld HasLevel ( pLevel  )

是否存在指定一个关卡

参数
pLevelXELevel
返回
boolean

◆ IsAssetRelativeToPackage()

function XEWorld IsAssetRelativeToPackage ( )

在world里加载的资源是否会自动拼接xscene文件所在路径为物理路径

返回
boolean

◆ IsInPreviewRenderMode()

function XEWorld IsInPreviewRenderMode ( )

判断是否是预览模式

返回
boolean

◆ IsLevelNeedRenderImmediately()

function XEWorld IsLevelNeedRenderImmediately ( )

判断是否在渲染时Level发生了立即渲染需求

返回
boolean

◆ IsRenderPhysics()

function XEWorld IsRenderPhysics ( )

判断物理是否渲染

返回
boolean

◆ IsTickable()

function XEWorld IsTickable ( )

判断是否可以Tick

返回
boolean

◆ IsTickPhysics()

function XEWorld IsTickPhysics ( )

判断物理是否Tick

返回
boolean

◆ LoadScene()

function XEWorld LoadScene ( pRelativePath  ,
bUseRelPathAsHome   
)

为默认关卡加载场景文件和创建物理场景对象。 XECoreSDK指定的场景文件是.xscene 格式的文件,其内部实现是执行反序列化函数Deserialize.

参数
pRelativePathstring 代表场景文件的相对路径，此处的相对路径是指xscene文件相对于工程文件夹的路径。
bUseRelPathAsHomeboolean 默认为false，如果为true，在world里加载的资源会自动拼接上这个xscene文件所在的路径，作为物理路径；否则不会拼接。
返回
boolean

◆ MergeActorHiddenStatus()

function XEWorld MergeActorHiddenStatus ( pCurSelectActor  )

从当前所有关卡中,合并显隐状态值

参数
pCurSelectActorXEActor 设置的Actor指针
返回
void

◆ PasteSelectedActors()

function XEWorld PasteSelectedActors ( )

当前所有关卡中, 黏贴选中的Actors

返回
XEActor[] 返回黏贴的Actors指针列表

◆ RayPick() [1/2]

function XEWorld RayPick ( HitResult  ,
pHitResultList  ,
pRayCollisionChannel  ,
pActorsExclude   
)

@manual 当前可表示关卡中,射线拾取 XEWorld_RayPick_manual

参数
HitResultXEHitResult
pHitResultListXEHitResult[] 拾取结果列表.
pRayCollisionChannelnumber[] 过滤的碰撞通道，表示这些通道不进行拾取测试.
pActorsExcludeXEActor[] 过滤的Actor数组.
返回
boolean 是否拾取成功

◆ RayPick() [2/2]

function XEWorld RayPick ( vScreenPosition  ,
HitResult  ,
pHitResultList  ,
pRayCollisionChannel  ,
pActorsExclude   
)

@manual 当前可表示关卡中,射线拾取 XEWorld_RayPick_manual

参数
vScreenPositionXVECTOR2
HitResultXEHitResult
pHitResultListXEHitResult[] 拾取结果列表.
pRayCollisionChannelnumber[] 过滤的碰撞通道，表示这些通道不进行拾取测试.
pActorsExcludeXEActor[] 过滤的Actor数组.
返回
boolean 是否拾取成功

◆ ReAttachToActor()

function XEWorld ReAttachToActor ( pSourceActor  ,
pParentActor  ,
pBindUesrNode   
)

当前所有关卡中, 重新绑定Actor到父节点Actor上

参数
pSourceActorXEActor 子Actor指针
pParentActorXEActor 父Actor指针
pBindUesrNodeuserdata 绑定的UserNode节点信息
返回
void

◆ ReleaseActor()

function XEWorld ReleaseActor ( pActor  )

从世界的Actor列表中移除pActor，并释放pActor

参数
pActorXEActor
返回
void

◆ ReleasePhysicsScene()

function XEWorld ReleasePhysicsScene ( )

释放物理场景

返回
void

◆ ReleaseSubview()

function XEWorld ReleaseSubview ( pSubview  )

释放subview, 如果不指定 pSubview，则重置所有

参数
pSubviewXESubview
返回
void

◆ RemoveSubview()

function XEWorld RemoveSubview ( pSubview  )

删除subview,如果不指定 pSubview，则删除所有

参数
pSubviewXESubview
返回
boolean

◆ RestoreActiveCamera()

function XEWorld RestoreActiveCamera ( pViewport  )

当前所有关卡中, 恢复指定Viewport对应的激活相机

参数
pViewportXEViewport 当前世界绑定的视口指针.
返回
boolean

◆ SetAssetPackage()

function XEWorld SetAssetPackage ( pPackagePath  )

设置Asset路径

参数
pPackagePathstring
返回
void

◆ SetPreviewRenderMode()

function XEWorld SetPreviewRenderMode ( bSet  )

设置是否是预览模式

参数
bSetboolean
返回
void

◆ SetRenderPhysicsable()

function XEWorld SetRenderPhysicsable ( bEnable  )

设置物理是否渲染

参数
bEnableboolean
返回
void

◆ SetSceneAssetPath()

function XEWorld SetSceneAssetPath ( pAssetPath  )

设置xscene文件路径

参数
pAssetPathstring
返回
void

◆ SetSceneType()

function XEWorld SetSceneType ( eSceneType  )

设置场景（工程）类型，（default/facetracker/mobile_ar）

参数
eSceneTypenumber
返回
void

◆ SetSceneVersion()

function XEWorld SetSceneVersion ( strVersion  )

设置工程版本号（XString）

参数
strVersionstring
返回
void

◆ SetSubviewBgTexture()

function XEWorld SetSubviewBgTexture ( pSubview  ,
pTex  ,
fLeftTexcoord  ,
fTopTexcoord  ,
fWidthTexcoord  ,
fHeightTexcoord   
)

设置子视图的渲染背景，开启自定义背景时，引擎默认背景将不再渲染到此子视图中

参数
pSubviewXESubview 子视图对象
pTexIXTexture2D
fLeftTexcoordnumber 纹理空间内左坐标[0,1]
fTopTexcoordnumber 纹理空间内顶坐标[0,1]
fWidthTexcoordnumber 纹理空间内宽[0,1]
fHeightTexcoordnumber 纹理空间内高[0,1]
返回
boolean

◆ SetTickable()

function XEWorld SetTickable ( bEnable  )

设置是否可以Tick

参数
bEnableboolean
返回
void

◆ SetTickPhysicsable()

function XEWorld SetTickPhysicsable ( bEnable  )

设置物理是否Tick

参数
bEnableboolean
返回
void

◆ SetWorldMode()

function XEWorld SetWorldMode ( mode  )

设置当前世界模式

参数
modenumber
返回
void

◆ SetWorldName()

function XEWorld SetWorldName ( szName  )

设置当前世界名称

参数
szNamestring
返回
void

◆ Tick()

function XEWorld Tick ( fDelSecond  )

更新世界可表示的关卡中的Actor列表中未被标记为delete的Actor，更新物理世界、执行事件回调以及执行绑定脚本编辑器中的Tick响应函数等。

参数
fDelSecondnumber
返回
void

◆ UpdateNameOfActor()

function XEWorld UpdateNameOfActor ( strActorOldName  ,
strActorNewName   
)

从当前所有关卡中,把名为strActorOldName的Actor改名为strActorNewName

参数
strActorOldNamestring
strActorNewNamestring
返回
XEActor

◆ VerifyAndReleaseTemporalObject()

function XEWorld VerifyAndReleaseTemporalObject ( handle  )

检查并决定是否需要释放XETemporalObject

参数
handleuserdata 分发的指针
返回
void

变量说明

◆ WM_EDITTING

WM_EDITTING = 0

◆ WM_RUNTIME

WM_RUNTIME = 0

◆ XEWorld

XEWorld = {}
制作者 doxygen 1.9.2