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

#include <XESubviewAgent.h>

XESubviewAgent 的协作图:
Collaboration graph

函数

function XESubviewAgent AcceptClient (pActorComponent) end
 
function XESubviewAgent GetClient () end
 
function XESubviewAgent GetActorComponentClient () end
 
function XESubviewAgent GetClientWorld () end
 
function XESubviewAgent SetSubviewAttrBits (pSubviewName, attrBits, bSyncToSubviewHolder) end
 
function XESubviewAgent GetSubviewAttrBits (pSubviewName) end
 
function XESubviewAgent Release () end
 
function XESubviewAgent GetSubviewPrimitive (pSubviewName, eRA) end
 
function XESubviewAgent GetSubviewPrimitive (nSubviewIndex, eRA) end
 
function XESubviewAgent AddToSubview (pWorld, pSubviewName, bRenderOnlyInSubview, bResetupSubview) end
 
function XESubviewAgent RemoveFromSubview (bResetupSubview, pSubviewName) end
 
function XESubviewAgent RemoveFromSubviewLater (pSubviewName) end
 
function XESubviewAgent IsInSubview (pSubviewName) end
 
function XESubviewAgent BindSubview (pWorld, pSubviewName, bCreatSubviewIfNotExist, bCreateCameraForSubview) end
 
function XESubviewAgent BindSubview (sp, bCreatSubviewIfNotExist) end
 
function XESubviewAgent UnBindSubview (bRemoveSubview, pSubviewName) end
 
function XESubviewAgent GetSubViewCamera (pSubviewName) end
 

变量

 XESubviewAgent = {}
 
XESubviewAgent AT_UNKNOWN = 0
 
XESubviewAgent AT_COMPONENT = 0
 

函数说明

◆ AcceptClient()

function XESubviewAgent AcceptClient ( pActorComponent  )

授受代理的客户，客户为Actor组件

参数
pActorComponentXEActorComponent
返回
void

◆ AddToSubview()

function XESubviewAgent AddToSubview ( pWorld  ,
pSubviewName  ,
bRenderOnlyInSubview  ,
bResetupSubview   
)

添加到子视图中,子视图在世界中

参数
pWorldXEWorld 所在世界
pSubviewNamestring 渲染的子视图名称
bRenderOnlyInSubviewboolean 是否只在子视图中渲染
bResetupSubviewboolean 是否立即重新安装子视图
返回
boolean 是否成功

◆ BindSubview() [1/2]

function XESubviewAgent BindSubview ( pWorld  ,
pSubviewName  ,
bCreatSubviewIfNotExist  ,
bCreateCameraForSubview   
)

作为持有体绑定到子视图(内部参数快速设置）

参数
pWorldXEWorld 子视图所在世界
pSubviewNamestring 渲染的子视图名称
bCreatSubviewIfNotExistboolean 如果子视图不存在,则指定是否自动创建一个
bCreateCameraForSubviewboolean 是否为subview创建一个内部相机对象,并使用该相机,以当前视口中相机参数进行创建，如果要修改相机参数，请获取该视口相机并进行修改
返回
SubviewPrimitive 创建的SubvewPrimitive

◆ BindSubview() [2/2]

function XESubviewAgent BindSubview ( sp  ,
bCreatSubviewIfNotExist   
)

作为持有体绑定到子视图(完全使用传入参数）

参数
spSubviewPrimitive 包含所有绑定参数
bCreatSubviewIfNotExistboolean 如果子视图不存在,则指定是否自动创建一个
返回
SubviewPrimitive 创建的SubvewPrimitive

◆ GetActorComponentClient()

function XESubviewAgent GetActorComponentClient ( )

获取Actor组件客户，返回为NULL时，客户不为Actor组件

返回
XEActorComponent

◆ GetClient()

function XESubviewAgent GetClient ( )

获取代理客户（未知类型）

返回
userdata

◆ GetClientWorld()

function XESubviewAgent GetClientWorld ( )

获取代理客户所在的世界

返回
XEWorld

◆ GetSubviewAttrBits()

function XESubviewAgent GetSubviewAttrBits ( pSubviewName  )

获取subview的属性字节

参数
pSubviewNamestring
返回
number

◆ GetSubViewCamera()

function XESubviewAgent GetSubViewCamera ( pSubviewName  )

获取Subview中相机

参数
pSubviewNamestring
返回
XBaseCamera

◆ GetSubviewPrimitive() [1/2]

function XESubviewAgent GetSubviewPrimitive ( nSubviewIndex  ,
eRA   
)

获取该图元可能关联的subview处理图元

参数
nSubviewIndexnumber 指明符合条件的subview序号
eRAnumber 指明要获取的Subviewprimitive的渲染属性，可为RA_AS_HOLDER，RA_AS_GUEST，RA_HOLDER_OR_GUEST_DONT_CARE其中之一
返回
SubviewPrimitive

◆ GetSubviewPrimitive() [2/2]

function XESubviewAgent GetSubviewPrimitive ( pSubviewName  ,
eRA   
)

获取该图元可能关联的subview处理图元

参数
pSubviewNamestring 指明subview的具体名称
eRAnumber 指明要获取的Subviewprimitive的渲染属性，可为RA_AS_HOLDER，RA_AS_GUEST，RA_HOLDER_OR_GUEST_DONT_CARE其中之一
返回
SubviewPrimitive

◆ IsInSubview()

function XESubviewAgent IsInSubview ( pSubviewName  )

是否已经存在于一个子视图中

参数
pSubviewNamestring 指定从子视图的名称，如果为空，则判定是否存在于任意一个关联的子视图中
返回
boolean 是否存在

◆ Release()

function XESubviewAgent Release ( )

释放所有资源

返回
void

◆ RemoveFromSubview()

function XESubviewAgent RemoveFromSubview ( bResetupSubview  ,
pSubviewName   
)

从指定子视图中删除

参数
bResetupSubviewboolean 是否立即重新安装子视图
pSubviewNamestring 指定从子视图中移除的名称，如果为空，则该渲染图元将会从所有关联子视图中移除。
返回
boolean 是否成功

◆ RemoveFromSubviewLater()

function XESubviewAgent RemoveFromSubviewLater ( pSubviewName  )

从指定子视图中延时删除，该函数将不会立即更新子视图中实际图元，但是会删除中间关联数据体。在子视图的下一帧将更新一次实际渲染的子视图

参数
pSubviewNamestring 指定从子视图中移除的名称，如果为空，则该渲染图元将会从所有关联子视图中移除。
返回
boolean 是否成功

◆ SetSubviewAttrBits()

function XESubviewAgent SetSubviewAttrBits ( pSubviewName  ,
attrBits  ,
bSyncToSubviewHolder   
)

设置subview的属性字节

参数
pSubviewNamestring
attrBitsnumber
bSyncToSubviewHolderboolean 是否同步到实际的SubviewHolder中（如果是持有体的话）
返回
boolean

◆ UnBindSubview()

function XESubviewAgent UnBindSubview ( bRemoveSubview  ,
pSubviewName   
)

从子视图中解除绑定

参数
bRemoveSubviewboolean 是否在解除绑定后删除子视图
pSubviewNamestring 指定子视图名称，如果为空，则解绑关联的所有子视图
返回
boolean 是否成功

变量说明

◆ AT_COMPONENT

XESubviewAgent AT_COMPONENT = 0

◆ AT_UNKNOWN

XESubviewAgent AT_UNKNOWN = 0

◆ XESubviewAgent

XESubviewAgent = {}
制作者 doxygen 1.9.6