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

#include <XESubview.h>

SubviewPrimitive 的协作图:
Collaboration graph

函数

function SubviewPrimitive new () end
 
function SubviewPrimitive IsValid () end
 
function SubviewPrimitive IsHolder () end
 
function SubviewPrimitive IsGuest () end
 
function SubviewPrimitive IsHolderGuestDontCare () end
 
function SubviewPrimitive IsRenderInViewport () end
 
function SubviewPrimitive IsRenderInSubview () end
 
function SubviewPrimitive IsRenderTextureInViewport () end
 
function SubviewPrimitive IsOnlyRenderInSubview () end
 
function SubviewPrimitive IsCameraBuildInner () end
 
function SubviewPrimitive HasRenderAttribute (eRA) end
 
function SubviewPrimitive SetAsHolder () end
 
function SubviewPrimitive SetAsGuest () end
 
function SubviewPrimitive SetHolderGuestDontCare () end
 
function SubviewPrimitive SetRenderInViewport () end
 
function SubviewPrimitive SetRenderInSubview () end
 
function SubviewPrimitive SetOnlyRenderInSubview () end
 
function SubviewPrimitive SetRenderTextureInViewport () end
 
function SubviewPrimitive SetBuildCameraInner () end
 
function SubviewPrimitive SetNotRenderInViewport () end
 
function SubviewPrimitive SetNotRenderInSubview () end
 
function SubviewPrimitive SetNotRenderTextureInViewport () end
 
function SubviewPrimitive SetNotBuildCameraInner () end
 
function SubviewPrimitive GetSubview () end
 
function SubviewPrimitive GetRenderTargetBuilder () end
 
function SubviewRenderTargetBuilder SetupSubview (subviewParamDesc) end
 
function SubviewRenderTargetBuilder SetupSubview (strSubviewName) end
 
function SubviewRenderTargetBuilder SetSubviewBackgroundFillParam (param) end
 
function SubviewRenderTargetBuilder RegisterPrimitivesToScene (subviewParamDesc) end
 
function SubviewRenderTargetBuilder GetRenderTexture () end
 
function SubviewRenderTargetBuilder ReleaseRenderTexture () end
 
function SubviewRenderTargetBuilder GetRenderTextureName () end
 
function SubviewRenderTargetBuilder ReleaseSubviewScene () end
 
function SubviewRenderTargetBuilder HasSubView () end
 
function SubviewRenderTargetBuilder GetSubViewParam () end
 
function XESubview BindHolder (sp) end
 
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 ResetupRenderPrimitives () 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 XESubview GetName () end
 
function XESubview GetAliasName () end
 

变量

 SubviewPrimitive = {}
 

函数说明

◆ AddAffectTextureParamName()

function XESubview AddAffectTextureParamName ( strTexParamName  )

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

参数
strTexParamNamestring
返回
void

◆ AddPrimitive()

function XESubview AddPrimitive ( sp  ,
bRestepSubview   
)

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

参数
spSubviewPrimitive
bRestepSubviewboolean
返回
void

◆ AddSubviewLight()

function XESubview AddSubviewLight ( pLight  ,
bResetupSubview   
)

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

参数
pLightIXLightBase
bResetupSubviewboolean
返回
void

◆ BindHolder()

function XESubview BindHolder ( sp  )

将子视图绑定到一个SubviewPrimitive上，并在此primitive上安装渲染子视图

参数
spSubviewPrimitive
返回
boolean

◆ BuildInnerCamera()

function XESubview BuildInnerCamera ( pCameraSource  )

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

参数
pCameraSourceXBaseCamera
返回
boolean

◆ GetAliasName()

function XESubview GetAliasName ( )

获取subview的别名

返回
string

◆ GetCamera()

function XESubview GetCamera ( )

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

返回
XBaseCamera

◆ GetInnerCamera()

function XESubview GetInnerCamera ( )

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

返回
XBaseCamera

◆ GetName()

function XESubview GetName ( )

获取Subview的实际名称

返回
string

◆ GetRenderTargetBuilder()

function XESubview GetRenderTargetBuilder ( )

SubviewPrimitive_GetRenderTargetBuilder00

返回
SubviewRenderTargetBuilder

XESubview_GetRenderTargetBuilder00

返回
SubviewRenderTargetBuilder

◆ GetRenderTexture()

function SubviewRenderTargetBuilder GetRenderTexture ( )

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

返回
IXTexture

◆ GetRenderTextureName()

function SubviewRenderTargetBuilder GetRenderTextureName ( )

释放子视图名称

返回
string

◆ GetSubview()

function SubviewPrimitive GetSubview ( )

SubviewPrimitive_GetSubview00

返回
XESubview

◆ GetSubviewAgentForEnginePrimitive()

function XESubview GetSubviewAgentForEnginePrimitive ( pEnginePri  )

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

参数
pEnginePriIXPrimitiveBase
返回
XESubviewAgent

◆ GetSubViewParam()

function SubviewRenderTargetBuilder GetSubViewParam ( )

获取subview param, 在这里注册一次图元

返回
XSubViewParam

◆ GetSubviewParamDesc()

function XESubview GetSubviewParamDesc ( )

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

返回
XSubviewParamDesc

◆ GetSubviewPrimitiveGuest()

function XESubview GetSubviewPrimitiveGuest ( nIndex  )

获得一个子视图客体

参数
nIndexnumber
返回
SubviewPrimitive

◆ GetSubviewPrimitiveGuests()

function XESubview GetSubviewPrimitiveGuests ( )

获取当前子视图所有客体

返回
SubviewPrimitive[]

◆ GetSubviewPrimitiveHolder()

function XESubview GetSubviewPrimitiveHolder ( )

获取持有体Primitive

返回
SubviewPrimitive

◆ HasPrimitive()

function XESubview HasPrimitive ( sp  )

是否存在subview结构图元

参数
spSubviewPrimitive
返回
boolean

◆ HasRenderAttribute()

function SubviewPrimitive HasRenderAttribute ( eRA  )

SubviewPrimitive_HasRenderAttribute00

参数
eRAnumber
返回
boolean

◆ HasSubView()

function SubviewRenderTargetBuilder HasSubView ( )

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

返回
boolean

◆ IsBindToHolder()

function XESubview IsBindToHolder ( sp  )

是否绑定到一个持有体

参数
spSubviewPrimitive
返回
boolean

◆ IsCameraBuildInner()

function SubviewPrimitive IsCameraBuildInner ( )

SubviewPrimitive_IsCameraBuildInner00

返回
boolean

◆ IsGuest()

function SubviewPrimitive IsGuest ( )

SubviewPrimitive_IsGuest00

返回
boolean

◆ IsHolder()

function SubviewPrimitive IsHolder ( )

SubviewPrimitive_IsHolder00

返回
boolean

◆ IsHolderGuestDontCare()

function SubviewPrimitive IsHolderGuestDontCare ( )

SubviewPrimitive_IsHolderGuestDontCare00

返回
boolean

◆ IsOnlyRenderInSubview()

function SubviewPrimitive IsOnlyRenderInSubview ( )

SubviewPrimitive_IsOnlyRenderInSubview00

返回
boolean

◆ IsRenderInSubview()

function SubviewPrimitive IsRenderInSubview ( )

SubviewPrimitive_IsRenderInSubview00

返回
boolean

◆ IsRenderInViewport()

function SubviewPrimitive IsRenderInViewport ( )

SubviewPrimitive_IsRenderInViewport00

返回
boolean

◆ IsRenderTextureInViewport()

function SubviewPrimitive IsRenderTextureInViewport ( )

SubviewPrimitive_IsRenderTextureInViewport00

返回
boolean

◆ IsSubviewCameraTheInnerOne()

function XESubview IsSubviewCameraTheInnerOne ( )

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

返回
boolean

◆ IsValid()

function XEMagicCore__XEMNNResultEntity IsValid ( )

子视图对象是否有效

返回
boolean

XEFilterUtility_XEVaraintVertex_IsValid00

返回
boolean

XEMagicCore_XEObjectEntity_IsValid00

返回
boolean

XEMagicCore_XEBodyEntity_IsValid00

返回
boolean

XEMagicCore_XEHandGestureEntity_IsValid00

返回
boolean

XEMagicCore_XEFaceExpressionEntity_IsValid00

返回
boolean

XEMagicCore_XEImageSegmentEntity_IsValid00

返回
boolean

XEMagicCore_XEMNNResultEntity_IsValid00

返回
boolean

◆ new()

function SubviewPrimitive new ( )

SubviewPrimitive_new00

返回
SubviewPrimitive

XESubview_new00

返回
XESubview

◆ RegisterPrimitivesToScene()

function SubviewRenderTargetBuilder RegisterPrimitivesToScene ( subviewParamDesc  )

注册一次当前图元

参数
subviewParamDescXSubviewParamDesc
返回
void

◆ Release()

function XESubview Release ( )

释放资源

返回
void

◆ ReleaseInnerCamera()

function XESubview ReleaseInnerCamera ( )

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

返回
void

◆ ReleaseRenderTexture()

function SubviewRenderTargetBuilder ReleaseRenderTexture ( )

释放子视图的渲染纹理

返回
void

◆ ReleaseSubviewScene()

function SubviewRenderTargetBuilder ReleaseSubviewScene ( )

释放subview场景资源

返回
void

◆ RemovePrimitive() [1/2]

function XESubview RemovePrimitive ( nIndex  ,
bRestepSubview   
)

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

参数
nIndexnumber
bRestepSubviewboolean
返回
boolean

◆ RemovePrimitive() [2/2]

function XESubview RemovePrimitive ( sp  ,
bRestepSubview   
)

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

参数
spSubviewPrimitive
bRestepSubviewboolean
返回
boolean

◆ ResetupRenderPrimitives()

function XESubview ResetupRenderPrimitives ( )

更新一次渲染图元， 并更新入Subview渲染场景中

返回
void

◆ ResetupSubview()

function XESubview ResetupSubview ( )

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

返回
boolean

◆ ResetupSubviewBgTexture()

function XESubview ResetupSubviewBgTexture ( )

重新子视图中的背景纹理

返回
boolean

◆ SetAsGuest()

function SubviewPrimitive SetAsGuest ( )

SubviewPrimitive_SetAsGuest00

返回
void

◆ SetAsHolder()

function SubviewPrimitive SetAsHolder ( )

SubviewPrimitive_SetAsHolder00

返回
void

◆ SetBuildCameraInner()

function SubviewPrimitive SetBuildCameraInner ( )

SubviewPrimitive_SetBuildCameraInner00

返回
void

◆ SetHolderGuestDontCare()

function SubviewPrimitive SetHolderGuestDontCare ( )

SubviewPrimitive_SetHolderGuestDontCare00

返回
void

◆ SetNotBuildCameraInner()

function SubviewPrimitive SetNotBuildCameraInner ( )

SubviewPrimitive_SetNotBuildCameraInner00

返回
void

◆ SetNotRenderInSubview()

function SubviewPrimitive SetNotRenderInSubview ( )

SubviewPrimitive_SetNotRenderInSubview00

返回
void

◆ SetNotRenderInViewport()

function SubviewPrimitive SetNotRenderInViewport ( )

SubviewPrimitive_SetNotRenderInViewport00

返回
void

◆ SetNotRenderTextureInViewport()

function SubviewPrimitive SetNotRenderTextureInViewport ( )

SubviewPrimitive_SetNotRenderTextureInViewport00

返回
void

◆ SetOnlyRenderInSubview()

function SubviewPrimitive SetOnlyRenderInSubview ( )

SubviewPrimitive_SetOnlyRenderInSubview00

返回
void

◆ SetRenderInSubview()

function SubviewPrimitive SetRenderInSubview ( )

SubviewPrimitive_SetRenderInSubview00

返回
void

◆ SetRenderInViewport()

function SubviewPrimitive SetRenderInViewport ( )

SubviewPrimitive_SetRenderInViewport00

返回
void

◆ SetRenderTextureInViewport()

function SubviewPrimitive SetRenderTextureInViewport ( )

SubviewPrimitive_SetRenderTextureInViewport00

返回
void

◆ SetSubviewBackgroundFillParam()

function SubviewRenderTargetBuilder SetSubviewBackgroundFillParam ( param  )

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

参数
paramXSubviewBackgroundFillParam
返回
boolean

◆ SetSubviewCamera()

function XESubview SetSubviewCamera ( pCamera  )

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

参数
pCameraXBaseCamera
返回
boolean

◆ SetupMaterialInstance()

function XESubview SetupMaterialInstance ( pMaterialIns  )

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

参数
pMaterialInsIXMaterialInstance
返回
void

◆ SetupSubview() [1/2]

function SubviewRenderTargetBuilder SetupSubview ( strSubviewName  )

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

参数
strSubviewNamestring
返回
void

◆ SetupSubview() [2/2]

function SubviewRenderTargetBuilder SetupSubview ( subviewParamDesc  )

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

参数
subviewParamDescXSubviewParamDesc
返回
boolean

◆ UnbindHolder()

function XESubview UnbindHolder ( )

取消绑定

返回
boolean

◆ UpdateFromViewport()

function XESubview UpdateFromViewport ( )

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

返回
boolean

变量说明

◆ SubviewPrimitive

SubviewPrimitive = {}
制作者 doxygen 1.9.1