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

Functions

function XESubview new () end
 
function XESubview__RenderTargetBuilder SetupSubview (subviewParamDesc) end
 
function XESubview__RenderTargetBuilder SetupSubview (strSubviewName) end
 
function XESubview__RenderTargetBuilder SetSubviewBackgroundFillParam (param) end
 
function XESubview__RenderTargetBuilder GetRenderTexture () end
 
function XESubview__RenderTargetBuilder ReleaseRenderTexture () end
 
function XESubview__RenderTargetBuilder GetRenderTextureName () end
 
function XESubview__RenderTargetBuilder ReleaseSubviewScene () end
 
function XESubview__RenderTargetBuilder HasSubView () end
 
function XESubview__RenderTargetBuilder GetSubViewParam () end
 
function XESubview__SubviewPrimitive IsValid () end
 
function XESubview__SubviewPrimitive IsHolder () end
 
function XESubview__SubviewPrimitive IsGuest () end
 
function XESubview__SubviewPrimitive IsHolderGuestDontCare () end
 
function XESubview__SubviewPrimitive IsRenderInViewport () end
 
function XESubview__SubviewPrimitive IsRenderInSubview () end
 
function XESubview__SubviewPrimitive IsRenderTextureInViewport () end
 
function XESubview__SubviewPrimitive IsOnlyRenderInSubview () end
 
function XESubview__SubviewPrimitive IsCameraBuildInner () end
 
function XESubview__SubviewPrimitive HasRenderAttribute (eRA) end
 
function XESubview__SubviewPrimitive SetAsHolder () end
 
function XESubview__SubviewPrimitive SetAsGuest () end
 
function XESubview__SubviewPrimitive SetHolderGuestDontCare () end
 
function XESubview__SubviewPrimitive SetRenderInViewport () end
 
function XESubview__SubviewPrimitive SetRenderInSubview () end
 
function XESubview__SubviewPrimitive SetOnlyRenderInSubview () end
 
function XESubview__SubviewPrimitive SetRenderTextureInViewport () end
 
function XESubview__SubviewPrimitive SetBuildCameraInner () end
 
function XESubview__SubviewPrimitive SetNotRenderInViewport () end
 
function XESubview__SubviewPrimitive SetNotRenderInSubview () end
 
function XESubview__SubviewPrimitive SetNotRenderTextureInViewport () end
 
function XESubview__SubviewPrimitive SetNotBuildCameraInner () end
 
function XESubview__SubviewPrimitive GetSubview () end
 
function XESubview__SubviewPrimitive GetRenderTargetBuilder () end
 
function XESubview BindHolder (sp) end
 @type IXPrimitiveBase More...
 
function XESubview UnbindHolder () end
 
function XESubview SetupMaterialInstance (pMaterialIns) end
 
function XESubview AddAffectTextureParamName (strTexParamName) end
 
function XESubview IsBindToHolder (sp) end
 
function XESubview GetSubviewPrimitiveHolder () end
 
function XESubview HasPrimitive (sp) end
 
function XESubview AddPrimitive (sp, bRestepSubview) end
 
function XESubview GetSubviewPrimitiveGuest (nIndex) end
 
function XESubview RemovePrimitive (sp, bRestepSubview) end
 
function XESubview RemovePrimitive (nIndex, bRestepSubview) end
 
function XESubview ResetupSubview () end
 
function XESubview ResetupSubviewBgTexture () end
 
function XESubview UpdateFromViewport () end
 
function XESubview Release () end
 
function XESubview BuildInnerCamera (pCameraSource) end
 
function XESubview ReleaseInnerCamera () end
 
function XESubview GetCamera () end
 
function XESubview GetInnerCamera () end
 
function XESubview IsSubviewCameraTheInnerOne () end
 
function XESubview SetSubviewCamera (pCamera) end
 
function XESubview AddSubviewLight (pLight, bResetupSubview) end
 
function XESubview GetSubviewAgentForEnginePrimitive (pEnginePri) end
 
function XESubview GetSubviewParamDesc () end
 
function XESubview GetSubviewPrimitiveGuests () end
 
function XESubviewAgent AcceptClient (pActorComponent) end
 
function XESubviewAgent GetClient () end
 
function XESubviewAgent GetActorComponentClient () end
 
function XESubviewAgent GetClientWorld () end
 
function XESubviewAgent GetRenderPrimitive () end
 
function XESubviewAgent SetSubviewAttrBits (pSubviewName, attrBits, bSyncToSubviewHolder) end
 
function XESubviewAgent GetSubviewAttrBits (pSubviewName) 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
 
function XESubviewPrimitiveAgent Empty () end
 
function XESubviewPrimitiveAgent GetAllRenderPrimitives () end
 
function XESubviewPrimitiveAgent RegisterRenderPrimitive (pScene) end
 

Variables

 XESubview = {}
 

Function Documentation

◆ AcceptClient()

function XESubviewAgent AcceptClient ( pActorComponent  )

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

Parameters
pActorComponentXEActorComponent
Returns
void

◆ AddAffectTextureParamName()

function XESubview AddAffectTextureParamName ( strTexParamName  )

设置子视图绑定体的材质实例受影响的纹理参数名称

Parameters
strTexParamNamestring
Returns
void

◆ AddPrimitive()

function XESubview AddPrimitive ( sp  ,
bRestepSubview   
)

添加新的图元，当子视图中图元发生变化时，指明是否应重新安装

Parameters
spXESubview::SubviewPrimitive
bRestepSubviewboolean
Returns
void

◆ AddSubviewLight()

function XESubview AddSubviewLight ( pLight  ,
bResetupSubview   
)

添加子视图引用的外部灯光（重复不添加，由于是外部引用，请保证灯光对象的有效性）

Parameters
pLightIXLightBase
bResetupSubviewboolean
Returns
void

◆ AddToSubview()

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

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

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

◆ BindHolder()

function XESubview BindHolder ( sp  )

@type IXPrimitiveBase

@type XEActorComponent 如果primitive来源于actorcomponent,可以指明 @type XESubviewAgent subview 逻辑图元代理（用于反向关系查找 ） @type XEWorld 所在世界 @type XESubview::RenderTargetBuilder @type IXMaterialInstance 作为持有体时，指定该Subview中的渲染纹理所在的材质实例 @type string[] @type xbyte @type XSubviewParamDesc @type string 子视图别名 将子视图绑定到一个SubviewPrimitive上，并在此primitive上安装渲染子视图

Parameters
spXESubview::SubviewPrimitive
Returns
boolean

◆ BindSubview() [1/2]

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

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

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

◆ BindSubview() [2/2]

function XESubviewAgent BindSubview ( sp  ,
bCreatSubviewIfNotExist   
)

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

Parameters
spXESubview::SubviewPrimitive 包含所有绑定参数
bCreatSubviewIfNotExistboolean 如果子视图不存在,则指定是否自动创建一个
Returns
XESubview__SubviewPrimitive 创建的SubvewPrimitive

◆ BuildInnerCamera()

function XESubview BuildInnerCamera ( pCameraSource  )

构建一个子视图的相机对象，参数来源于输入相机对象pCameraSource

Parameters
pCameraSourceXBaseCamera
Returns
boolean

◆ Empty()

function XESubviewPrimitiveAgent Empty ( )

XESubviewPrimitiveAgent_Empty00

Returns
void

◆ GetActorComponentClient()

function XESubviewAgent GetActorComponentClient ( )

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

Returns
XEActorComponent

◆ GetAllRenderPrimitives()

function XESubviewPrimitiveAgent GetAllRenderPrimitives ( )

获取渲染图元，可能为多个

Returns
IXPrimitiveBase[]

◆ GetCamera()

function XESubview GetCamera ( )

获取子视图的绑定相机(不区分是否为内部)

Returns
XBaseCamera

◆ GetClient()

function XESubviewAgent GetClient ( )

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

Returns
userdata

◆ GetClientWorld()

function XESubviewAgent GetClientWorld ( )

获取代理客户所在的世界

Returns
XEWorld

◆ GetInnerCamera()

function XESubview GetInnerCamera ( )

获取子视图的内部相机对象

Returns
XBaseCamera

◆ GetRenderPrimitive()

function XESubviewAgent GetRenderPrimitive ( )

获取引擎渲染图元

Returns
IXPrimitiveBase

◆ GetRenderTargetBuilder()

function XESubview GetRenderTargetBuilder ( )

XESubview_SubviewPrimitive_GetRenderTargetBuilder00

Returns
XESubview__RenderTargetBuilder

XESubview_GetRenderTargetBuilder00

Returns
XESubview__RenderTargetBuilder

◆ GetRenderTexture()

function XESubview__RenderTargetBuilder GetRenderTexture ( )

获取子视图的渲染纹理，内部管理，无需在外部释放

Returns
IXTexture

◆ GetRenderTextureName()

function XESubview__RenderTargetBuilder GetRenderTextureName ( )

释放子视图名称

Returns
string

◆ GetSubview()

function XESubview__SubviewPrimitive GetSubview ( )

XESubview_SubviewPrimitive_GetSubview00

Returns
XESubview

◆ GetSubviewAgentForEnginePrimitive()

function XESubview GetSubviewAgentForEnginePrimitive ( pEnginePri  )

根据子视图中的引擎图元试图配置子视图图元代理

Parameters
pEnginePriIXPrimitiveBase
Returns
XESubviewAgent

◆ GetSubviewAttrBits()

function XESubviewAgent GetSubviewAttrBits ( pSubviewName  )

获取subview的属性字节

Parameters
pSubviewNamestring
Returns
xbyte

◆ GetSubViewCamera()

function XESubviewAgent GetSubViewCamera ( pSubviewName  )

XESubviewAgent_GetSubViewCamera00

Parameters
pSubviewNamestring
Returns
XBaseCamera

◆ GetSubViewParam()

function XESubview__RenderTargetBuilder GetSubViewParam ( )

获取subview param

Returns
XSubViewParam

◆ GetSubviewParamDesc()

function XESubview GetSubviewParamDesc ( )

获取子视图的引擎对象描述

Returns
XSubviewParamDesc

◆ GetSubviewPrimitive() [1/2]

function XESubviewAgent GetSubviewPrimitive ( pSubviewName  ,
eRA   
)

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

Parameters
pSubviewNamestring 指明subview的具体名称
eRAnumber 指明要获取的Subviewprimitive的渲染属性，可为RA_AS_HOLDER，RA_AS_GUEST，RA_HOLDER_OR_GUEST_DONT_CARE其中之一
Returns
XESubview__SubviewPrimitive

◆ GetSubviewPrimitive() [2/2]

function XESubviewAgent GetSubviewPrimitive ( nSubviewIndex  ,
eRA   
)

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

Parameters
nSubviewIndexnumber 指明符合条件的subview序号
eRAnumber 指明要获取的Subviewprimitive的渲染属性，可为RA_AS_HOLDER，RA_AS_GUEST，RA_HOLDER_OR_GUEST_DONT_CARE其中之一
Returns
XESubview__SubviewPrimitive

◆ GetSubviewPrimitiveGuest()

function XESubview GetSubviewPrimitiveGuest ( nIndex  )

获得一个子视图客体

Parameters
nIndexnumber
Returns
XESubview__SubviewPrimitive

◆ GetSubviewPrimitiveGuests()

function XESubview GetSubviewPrimitiveGuests ( )

获取当前子视图所有客体

Returns
SubviewPrimitive[]

◆ GetSubviewPrimitiveHolder()

function XESubview GetSubviewPrimitiveHolder ( )

获取持有体Primitive

Returns
XESubview__SubviewPrimitive

◆ HasPrimitive()

function XESubview HasPrimitive ( sp  )

是否存在subview结构图元

Parameters
spXESubview::SubviewPrimitive
Returns
boolean

◆ HasRenderAttribute()

function XESubview__SubviewPrimitive HasRenderAttribute ( eRA  )

XESubview_SubviewPrimitive_HasRenderAttribute00

Parameters
eRAnumber
Returns
boolean

◆ HasSubView()

function XESubview__RenderTargetBuilder HasSubView ( )

是否已经存在sub-view渲染对象

Returns
boolean

◆ IsBindToHolder()

function XESubview IsBindToHolder ( sp  )

是否绑定到一个持有体

Parameters
spXESubview::SubviewPrimitive
Returns
boolean

◆ IsCameraBuildInner()

function XESubview__SubviewPrimitive IsCameraBuildInner ( )

XESubview_SubviewPrimitive_IsCameraBuildInner00

Returns
boolean

◆ IsGuest()

function XESubview__SubviewPrimitive IsGuest ( )

XESubview_SubviewPrimitive_IsGuest00

Returns
boolean

◆ IsHolder()

function XESubview__SubviewPrimitive IsHolder ( )

XESubview_SubviewPrimitive_IsHolder00

Returns
boolean

◆ IsHolderGuestDontCare()

function XESubview__SubviewPrimitive IsHolderGuestDontCare ( )

XESubview_SubviewPrimitive_IsHolderGuestDontCare00

Returns
boolean

◆ IsInSubview()

function XESubviewAgent IsInSubview ( pSubviewName  )

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

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

◆ IsOnlyRenderInSubview()

function XESubview__SubviewPrimitive IsOnlyRenderInSubview ( )

XESubview_SubviewPrimitive_IsOnlyRenderInSubview00

Returns
boolean

◆ IsRenderInSubview()

function XESubview__SubviewPrimitive IsRenderInSubview ( )

XESubview_SubviewPrimitive_IsRenderInSubview00

Returns
boolean

◆ IsRenderInViewport()

function XESubview__SubviewPrimitive IsRenderInViewport ( )

XESubview_SubviewPrimitive_IsRenderInViewport00

Returns
boolean

◆ IsRenderTextureInViewport()

function XESubview__SubviewPrimitive IsRenderTextureInViewport ( )

XESubview_SubviewPrimitive_IsRenderTextureInViewport00

Returns
boolean

◆ IsSubviewCameraTheInnerOne()

function XESubview IsSubviewCameraTheInnerOne ( )

获取子视图的相机是否为内部相机

Returns
boolean

◆ IsValid()

function XEMagicCore__XEBodyEntity IsValid ( )

子视图对象是否有效

Returns
boolean

XEMagicCore_XEObjectEntity_IsValid00

Returns
boolean

XEMagicCore_XEBodyEntity_IsValid00

Returns
boolean

◆ new()

function XESubview new ( )

XESubview_new00

Returns
XESubview

XESubview_SubviewPrimitive_new00

Returns
XESubview__SubviewPrimitive

◆ RegisterRenderPrimitive()

function XESubviewPrimitiveAgent RegisterRenderPrimitive ( pScene  )

注册被代理图元

Parameters
pSceneIXRenderSet
Returns
void

◆ Release()

function XESubview Release ( )

释放资源

Returns
void

◆ ReleaseInnerCamera()

function XESubview ReleaseInnerCamera ( )

释放内部相机对象，并更新子视图

Returns
void

◆ ReleaseRenderTexture()

function XESubview__RenderTargetBuilder ReleaseRenderTexture ( )

释放子视图的渲染纹理

Returns
void

◆ ReleaseSubviewScene()

function XESubview__RenderTargetBuilder ReleaseSubviewScene ( )

释放subview场景资源

Returns
void

◆ RemoveFromSubview()

function XESubviewAgent RemoveFromSubview ( bResetupSubview  ,
pSubviewName   
)

从指定子视图中删除

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

◆ RemoveFromSubviewLater()

function XESubviewAgent RemoveFromSubviewLater ( pSubviewName  )

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

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

◆ RemovePrimitive() [1/2]

function XESubview RemovePrimitive ( sp  ,
bRestepSubview   
)

删除图元，当子视图中图元发生变化时，应指是否重新安装

Parameters
spXESubview::SubviewPrimitive
bRestepSubviewboolean
Returns
boolean

◆ RemovePrimitive() [2/2]

function XESubview RemovePrimitive ( nIndex  ,
bRestepSubview   
)

按索引删除图元，当子视图中图元发生变化时，应指是否重新安装

Parameters
nIndexnumber
bRestepSubviewboolean
Returns
boolean

◆ ResetupSubview()

function XESubview ResetupSubview ( )

重新安装图元，当子视图中图元发生变化时，应重新安装

Returns
boolean

◆ ResetupSubviewBgTexture()

function XESubview ResetupSubviewBgTexture ( )

重新子视图中的背景纹理

Returns
boolean

◆ SetAsGuest()

function XESubview__SubviewPrimitive SetAsGuest ( )

XESubview_SubviewPrimitive_SetAsGuest00

Returns
void

◆ SetAsHolder()

function XESubview__SubviewPrimitive SetAsHolder ( )

XESubview_SubviewPrimitive_SetAsHolder00

Returns
void

◆ SetBuildCameraInner()

function XESubview__SubviewPrimitive SetBuildCameraInner ( )

XESubview_SubviewPrimitive_SetBuildCameraInner00

Returns
void

◆ SetHolderGuestDontCare()

function XESubview__SubviewPrimitive SetHolderGuestDontCare ( )

XESubview_SubviewPrimitive_SetHolderGuestDontCare00

Returns
void

◆ SetNotBuildCameraInner()

function XESubview__SubviewPrimitive SetNotBuildCameraInner ( )

XESubview_SubviewPrimitive_SetNotBuildCameraInner00

Returns
void

◆ SetNotRenderInSubview()

function XESubview__SubviewPrimitive SetNotRenderInSubview ( )

XESubview_SubviewPrimitive_SetNotRenderInSubview00

Returns
void

◆ SetNotRenderInViewport()

function XESubview__SubviewPrimitive SetNotRenderInViewport ( )

XESubview_SubviewPrimitive_SetNotRenderInViewport00

Returns
void

◆ SetNotRenderTextureInViewport()

function XESubview__SubviewPrimitive SetNotRenderTextureInViewport ( )

XESubview_SubviewPrimitive_SetNotRenderTextureInViewport00

Returns
void

◆ SetOnlyRenderInSubview()

function XESubview__SubviewPrimitive SetOnlyRenderInSubview ( )

XESubview_SubviewPrimitive_SetOnlyRenderInSubview00

Returns
void

◆ SetRenderInSubview()

function XESubview__SubviewPrimitive SetRenderInSubview ( )

XESubview_SubviewPrimitive_SetRenderInSubview00

Returns
void

◆ SetRenderInViewport()

function XESubview__SubviewPrimitive SetRenderInViewport ( )

XESubview_SubviewPrimitive_SetRenderInViewport00

Returns
void

◆ SetRenderTextureInViewport()

function XESubview__SubviewPrimitive SetRenderTextureInViewport ( )

XESubview_SubviewPrimitive_SetRenderTextureInViewport00

Returns
void

◆ SetSubviewAttrBits()

function XESubviewAgent SetSubviewAttrBits ( pSubviewName  ,
attrBits  ,
bSyncToSubviewHolder   
)

设置subview的属性字节

Parameters
pSubviewNamestring
attrBitsxbyte
bSyncToSubviewHolderboolean 是否同步到实际的SubviewHolder中（如果是持有体的话）
Returns
boolean

◆ SetSubviewBackgroundFillParam()

function XESubview__RenderTargetBuilder SetSubviewBackgroundFillParam ( param  )

为子视图的图元持有体安装子视图的填充背景纹理参数

Parameters
paramXSubviewBackgroundFillParam
Returns
boolean

◆ SetSubviewCamera()

function XESubview SetSubviewCamera ( pCamera  )

设置子视图引用的外部相机（由于是外部引用，请保证灯光对象的有效性）,并进行子视图重绘

Parameters
pCameraXBaseCamera
Returns
boolean

◆ SetupMaterialInstance()

function XESubview SetupMaterialInstance ( pMaterialIns  )

设置子视图绑定体的材质实例

Parameters
pMaterialInsIXMaterialInstance
Returns
void

◆ SetupSubview() [1/2]

function XESubview__RenderTargetBuilder SetupSubview ( subviewParamDesc  )

为子视图的图元持有体安装子视图场景构建器

Parameters
subviewParamDescXSubviewParamDesc
Returns
boolean

◆ SetupSubview() [2/2]

function XESubview__RenderTargetBuilder SetupSubview ( strSubviewName  )

接受引擎图元在内部创建的子视图场景参数, 调用此函数时，该构建器所建子视图场景将被释放

Parameters
strSubviewNamestring
Returns
void

◆ UnbindHolder()

function XESubview UnbindHolder ( )

取消绑定

Returns
boolean

◆ UnBindSubview()

function XESubviewAgent UnBindSubview ( bRemoveSubview  ,
pSubviewName   
)

从子视图中解除绑定

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

◆ UpdateFromViewport()

function XESubview UpdateFromViewport ( )

从当前绑定视口中更新设备参数,如宽高,相机,灯光

Returns
boolean

Variable Documentation

◆ XESubview

XESubview = {}
Generated by   doxygen 1.8.15