AR_Engine_SDK
|
Functions | |
function XELevel | AddIgnoreLoadingActor (pActorName) end |
function XELevel | Load (pRelativePath, bUseDefaultLevelPathAsHome) end |
function XELevel | Present () end |
function XELevel | UnPresent () end |
function XELevel | PresentThisOnly () end |
function XELevel | IsPresent () end |
function XELevel | PresentPhysicsForActors (fDelSecond) end |
function XELevel | Release () end |
function XELevel | ReleaseActor (pActor) end |
function XELevel | Tick (fDelSecond) end |
function XELevel | Render (pViewport) end |
function XELevel | SortActorInRenderOrder () end |
function XELevel | AddActorToRenderOrder (pActor) end |
function XELevel | RemoveActorFromRenderOrder (pActor) end |
function XELevel | MakeActorInRenderOrderSafe () end |
function XELevel | FindActor (strActorName) end |
function XELevel | CreateActor (strActorType) end |
function XELevel | CreateActor (strActorType, strActorName) end |
function XELevel | HasActor (pActor, bIgnoreDeleted) end |
function XELevel | GetActorCount (strActorType) end |
function XELevel | GetActorsOfType (strActorType, actorList) end |
function XELevel | GetActorsOfType (strActorType) end |
function XELevel | UpdateNameOfActor (strActorOldName, strActorNewName) end |
function XELevel | GetActorValidName (strActorType) end |
function XELevel | GetLevelName () end |
function XELevel | GetActorValidOrder () end |
function XELevel | GetAllActors () end |
function XELevel | GetActorFastMap () end |
function XELevel | IsDefaultLevel () end |
function XELevel | GetOwner () end |
function XELevel | RayPickOne (HitResult) end |
function XELevel | RayPickOne () end |
function XEWorld | Init () end |
function XEWorld | LoadScene (pRelativePath, bUseRelPathAsHome) end |
function XEWorld | DeleteActor (pActor) end |
function XEWorld | MergeActorHiddenStatus (pCurSelectActor) end |
function XEWorld | CreateLevel (strLevelName) end |
function XEWorld | AssignDefaultLevel () end |
function XEWorld | DeleteLevel (pLevel) end |
function XEWorld | ClearLevels () 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 | GetScriptContainerInstance () end |
function XEWorld | GetSceneAssetPath () end |
function XEWorld | SetSceneAssetPath (pAssetPath) end |
function XEWorld | GetAssetPackage () end |
function XEWorld | SetAssetPackage (pPackagePath) end |
function XEWorld | SetOnActorTickCallback (func) end |
function XEWorld | SetOnActorRenderCallback (func) end |
function XEWorld | GetLevelValidName () end |
function XEWorld | AddTemporalObject (pDestroyer) 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 | ReleasePhysicsScene () end |
function XEWorld | CreateWorldProperty (pWorld) end |
function XEWorld | ReleaseWorldProperty () end |
function XEWorld | GetWorldParam () end |
function XEWorld | SetWorldPropertyModified (bIsModified) end |
function XEWorld | IsWorldPropertyModified () 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 | AttachBindingScriptAsset (pAssetPath) end |
function XEWorld | DetachBindingScriptInstance () end |
function XEWorld | RayPick (vScreenPosition, HitResult, pHitResultList, pRayCollisionChannel, pActorsExclude) end |
function XEWorld | RayPick (HitResult, pHitResultList, pRayCollisionChannel, pActorsExclude) end |
function XEWorld | GetWorldExtendParamList () end |
function XEWorld | AddWorldExtendParam (pExtendParam) end |
function XEWorld | RemoveWorldExtendParam (pExtendParam, bDeleteMemory) end |
function XEWorld | GetWorldExtendParam (nIndex) end |
function XEWorld | GetWorldExtendParam (strExtendParamType) 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 |
Variables | |
WM_EDITTING = 0 | |
WM_RUNTIME = 0 | |
XELevel = {} | |
function XEWorld AddActorToRenderOrder | ( | pActor | ) |
function XELevel AddIgnoreLoadingActor | ( | pActorName | ) |
在为关卡加载场景之前,需要忽略序列化的某个Actor
pActorName | string |
function XEWorld AddTemporalObject | ( | pDestroyer | ) |
添加XETemporalObject,一般用于延迟销毁
pDestroyer | XEUtility::XETemporalObject XETemporalObject指针 |
function XEWorld AddWorldExtendParam | ( | pExtendParam | ) |
添加新的世界扩展参数
pExtendParam | IXEWorldExtendParam |
function XEWorld ApplySubviewParam | ( | pSubview | ) |
function XEWorld AttachBindingScriptAsset | ( | pAssetPath | ) |
根据给定路径创建一个绑定脚本实例
pAssetPath | string |
function XEWorld ClearLevels | ( | ) |
清空关卡
function XEWorld ClearTickState | ( | ) |
清除Tick状态(表示是否已经Tick)
function XEWorld CopySelectedActors | ( | aActors | , |
bIsChangeCopyName | , | ||
bIsResetActorProperty | |||
) |
当前所有关卡中, 拷贝选中的Actor
aActors | XEActor[] 要拷贝的Actor列表 |
bIsChangeCopyName | boolean 是否改变Actor名称,默认为true |
bIsResetActorProperty | boolean 是否重置Actor属性,默认为true |
function XEWorld CreateActor | ( | strActorType | ) |
function XEWorld CreateActor | ( | strActorType | , |
strActorName | |||
) |
创建指定类型和指定名称的XEActor,并添加进当前所有关卡中
strActorType | string Actor类型名称 |
strActorName | string Actor名称 |
function XEWorld CreateLevel | ( | strLevelName | ) |
function XEWorld CreatePhysicsScene | ( | szSceneName | ) |
根据给定的物理场景名称创建物理场景
szSceneName | string |
function XEWorld CreateSubview | ( | szSubViewName | ) |
创建一个subview, 如果不指定subviewname, 则自动创建一个,前缀为SubView_[$snowid]
szSubViewName | string |
function XEWorld CreateWorldProperty | ( | pWorld | ) |
给当前世界创建一个世界属性结构体指针,并初始化。对于世界属性结构体XEWorldParam,参见XEWorldParam.h中的介绍
pWorld | XEWorld |
function XEWorld DeleteLevel | ( | pLevel | ) |
function XEWorld DetachBindingScriptInstance | ( | ) |
移除绑定脚本实例
function XEWorld FindActor | ( | strActorName | ) |
function XEWorld FindLevel | ( | strLevelName | ) |
function XEWorld FindLevel | ( | nLevelIndex | ) |
function XEWorld GetActorCount | ( | strActorType | ) |
返回关卡中Actor的个数
strActorType | string |
function XEWorld GetActorFastMap | ( | ) |
获取关卡中的Actor map,保存了Actor的名称和指针
function XEWorld GetActorsOfType | ( | strActorType | , |
actorList | |||
) |
查找关卡中某种类型的Actor
strActorType | string 要查找的Actor类型 |
actorList | XEActor[] [out]找到的对应类型的Actor列表 |
function XEWorld GetActorsOfType | ( | strActorType | ) |
function XEWorld GetActorValidName | ( | strActorType | ) |
获取关卡一个有效的Actor名称
strActorType | string |
function XEWorld GetActorValidOrder | ( | ) |
获取关卡一个有效的Actor排序索引
function XEWorld GetAssetPackage | ( | ) |
获取Asset路径
function XEWorld GetAttachedViewport | ( | ) |
获取当前所有关卡Attach的Viewport指针
function XEWorld GetLevelCount | ( | ) |
获取该世界中的关卡数量
function XEWorld GetLevelForActor | ( | pActor | ) |
function XELevel GetLevelName | ( | ) |
获取关卡名称
function XEWorld GetLevelValidName | ( | ) |
获取当前所有关卡一个有效的关卡名称
function XEWorld GetOneActiveCamera | ( | ) |
获取世界的一个激活相机
function XEWorld GetPhysicsScene | ( | ) |
获取物理场景指针
function XEWorld GetPhysicsSceneName | ( | ) |
获取物理场景名称
function XEWorld GetSceneAssetPath | ( | ) |
获取xscene文件路径
function XEWorld GetSceneType | ( | ) |
获取场景(或者说工程)类型(default/facetracker/mobile_ar/arads)
function XEWorld GetSceneVersion | ( | ) |
获取工程版本号(XString)
function XEWorld GetSceneVersionValue | ( | ) |
获取工程版本号(xint32)
function XEWorld GetScriptContainerInstance | ( | ) |
获取绑定脚本实例指针
function XEWorld GetSubview | ( | szSubViewName | ) |
function XEWorld GetSubviewByAlias | ( | szSubviewAlias | ) |
function XEWorld GetWorldExtendParam | ( | nIndex | ) |
根据在扩展参数列表中的索引获取对应的扩展参数指针
nIndex | number |
function XEWorld GetWorldExtendParam | ( | strExtendParamType | ) |
根据扩展参数的类型获取对应的扩展参数指针
strExtendParamType | string |
function XEWorld GetWorldExtendParamList | ( | ) |
获取当前世界的扩展参数列表
function XEWorld GetWorldMode | ( | ) |
获取当前世界模式
function XEWorld GetWorldName | ( | ) |
获取当前世界名称
function XEWorld GetWorldParam | ( | ) |
获取当前世界的世界属性结构体指针
function XEWorld HasActor | ( | pActor | , |
bIgnoreDeleted | |||
) |
判断关卡中是否存在某个Actor 当为true时,表示查找时如果找到了该Actor,不论它是否被标记为删除,都返回true; 当为false时,表示即使查找到了该Actor,但是它被标记为删除,那么返回false。
pActor | XEActor 判断的Actor指针 |
bIgnoreDeleted | boolean 是否忽略Actor被删除的标记,默认为true。 |
function XEWorld Init | ( | ) |
函数用来初始化当前世界的世界属性
function XEWorld IsAssetRelativeToPackage | ( | ) |
在world里加载的资源是否会自动拼接xscene文件所在路径为物理路径
function XELevel IsDefaultLevel | ( | ) |
判定该关卡是否为世界的默认关卡
function XEWorld IsInPreviewRenderMode | ( | ) |
判断是否是预览模式
function XELevel IsPresent | ( | ) |
这个关卡为是否可在世界中表示的状态,
function XEWorld IsRenderPhysics | ( | ) |
判断物理是否渲染
function XEWorld IsTickable | ( | ) |
判断是否可以Tick
function XEWorld IsTickPhysics | ( | ) |
判断物理是否Tick
function XEWorld IsWorldPropertyModified | ( | ) |
判断世界属性是否有改变
function XELevel Load | ( | pRelativePath | , |
bUseDefaultLevelPathAsHome | |||
) |
为这个关卡加载场景内容, 关卡可用.xscene文件进行加载。如果在xscene文件中有同名的关卡,则加载这个关卡,否则将加载默认关卡 in the format of "xx.xscene", if you don't want to use the relative as home path, set it to xfalse.
pRelativePath | string 场景文件的相对路径,此处的相对路径是指xscene文件相对于工程文件夹的路径。 |
bUseDefaultLevelPathAsHome | boolean 是否使用默认关卡里的场景路径作为根路径 |
function XEWorld LoadScene | ( | pRelativePath | , |
bUseRelPathAsHome | |||
) |
为默认关卡加载场景文件和创建物理场景对象。 XECoreSDK指定的场景文件是.xscene 格式的文件,其内部实现是执行反序列化函数Deserialize.
pRelativePath | string 代表场景文件的相对路径,此处的相对路径是指xscene文件相对于工程文件夹的路径。 |
bUseRelPathAsHome | boolean 默认为true,如果为true,在world里加载的资源会自动拼接上这个xscene文件所在的路径,作为物理路径;否则不会拼接。 |
function XEWorld MakeActorInRenderOrderSafe | ( | ) |
当前所有关卡中, 确保渲染队列中的Actor都是有效的,把无效的都删除掉
function XEWorld MergeActorHiddenStatus | ( | pCurSelectActor | ) |
function XELevel Present | ( | ) |
设置这个关卡为可在世界中表示的状态,
function XELevel PresentPhysicsForActors | ( | fDelSecond | ) |
为这个关卡的非删除Actor表示物理世界
fDelSecond | number |
function XELevel PresentThisOnly | ( | ) |
只使该关卡在所属世界中生效
function XEWorld RayPick | ( | vScreenPosition | , |
HitResult | , | ||
pHitResultList | , | ||
pRayCollisionChannel | , | ||
pActorsExclude | |||
) |
@manual 当前可表示关卡中,射线拾取 XEWorld_RayPick_manual
vScreenPosition | XVECTOR2 |
HitResult | XEHitResult |
pHitResultList | XEHitResult[] 拾取结果列表. |
pRayCollisionChannel | number[] 过滤的碰撞通道,表示这些通道不进行拾取测试. |
pActorsExclude | XEActor[] 过滤的Actor数组. |
function XEWorld RayPick | ( | HitResult | , |
pHitResultList | , | ||
pRayCollisionChannel | , | ||
pActorsExclude | |||
) |
@manual 当前可表示关卡中,射线拾取 XEWorld_RayPick_manual
HitResult | XEHitResult |
pHitResultList | XEHitResult[] 拾取结果列表. |
pRayCollisionChannel | number[] 过滤的碰撞通道,表示这些通道不进行拾取测试. |
pActorsExclude | XEActor[] 过滤的Actor数组. |
function XELevel RayPickOne | ( | HitResult | ) |
当前可表示关卡中,射线拾取,返回一个排序后最优结果
HitResult | XEHitResult [in][out]拾取结果结构体,包含输入的射线起始位置和方向;输出的拾取到的XEActor、拾取到的3D场景的坐标点等,具体参考XEHitResult的介绍. |
function XELevel RayPickOne | ( | ) |
XELevel_RayPickOne01
function XEWorld ReAttachToActor | ( | pSourceActor | , |
pParentActor | , | ||
pBindUesrNode | |||
) |
function XELevel Release | ( | ) |
释放关卡
function XEWorld ReleasePhysicsScene | ( | ) |
释放物理场景
function XEWorld ReleaseSubview | ( | pSubview | ) |
function XEWorld ReleaseWorldProperty | ( | ) |
释放当前世界中的世界属性结构体指针
function XEWorld RemoveActorFromRenderOrder | ( | pActor | ) |
function XEWorld RemoveSubview | ( | pSubview | ) |
function XEWorld RemoveWorldExtendParam | ( | pExtendParam | , |
bDeleteMemory | |||
) |
移除世界扩展参数
pExtendParam | IXEWorldExtendParam |
bDeleteMemory | boolean |
function XELevel Render | ( | pViewport | ) |
渲染 1 渲染当前世界的Actor列表中未被标记为删除和隐藏状态的Actor; 2 如果当前世界的物理场景对象不为空,也会对物理场景执行渲染操作; 3 执行绑定脚本编辑器中Render响应函数。
pViewport | XEViewport |
function XEWorld RestoreActiveCamera | ( | pViewport | ) |
function XEWorld SetAssetPackage | ( | pPackagePath | ) |
设置Asset路径
pPackagePath | string |
function XEWorld SetOnActorRenderCallback | ( | func | ) |
设置Actor Render回调函数,如果设置了此回调函数,在Render中对每个未被标记为删除的Actor,执行此回调函数
func | std::function<void(XEActor*, XEViewport*)> |
function XEWorld SetOnActorTickCallback | ( | func | ) |
设置Actor Tick回调函数,如果设置了此回调函数,在Tick中对每个未被标记为删除的Actor,执行此回调函数
func | std::function<void(XEActor*, xfloat32)> |
function XEWorld SetPreviewRenderMode | ( | bSet | ) |
设置是否是预览模式
bSet | boolean |
function XEWorld SetRenderPhysicsable | ( | bEnable | ) |
设置物理是否渲染
bEnable | boolean |
function XEWorld SetSceneAssetPath | ( | pAssetPath | ) |
设置xscene文件路径
pAssetPath | string |
function XEWorld SetSceneType | ( | eSceneType | ) |
设置场景(工程)类型,(default/facetracker/mobile_ar/arads)
eSceneType | number |
function XEWorld SetSceneVersion | ( | strVersion | ) |
设置工程版本号(XString)
strVersion | string |
function XEWorld SetSubviewBgTexture | ( | pSubview | , |
pTex | , | ||
fLeftTexcoord | , | ||
fTopTexcoord | , | ||
fWidthTexcoord | , | ||
fHeightTexcoord | |||
) |
设置子视图的渲染背景,开启自定义背景时,引擎默认背景将不再渲染到此子视图中
pSubview | XESubview 子视图对象 |
pTex | IXTexture2D |
fLeftTexcoord | number 纹理空间内左坐标[0,1] |
fTopTexcoord | number 纹理空间内顶坐标[0,1] |
fWidthTexcoord | number 纹理空间内宽[0,1] |
fHeightTexcoord | number 纹理空间内高[0,1] |
function XEWorld SetTickable | ( | bEnable | ) |
设置是否可以Tick
bEnable | boolean |
function XEWorld SetTickPhysicsable | ( | bEnable | ) |
设置物理是否Tick
bEnable | boolean |
function XEWorld SetWorldMode | ( | mode | ) |
设置当前世界模式
mode | number |
function XEWorld SetWorldName | ( | szName | ) |
设置当前世界名称
szName | string |
function XEWorld SetWorldPropertyModified | ( | bIsModified | ) |
设置世界属性是否有改变
bIsModified | boolean |
function XELevel SortActorInRenderOrder | ( | ) |
XELevel_SortActorInRenderOrder00
function XEWorld Tick | ( | fDelSecond | ) |
更新关卡Actor列表中未被标记为delete的Actor,更新物理世界、执行事件回调以及执行绑定脚本编辑器中的Tick响应函数等。
fDelSecond | number |
function XELevel UnPresent | ( | ) |
设置这个关卡为可在世界中不可表示的状态,
function XEWorld UpdateNameOfActor | ( | strActorOldName | , |
strActorNewName | |||
) |
把名为strActorOldName的Actor改名为strActorNewName
strActorOldName | string |
strActorNewName | string |
WM_EDITTING = 0 |
WM_RUNTIME = 0 |
XELevel = {} |