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

Functions

function XUIScene Activate () end
 
function XUIScene DeActivate () end
 
function XUIScene GetLocalToParentTransform () end
 
function XUIScene Render (pWorld) end
 
function XUIScene GetScene () end
 
function XUIScene IsModal () end
 
function XUIScene Show (bModal) end
 
function XUIScene Hide () end
 
function XUIScene IsShow () end
 
function XUIScene SetDesignResolution (vDesignRes, rp) end
 
function XUIScene GetDesignResolution () end
 
function XUIScene GetResolutionPolicy () end
 
function XUIScene EnableCustomPolicy (bEnable) end
 
function XUIScene IsCustomPolicy () end
 
function XUIScene SetCustomAspect (fCustomAspect) end
 
function XUIScene GetCustomAspect () end
 
function XUIScene SetCustomUpperResolutionPolicy (rp) end
 
function XUIScene GetCustomUpperResolutionPolicy () end
 
function XUIScene SetCustomLowerResolutionPolicy (rp) end
 
function XUIScene GetCustomLowerResolutionPolicy () end
 
function XUIScene UpdateDesignResolutionSize () end
 
function XUIScene AdaptNotch (bSet) end
 
function XUIScene IsAdaptNotch () end
 
function XUIScene GetWorldToScreenMatrix () end
 
function XUIScene GetScaleMatrix () end
 
function XUIScene GetScale () end
 
function XUIScene AddToRenderer (pNode, global_z_order) end
 
function XUIScene GetVersion () end
 
function XUIScene GetTypeID () end
 
function XUIScene GetAllRttTextures () end
 

Variables

 XUIScene = {}
 

Function Documentation

◆ Activate()

function XUIScene Activate ( )

激活当前场景

Returns
void

◆ AdaptNotch()

function XUIScene AdaptNotch ( bSet  )

设置是否适应刘海屏。

Parameters
bSetboolean 是否适应刘海屏。
Returns
void

◆ AddToRenderer()

function XUIScene AddToRenderer ( pNode  ,
global_z_order   
)

添加一个节点到场景中渲染

Parameters
pNodeXUINode 添加的节点指针
global_z_ordernumber 全局排序索引
Returns
void

◆ DeActivate()

function XUIScene DeActivate ( )

设置当前场景为非激活态

Returns
void

◆ EnableCustomPolicy()

function XUIScene EnableCustomPolicy ( bEnable  )

设置是否启用自定义适配 自定义适配,指的是给定一个高宽比,大于该高宽比使用一个策略,小于该高宽比使用另一个策略

Parameters
bEnableboolean 是否启用自定义适配策略
Returns
void

◆ GetAllRttTextures()

function XUIScene GetAllRttTextures ( )

XUIScene_GetAllRttTextures00

Returns
XUITexture[]

◆ GetCustomAspect()

function XUIScene GetCustomAspect ( )

获取自定义适配的高宽比

Returns
number 自定义适配的高宽比

◆ GetCustomLowerResolutionPolicy()

function XUIScene GetCustomLowerResolutionPolicy ( )

获取小于给定高宽比时的适配策略

Returns
number 小于给定高宽比时的适配策略

◆ GetCustomUpperResolutionPolicy()

function XUIScene GetCustomUpperResolutionPolicy ( )

获取大于给定高宽比时的适配策略

Returns
number 大于给定高宽比时的适配策略

◆ GetDesignResolution()

function XUIScene GetDesignResolution ( )

获取场景的设计分辨率

Returns
XVECTOR2 返回场景的设计分辨率

◆ GetLocalToParentTransform()

function XUIScene GetLocalToParentTransform ( )

获取相对于父节点的局部坐标矩阵

Returns
XMATRIX4 获取到的矩阵

◆ GetResolutionPolicy()

function XUIScene GetResolutionPolicy ( )

设置场景的设计分辨率

Returns
number 场景的分辨率适应策略。

◆ GetScale()

function XUIScene GetScale ( )

获取缩放数据

Returns
XVECTOR2 x,y轴缩放数值

◆ GetScaleMatrix()

function XUIScene GetScaleMatrix ( )

获取缩放矩阵

Returns
XMATRIX4 缩放矩阵

◆ GetScene()

function XUIScene GetScene ( )

获取当前场景指针

Returns
XUIScene

◆ GetTypeID()

function XUIScene GetTypeID ( )

获取类型ID

Returns
number TypeID

◆ GetVersion()

function XUIScene GetVersion ( )

获取版本号

Returns
number 版本号

◆ GetWorldToScreenMatrix()

function XUIScene GetWorldToScreenMatrix ( )

把当前世界矩阵转成屏幕坐标系矩阵

Returns
XMATRIX4 屏幕坐标系矩阵

◆ Hide()

function XUIScene Hide ( )

隐藏当前场景

Returns
void

◆ IsAdaptNotch()

function XUIScene IsAdaptNotch ( )

获取是否适应刘海屏。

Returns
boolean 是否适应刘海屏。

◆ IsCustomPolicy()

function XUIScene IsCustomPolicy ( )

是否使用自定义适配

Returns
boolean 场景的分辨率适应策略。

◆ IsModal()

function XUIScene IsModal ( )

获取是否是模态场景。

Returns
boolean 返回是否是模态场景。

◆ IsShow()

function XUIScene IsShow ( )

判断当前场景是否显示

Returns
boolean

◆ Render()

function XUIScene Render ( pWorld  )

渲染场景

Parameters
pWorldIXRenderSet 指定的世界
Returns
void

◆ SetCustomAspect()

function XUIScene SetCustomAspect ( fCustomAspect  )

设定自定义适配的高宽比

Parameters
fCustomAspectnumber 自定义适配的高宽比
Returns
void

◆ SetCustomLowerResolutionPolicy()

function XUIScene SetCustomLowerResolutionPolicy ( rp  )

设定小于给定高宽比时的适配策略

Parameters
rpnumber 小于给定高宽比时的适配策略
Returns
void

◆ SetCustomUpperResolutionPolicy()

function XUIScene SetCustomUpperResolutionPolicy ( rp  )

设定大于给定高宽比时的适配策略

Parameters
rpnumber 大于给定高宽比时的适配策略
Returns
void

◆ SetDesignResolution()

function XUIScene SetDesignResolution ( vDesignRes  ,
rp   
)

设置场景的设计分辨率 XUI_EXACTFIT 非等比拉伸致宽度和高度与屏幕分辨率一致。 XUI_NOBORDER 等比拉伸到没有边框的程度,可能会导致横向或者纵向有UI显示不全。 XUI_SHOWALL 等比拉伸以能够显示全部内容,可能会导致横向或者纵向有黑边。 XUI_FIXEDHEIGHT 等比拉伸到高度正好和屏幕分辨率一致。 XUI_FIXEDWIDTH 等比拉伸到宽度正好和屏幕分辨率一致。

Parameters
vDesignResXVECTOR2 场景的设计分辨率。
rpnumber 依据场景的设计分辨率自适应屏幕分辨率的策略。
Returns
void

◆ Show()

function XUIScene Show ( bModal  )

显示当前场景,XUIScene需要手动调用Show函数来显示出来,即默认为隐藏状态。

Parameters
bModalboolean 是否是模态场景,true为当前场景会阻断触摸事件,其他场景无法响应。false触摸事件如果没被处理,则会往下传递。
Returns
void

◆ UpdateDesignResolutionSize()

function XUIScene UpdateDesignResolutionSize ( )

手动让分辨率重新自适应一次。

Returns
void

Variable Documentation

◆ XUIScene

XUIScene = {}