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

Functions

function XUILayout new () end
 
function XUILayout Create () end
 
function XUILayout GetImage () end
 
function XUILayout LoadBackGroundTexture (strTexture, eTextureType) end
 
function XUILayout GetBackGroundTexture () end
 
function XUILayout SetContentSize (vContentSize) end
 
function XUILayout SetAnchorPoint (vAnchorPoint) end
 
function XUILayout SetPadding (fLeft, fRight, fTop, fBottom) end
 
function XUILayout SetLeftPadding (fLeft) end
 
function XUILayout SetRightPadding (fRight) end
 
function XUILayout SetTopPadding (fTop) end
 
function XUILayout SetBottomPadding (fBottom) end
 
function XUILayout GetPadding (fLeft, fRight, fTop, fBottom) end
 
function XUILayout GetPadding () end
 
function XUILayout GetLeftPadding () end
 
function XUILayout GetRightPadding () end
 
function XUILayout GetTopPadding () end
 
function XUILayout GetBottomPadding () end
 
function XUILayout SetSpaceX (fSpaceX) end
 
function XUILayout GetSpaceX () end
 
function XUILayout SetSpaceY (fSpaceY) end
 
function XUILayout GetSpaceY () end
 
function XUILayout SetOrder (eOrder) end
 
function XUILayout GetOrder () end
 
function XUILayout SetLineIndent (fIndent) end
 
function XUILayout GetLineIndent () end
 
function XUILayout EnableClipping (bEnabled) end
 
function XUILayout IsClippingEnabled () end
 
function XUILayout SetClippingType (eType) end
 
function XUILayout GetClippingType () end
 
function XUILayout SetLayoutType (eType) end
 
function XUILayout GetLayoutType () end
 
function XUILayout SetGlobalZOrder (fGlobalZOrder) end
 
function XUILayout SetGlobalZOrderNV (fGlobalZOrder, setChildren) end
 
function XUILayout AddChild (pChild) end
 
function XUILayout RemoveChild (pChild, bCleanup) end
 
function XUILayout RemoveAllChildren (bClean) end
 
function XUILayout OnEnter () end
 
function XUILayout OnExit () end
 
function XUILayout ForceDoLayout () end
 
function XUILayout RequestDoLayout () end
 
function XUILayout Adapt () end
 
function XUILayout DoLayout () end
 
function XUILayout CreateLayoutManager () end
 
function XUILayout GetLayoutContentSize () end
 
function XUILayout SetLoopFocus (bLoop) end
 
function XUILayout IsLoopFocus () end
 
function XUILayout SetPassFocusToChild (bPass) end
 
function XUILayout IsPassFocusToChild () end
 
function XUILayout GetTypeID () end
 
function XUILayout InsertChild (index, pChild) end
 
function XUILayout RemoveAllChildrenNV (bClean) end
 
function XUILayout EnableAutoLayout (enable) end
 
function XUILayout IsAutoLayout () end
 
function XUILayout AutoFitWidthOrHeight () end
 

Variables

 XUILayout = {}
 
XUILayout XUI_ABSOLUTE = 0
 
XUILayout XUI_VERTICAL = 0
 
XUILayout XUI_HORIZONTAL = 0
 
XUILayout XUI_GRID = 0
 
XUILayout XUI_TREE = 0
 
XUILayout XUI_NORMAL = 0
 
XUILayout XUI_INVERSE = 0
 
XUILayout XUI_STENCIL = 0
 
XUILayout XUI_SCISSOR = 0
 

Function Documentation

◆ Adapt()

function XUILayout Adapt ( )

XUILayout_Adapt00

Returns
void

◆ AddChild()

function XUILayout AddChild ( pChild  )

添加一个子节点到容器内,z-order是0. 如果子节点被添加到了一个“running(活动着的)”节点,那么'onEnter'和 'onEnterTransitionDidFinish' 将会立即调用

Parameters
pChildXUINode 子节点
Returns
void

◆ AutoFitWidthOrHeight()

function XUILayout AutoFitWidthOrHeight ( )

XUILayout_AutoFitWidthOrHeight00

Returns
void

◆ Create()

function XUILayout Create ( )

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

Returns
XUILayout 控件指针

◆ CreateLayoutManager()

function XUILayout CreateLayoutManager ( )

创建一个布局管理器

Returns
XUILayoutManager 返回创建的布局管理器

◆ DoLayout()

function XUILayout DoLayout ( )

刷新该XUILayout的控件布局,更新子节点的位置 当需要刷新布局时,通常情况下使用RequestDoLayout()即可。 当需要立即获取到刷新后各子节点位置时,可以调用ForceDoLayout()。 该函数通常情况下不需要直接手动调用。

Returns
void

◆ EnableAutoLayout()

function XUILayout EnableAutoLayout ( enable  )

XUILayout_EnableAutoLayout00

Parameters
enableboolean
Returns
void

◆ EnableClipping()

function XUILayout EnableClipping ( bEnabled  )

切换布局剪裁。 如果你需要裁剪,你需要传递true给这个函数

Parameters
bEnabledboolean 是否允许被裁切
Returns
void

◆ ForceDoLayout()

function XUILayout ForceDoLayout ( )

强制刷新控件的布局,会立刻调用DoLayout()刷新布局

Returns
void

◆ GetBackGroundTexture()

function XUILayout GetBackGroundTexture ( )

获取背景图片的纹理路径

Returns
string 纹理文件路径名

◆ GetBottomPadding()

function XUILayout GetBottomPadding ( )

获取底部的空白填充

Returns
number 底部填充大小

◆ GetClippingType()

function XUILayout GetClippingType ( )

获取layout的剪裁类型。

Returns
number 剪裁类型

◆ GetImage()

function XUILayout GetImage ( )

获取图片,XUILayout默认有一张图片作为XUILayout的背景。该函数会返回这张图片的实例(XUIImage)

Returns
XUIImage 图片指针

◆ GetLayoutContentSize()

function XUILayout GetLayoutContentSize ( )

获取布局区域的大小

Returns
XVECTOR2 返回布局区域大小

◆ GetLayoutType()

function XUILayout GetLayoutType ( )

获取布局类型

Returns
number 布局类型

◆ GetLeftPadding()

function XUILayout GetLeftPadding ( )

获取左侧的空白填充

Returns
number 左侧填充大小

◆ GetLineIndent()

function XUILayout GetLineIndent ( )

XUILayout_GetLineIndent00

Returns
number

◆ GetOrder()

function XUILayout GetOrder ( )

获取当前排序类型

Returns
number 返回当前排序类型

◆ GetPadding() [1/2]

function XUILayout GetPadding ( fLeft  ,
fRight  ,
fTop  ,
fBottom   
)

获取上下左右的空白填充

Parameters
fLeftnumber 左侧填充大小
fRightnumber 右侧填充大小
fTopnumber 顶部填充大小
fBottomnumber 底部填充大小
Returns
void

◆ GetPadding() [2/2]

function XUILayout GetPadding ( )

XUILayout_GetPadding01

Returns
number
number
number
number
void

◆ GetRightPadding()

function XUILayout GetRightPadding ( )

获取右侧的空白填充

Returns
number 右侧填充大小

◆ GetSpaceX()

function XUILayout GetSpaceX ( )

获取XUILayout中,两个控件之间的横向间隔

Returns
number 两个控件之间的间隔值(单位像素)

◆ GetSpaceY()

function XUILayout GetSpaceY ( )

获取XUILayout中,两个控件之间的纵向间隔

Returns
number 两个控件之间的间隔值(单位像素)

◆ GetTopPadding()

function XUILayout GetTopPadding ( )

获取顶部的空白填充

Returns
number 顶部填充大小

◆ GetTypeID()

function XUILayout GetTypeID ( )

获取节点类型id,并返回

Returns
number

◆ InsertChild()

function XUILayout InsertChild ( index  ,
pChild   
)

插入一个子节点到父节点内,z-order同原先位置处子节点的z-order. 如果子节点被添加到了一个“running(活动着的)”节点,那么'onEnter'将会立即调用

Parameters
indexnumber 子节点序列
pChildXUINode 子节点
Returns
boolean

◆ IsAutoLayout()

function XUILayout IsAutoLayout ( )

XUILayout_IsAutoLayout00

Returns
boolean

◆ IsClippingEnabled()

function XUILayout IsClippingEnabled ( )

获取布局是否允许被裁切

Returns
boolean 是否允许被裁切

◆ IsLoopFocus()

function XUILayout IsLoopFocus ( )

如果启用了焦点循环,那么它将返回true,否则返回false。默认值是false

Returns
boolean

◆ IsPassFocusToChild()

function XUILayout IsPassFocusToChild ( )

获取layout是否传递焦点到它的子节点上

Returns
boolean

◆ LoadBackGroundTexture()

function XUILayout LoadBackGroundTexture ( strTexture  ,
eTextureType   
)

加载一张纹理作为XUILayout的背景图片

Parameters
strTexturestring 纹理文件路径名
eTextureTypenumber 纹理路径类型(相对路径/全局路径)
Returns
void

◆ new()

function XUILayout new ( )

XUILayout_new00

Returns
XUILayout

◆ OnEnter()

function XUILayout OnEnter ( )

事件回调函数 每次当Node进入“stage”时才调用事件回调。 如果Node进入“stage”状态时伴随着一个转换(transition), 那么事件将会在这个转换开始的时候被调用。 在onEnter过程中,你不能够接入“sister/brother”兄妹节点。 如果你重写了onEnter方法,你应该调用它的父类.

Returns
void

◆ OnExit()

function XUILayout OnExit ( )

事件回调函数 每次当Node离开“stage”时才调用事件回调。 如果Node离开“stage”状态时伴随着一个转换(transition), 那么事件将会在这个转换结束的时候被调用。 在onEnter过程中中你不能够接入一个兄妹节点。 如果你重写onExit, 你应该调用它的父类,

Returns
void

◆ RemoveAllChildren()

function XUILayout RemoveAllChildren ( bClean  )

从容器中删除所有孩子,同时可能会清除所有的活动的动作

Parameters
bCleanboolean true在这个节点上所有的动作和回调都会被删除,false就不会删除
Returns
void

◆ RemoveAllChildrenNV()

function XUILayout RemoveAllChildrenNV ( bClean  )

移除所有子节点不包括protectchildren 添加此接口是为替代原有removeallchildren接口 scrollview listview调用存在bug

Parameters
bCleanboolean
Returns
void

◆ RemoveChild()

function XUILayout RemoveChild ( pChild  ,
bCleanup   
)

从容器中删除一个孩子,取决于cleanup参数,同时可能会清除所有的活动的动作

Parameters
pChildXUINode 希望被删除的子节点
bCleanupboolean true在这个节点上所有的动作和回调都会被删除,false就不会删除
Returns
void

◆ RequestDoLayout()

function XUILayout RequestDoLayout ( )

XUILayout_RequestDoLayout00

Returns
void

◆ SetAnchorPoint()

function XUILayout SetAnchorPoint ( vAnchorPoint  )

设置锚点,用百分比表示。 一个锚点是所有的转换和定位操作发生的点。 它就像在节点上连接其父类的大头针。 锚点是标准化的,就像百分比一样。(0,0)表示左下角,(1,1)表示右上角。 但是你可以使用比(1,1,)更高的值或者比(0,0)更低的值。 默认的锚点是(0.5,0.5),因此它开始于节点的中心位置

Parameters
vAnchorPointXVECTOR2 节点的锚点
Returns
void

◆ SetBottomPadding()

function XUILayout SetBottomPadding ( fBottom  )

设置底部的空白填充

Parameters
fBottomnumber 底部填充大小
Returns
void

◆ SetClippingType()

function XUILayout SetClippingType ( eType  )

改变layout的剪裁类型。

Parameters
eTypenumber 剪裁类型
Returns
void

◆ SetContentSize()

function XUILayout SetContentSize ( vContentSize  )

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

Parameters
vContentSizeXVECTOR2 节点的大小
Returns
void

◆ SetGlobalZOrder()

function XUILayout SetGlobalZOrder ( fGlobalZOrder  )

设置全局Z值,详见XUINode

Parameters
fGlobalZOrdernumber
Returns
void

◆ SetGlobalZOrderNV()

function XUILayout SetGlobalZOrderNV ( fGlobalZOrder  ,
setChildren   
)

设置全局Z值,详见XUINode

Parameters
fGlobalZOrdernumber
setChildrenboolean
Returns
void

◆ SetLayoutType()

function XUILayout SetLayoutType ( eType  )

改变布局类型

Parameters
eTypenumber 布局类型
Returns
void

◆ SetLeftPadding()

function XUILayout SetLeftPadding ( fLeft  )

设置左侧的空白填充

Parameters
fLeftnumber 左侧填充大小
Returns
void

◆ SetLineIndent()

function XUILayout SetLineIndent ( fIndent  )

XUILayout_SetLineIndent00

Parameters
fIndentnumber
Returns
void

◆ SetLoopFocus()

function XUILayout SetLoopFocus ( bLoop  )

如果一个布局是循环获取焦点,这意味着焦点在layout中移动

Parameters
bLoopboolean 传入true则设置内部焦点可以循环传递
Returns
void

◆ SetOrder()

function XUILayout SetOrder ( eOrder  )

设置是否逆序排序

Parameters
eOrdernumber XUI_INVERSE,逆序,该Layout管理的控件会逆向布局XUI_NORMAL,正常,默认为XUI_NORMAL
Returns
void

◆ SetPadding()

function XUILayout SetPadding ( fLeft  ,
fRight  ,
fTop  ,
fBottom   
)

设置上下左右的空白填充(或者说叫留白)

Parameters
fLeftnumber 左侧填充大小
fRightnumber 右侧填充大小
fTopnumber 顶部填充大小
fBottomnumber 底部填充大小
Returns
void

◆ SetPassFocusToChild()

function XUILayout SetPassFocusToChild ( bPass  )

要指定layout是否传递焦点到它的子节点上

Parameters
bPassboolean
Returns
void

◆ SetRightPadding()

function XUILayout SetRightPadding ( fRight  )

设置右侧的空白填充

Parameters
fRightnumber 右侧填充大小
Returns
void

◆ SetSpaceX()

function XUILayout SetSpaceX ( fSpaceX  )

设置XUILayout中,两个控件之间的横向间隔

Parameters
fSpaceXnumber 间隔值(单位像素)
Returns
void

◆ SetSpaceY()

function XUILayout SetSpaceY ( fSpaceY  )

设置XUILayout中,两个控件之间的纵向间隔

Parameters
fSpaceYnumber 间隔值(单位像素)
Returns
void

◆ SetTopPadding()

function XUILayout SetTopPadding ( fTop  )

设置顶部的空白填充

Parameters
fTopnumber 顶部填充大小
Returns
void

Variable Documentation

◆ XUI_ABSOLUTE

XUIWidget XUI_ABSOLUTE = 0

◆ XUI_GRID

XUILayout XUI_GRID = 0

◆ XUI_HORIZONTAL

XUILayout XUI_HORIZONTAL = 0

◆ XUI_INVERSE

XUILayout XUI_INVERSE = 0

◆ XUI_NORMAL

XUILayout XUI_NORMAL = 0

◆ XUI_SCISSOR

XUILayout XUI_SCISSOR = 0

◆ XUI_STENCIL

XUILayout XUI_STENCIL = 0

◆ XUI_TREE

XUILayout XUI_TREE = 0

◆ XUI_VERTICAL

XUILayout XUI_VERTICAL = 0

◆ XUILayout

XUILayout = {}