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

Functions

function XUIPageView Create () end
 
function XUIPageView new () end
 
function XUIPageView SetContentSize (vContentSize) end
 
function XUIPageView SetDirection (direction) end
 
function XUIPageView AddPage () end
 
function XUIPageView InsertPage (nIndex) end
 
function XUIPageView GetPageByIndex (nIndex) end
 
function XUIPageView MovePage (nOldIndex, nNewIndex) end
 
function XUIPageView GetPageNumber () end
 
function XUIPageView RemovePage (pPage) end
 
function XUIPageView RemovePageAtIndex (nIndex) end
 
function XUIPageView RemoveAllPages () end
 
function XUIPageView ScrollToPage (nIndex) end
 
function XUIPageView ScrollToPage (nIndex, fTime) end
 
function XUIPageView JumpToPage (nIndex) end
 
function XUIPageView GetCurrentPageIndex () end
 
function XUIPageView AddEventListener (callback) end
 
function XUIPageView SetIndicatorEnabled (bEnabled) end
 
function XUIPageView GetIndicatorEnabled () end
 
function XUIPageView SetIndicatorPositionAsAnchorPoint (vPositionAsAnchorPoint) end
 
function XUIPageView GetIndicatorPositionAsAnchorPoint () end
 
function XUIPageView SetIndicatorPosition (vPosition) end
 
function XUIPageView GetIndicatorPosition () end
 
function XUIPageView SetIndicatorSpaceBetweenIndexNodes (fSpaceBetweenIndexNodes) end
 
function XUIPageView GetIndicatorSpaceBetweenIndexNodes () end
 
function XUIPageView SetIndicatorSelectedIndexColor (color) end
 
function XUIPageView GetIndicatorSelectedIndexColor () end
 
function XUIPageView SetIndicatorIndexNodesColor (color) end
 
function XUIPageView GetIndicatorIndexNodesColor () end
 
function XUIPageView SetIndicatorIndexNodesScale (fIndexNodesScale) end
 
function XUIPageView GetIndicatorIndexNodesScale () end
 
function XUIPageView SetIndicatorIndexNodesTexture (strTexName, eTexType) end
 

Variables

 XUIPageView = {}
 
XUIPageView TURNING = 0
 
XUIPageView LEFT = 0
 
XUIPageView RIGHT = 0
 
XUIPageView UP = 0
 
XUIPageView DOWN = 0
 

Function Documentation

◆ AddEventListener()

function XUIPageView AddEventListener ( callback  )

@manual xelua_XEngine_XUIPageView_AddEventListener_manual XUIPageView_AddEventListener_manual

Parameters
callbackstd::function<void(XUINode*, EventType)>
Returns
void

◆ AddPage()

function XUIPageView AddPage ( )

往PageView的最后插入一页

Returns
XUIWidget

◆ Create()

function XUIPageView Create ( )

创建并返回一个空的控件实例的指针

Returns
XUIPageView 控件指针

◆ GetCurrentPageIndex()

function XUIPageView GetCurrentPageIndex ( )

获取当前页的索引,并返回

Returns
number

◆ GetIndicatorEnabled()

function XUIPageView GetIndicatorEnabled ( )

获取小圆点页指示器是否启用

Returns
boolean 是否启用那个小圆点页指示器

◆ GetIndicatorIndexNodesColor()

function XUIPageView GetIndicatorIndexNodesColor ( )

获取小圆点指示器的颜色

Returns
XCOLORBASE 返回小圆点颜色。

◆ GetIndicatorIndexNodesScale()

function XUIPageView GetIndicatorIndexNodesScale ( )

获取被选中的小圆点指示器的缩放

Returns
number 小圆点缩放值。

◆ GetIndicatorPosition()

function XUIPageView GetIndicatorPosition ( )

获取小圆点页指示器的位置

Returns
XVECTOR2 小圆点指示器的新坐标。

◆ GetIndicatorPositionAsAnchorPoint()

function XUIPageView GetIndicatorPositionAsAnchorPoint ( )

获取以描述锚点的方式时,小圆点页指示器在PageView的哪个地方显示

Returns
XVECTOR2 小圆点页指示器在PageView的哪个地方,范围(0~1),即XVECTOR2(0.5,0.5)为控件中心点。

◆ GetIndicatorSelectedIndexColor()

function XUIPageView GetIndicatorSelectedIndexColor ( )

获取被选中的小圆点指示器的颜色

Returns
XCOLORBASE 被选中的小圆点颜色。

◆ GetIndicatorSpaceBetweenIndexNodes()

function XUIPageView GetIndicatorSpaceBetweenIndexNodes ( )

获取两个小圆点指示器之间的间隔

Returns
number 间隔值,单位像素

◆ GetPageByIndex()

function XUIPageView GetPageByIndex ( nIndex  )

XUIPageView_GetPageByIndex00

Parameters
nIndexnumber
Returns
XUIWidget

◆ GetPageNumber()

function XUIPageView GetPageNumber ( )

XUIPageView_GetPageNumber00

Returns
number

◆ InsertPage()

function XUIPageView InsertPage ( nIndex  )

在指定位置插入一页

Parameters
nIndexnumber 插入位置索引
Returns
XUIWidget

◆ JumpToPage()

function XUIPageView JumpToPage ( nIndex  )

XUIPageView_JumpToPage00

Parameters
nIndexnumber
Returns
void

◆ MovePage()

function XUIPageView MovePage ( nOldIndex  ,
nNewIndex   
)

XUIPageView_MovePage00

Parameters
nOldIndexnumber
nNewIndexnumber
Returns
void

◆ new()

function XUIPageView new ( )

XUIPageView_new00

Returns
XUIPageView

◆ RemoveAllPages()

function XUIPageView RemoveAllPages ( )

移除所有页

Returns
void

◆ RemovePage()

function XUIPageView RemovePage ( pPage  )

移除指定页

Parameters
pPageXUIWidget 被移除的页
Returns
void

◆ RemovePageAtIndex()

function XUIPageView RemovePageAtIndex ( nIndex  )

移除指定索引对应的页

Parameters
nIndexnumber 指定索引
Returns
void

◆ ScrollToPage() [1/2]

function XUIPageView ScrollToPage ( nIndex  )

滚动到一个指定的页

Parameters
nIndexnumber 指定索引
Returns
void

◆ ScrollToPage() [2/2]

function XUIPageView ScrollToPage ( nIndex  ,
fTime   
)

滚动到一个指定的页

Parameters
nIndexnumber 指定索引
fTimenumber 滚动时间
Returns
void

◆ SetContentSize()

function XUIPageView SetContentSize ( vContentSize  )

设置缩放为1时,节点的大小

Parameters
vContentSizeXVECTOR2 节点的大小
Returns
void

◆ SetDirection()

function XUIPageView SetDirection ( direction  )

改变滚动视图的方向

Parameters
directionnumber 滚动方向的枚举
Returns
void

◆ SetIndicatorEnabled()

function XUIPageView SetIndicatorEnabled ( bEnabled  )

设置小圆点页指示器是否启用

Parameters
bEnabledboolean 是否启用那个小圆点页指示器
Returns
void

◆ SetIndicatorIndexNodesColor()

function XUIPageView SetIndicatorIndexNodesColor ( color  )

设置小圆点指示器的颜色

Parameters
colorXCOLORBASE 小圆点颜色。
Returns
void

◆ SetIndicatorIndexNodesScale()

function XUIPageView SetIndicatorIndexNodesScale ( fIndexNodesScale  )

设置被选中的小圆点指示器的缩放

Parameters
fIndexNodesScalenumber 小圆点缩放值。
Returns
void

◆ SetIndicatorIndexNodesTexture()

function XUIPageView SetIndicatorIndexNodesTexture ( strTexName  ,
eTexType   
)

设置小圆点指示器的图片

Parameters
strTexNamestring 要设置的纹理路径。
eTexTypenumber 相对路径/绝对路径。
Returns
void

◆ SetIndicatorPosition()

function XUIPageView SetIndicatorPosition ( vPosition  )

设置小圆点页指示器的位置

Parameters
vPositionXVECTOR2 小圆点指示器的新坐标。
Returns
void

◆ SetIndicatorPositionAsAnchorPoint()

function XUIPageView SetIndicatorPositionAsAnchorPoint ( vPositionAsAnchorPoint  )

以描述锚点的方式来设置小圆点页指示器在PageView的哪个地方显示

Parameters
vPositionAsAnchorPointXVECTOR2 小圆点页指示器在PageView的哪个地方,范围(0~1),即XVECTOR2(0.5,0.5)为控件中心点。
Returns
void

◆ SetIndicatorSelectedIndexColor()

function XUIPageView SetIndicatorSelectedIndexColor ( color  )

设置被选中的小圆点指示器的颜色

Parameters
colorXCOLORBASE 被选中的小圆点颜色。
Returns
void

◆ SetIndicatorSpaceBetweenIndexNodes()

function XUIPageView SetIndicatorSpaceBetweenIndexNodes ( fSpaceBetweenIndexNodes  )

设置两个小圆点指示器之间的间隔

Parameters
fSpaceBetweenIndexNodesnumber 间隔值,单位像素
Returns
void

Variable Documentation

◆ DOWN

XUIPageView DOWN = 0

◆ LEFT

XUIPageView LEFT = 0

◆ RIGHT

XUIPageView RIGHT = 0

◆ TURNING

XUIPageView TURNING = 0

◆ UP

XUIPageView UP = 0

◆ XUIPageView