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

#include <XUIWidget.h>

类 XUIWidget 继承关系图:
Inheritance graph

函数

function XUIWidget Create () end
 
function XUIWidget SetEnabled (enabled) end
 
function XUIWidget IsEnabled () end
 
function XUIWidget SetColor (color) end
 
function XUIWidget SetBright (bBright) end
 
function XUIWidget IsBright () end
 
function XUIWidget SetBrightStyle (style) end
 
function XUIWidget SetTouchEnabled (enabled) end
 
function XUIWidget IsTouchEnabled () end
 
function XUIWidget SetHighlighted (bHighlight) end
 
function XUIWidget IsHighlighted () end
 
function XUIWidget HitTest (vPoint, pHitPos) end
 
function XUIWidget OnTouchBegan (pTouch, pUnusedEvent) end
 
function XUIWidget OnTouchMoved (pTouch, pUnusedEvent) end
 
function XUIWidget OnTouchEnded (pTouch, pUnusedEvent) end
 
function XUIWidget OnTouchCancelled (pTouch, pUnusedEvent) end
 
function XUIWidget GetAlignment () end
 
function XUIWidget SetListenerFixedPriority (nPriority) end
 
function XUIWidget SetSwallowTouches (bSwallow) end
 
function XUIWidget IsSwallowTouches () end
 
function XUIWidget SetPassEvents (bPass) end
 
function XUIWidget IsPassEvents () end
 
function XUIWidget IsFocused () end
 
function XUIWidget SetFocused (bFocus) end
 
function XUIWidget IsFocusEnabled () end
 
function XUIWidget SetFocusEnabled (bEnable) end
 
function XUIWidget SetPropagateTouchEvents (bPropagate) end
 
function XUIWidget IsPropagateTouchEvents () end
 
function XUIWidget GetTouchBeganPosition () end
 
function XUIWidget GetTouchMovePosition () end
 
function XUIWidget GetTouchEndPosition () end
 
function XUIWidget SetLayoutParameter (parameter) end
 
function XUIWidget GetLayoutParameter () end
 
function XUIWidget GetSelectedWidget (vHitPos) end
 
function XUIWidget AddTouchEventListener (callback) end
 
function XUIWidget TriggerTouchEventManually (eType) end
 
function XUIWidget AddClickEventListener (callback) end
 
function XUIWidget TriggerClickEventManually () end
 
function XUIWidget AddWidgetEventListener (callback) end
 
function XUIWidget TriggerWidgetEventManually (eEvent) end
 
function XUIWidget SetLongTouchInterval (delta) end
 
function XUIWidget SetLongTouchedCallback (longTouchedCallback) end
 
function XUIWidget IsInLongTouchStatus () end
 
function XUIWidget SetTouchAreaOffset (vTouchCenter) end
 
function XUIWidget GetTouchAreaOffset () end
 
function XUIWidget SetTouchAreaSize (vTouchSize) end
 
function XUIWidget GetTouchAreaSize () end
 

变量

 XUIWidget = {}
 
XUIWidget XUI_LEFT = 0
 
XUIWidget XUI_RIGHT = 0
 
XUIWidget XUI_UP = 0
 
XUIWidget XUI_DOWN = 0
 
XUIWidget XUI_ABSOLUTE = 0
 
XUIWidget XUI_PERCENT = 0
 
XUIWidget XUI_BEGAN = 0
 
XUIWidget XUI_MOVED = 0
 
XUIWidget XUI_ENDED = 0
 
XUIWidget XUI_CANCELED = 0
 
XUIWidget XUI_NONE = 0
 
XUIWidget XUI_NORMAL = 0
 
XUIWidget XUI_HIGHLIGHT = 0
 
XUIWidget XUI_LOCAL = 0
 
XUIWidget XUI_PLIST = 0
 
XUIWidget XUI_RTT_Tex = 0
 

函数说明

◆ AddClickEventListener()

function XUIWidget AddClickEventListener ( callback  )

@manual xelua_XEngine_XUIWidget_AddClickEventListener_manual XUIWidget_AddClickEventListener_manual

参数
callbackstd::function<void(XUINode*)>
返回
void

◆ AddTouchEventListener()

function XUIWidget AddTouchEventListener ( callback  )

@manual xelua_XEngine_XUIWidget_AddTouchEventListener_manual XUIWidget_AddTouchEventListener_manual

参数
callbackstd::function<void(XUINode*, XUIWidget::TouchEventType)>
返回
void

◆ AddWidgetEventListener()

function XUIWidget AddWidgetEventListener ( callback  )

@manual xelua_XEngine_XUIWidget_AddWidgetEventListener_manual XUIWidget_AddWidgetEventListener_manual

参数
callbackstd::function<void(XUINode*, xint32)>
返回
void

◆ Create()

function XUIWidget Create ( )

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

返回
XUIWidget 控件指针

◆ GetAlignment()

function XUIWidget GetAlignment ( )

获取Widget的布局管理器（XUIWidgetAlignment）

返回
XUIWidgetAlignment

◆ GetLayoutParameter()

function XUIWidget GetLayoutParameter ( )

获取控件布局参数

返回
XUILayoutParameter 布局参数对象指针

◆ GetSelectedWidget()

function XUIWidget GetSelectedWidget ( vHitPos  )

通过传入的点的位置，计算返回选中的控件

参数
vHitPosXVECTOR2 拾取的点位置
返回
XUIWidget

◆ GetTouchAreaOffset()

function XUIWidget GetTouchAreaOffset ( )

XUIWidget_GetTouchAreaOffset00

返回
XVECTOR2

◆ GetTouchAreaSize()

function XUIWidget GetTouchAreaSize ( )

XUIWidget_GetTouchAreaSize00

返回
XVECTOR2

◆ GetTouchBeganPosition()

function XUIWidget GetTouchBeganPosition ( )

获取触点在控件被选中时的起始位置

返回
XVECTOR2 触点的起始位置

◆ GetTouchEndPosition()

function XUIWidget GetTouchEndPosition ( )

获取触点在控件被选中时的结束位置

返回
XVECTOR2 触点的结束位置

◆ GetTouchMovePosition()

function XUIWidget GetTouchMovePosition ( )

获取触点在控件被移动时的位置

返回
XVECTOR2 触点的位置

◆ HitTest()

function XUIWidget HitTest ( vPoint  ,
pHitPos   
)

检查一个点是否在控件的内容空间里。 这个函数是用于检测控件的触摸响应区域

参数
vPointXVECTOR2 点的位置
pHitPosXVECTOR2 击中位置
返回
boolean

◆ IsBright()

function XUIWidget IsBright ( )

获取控件是否高亮

返回
boolean 是否高亮

◆ IsEnabled()

function XUIWidget IsEnabled ( )

判断是否启用了控件

返回
boolean 是否启用状态

◆ IsFocused()

function XUIWidget IsFocused ( )

查询控件是否拥有焦点

返回
boolean 是否拥有焦点

◆ IsFocusEnabled()

function XUIWidget IsFocusEnabled ( )

查询控件是否拥有焦点

返回
boolean 返回true代表控件拥有焦点，反之返回false

◆ IsHighlighted()

function XUIWidget IsHighlighted ( )

获取是否高亮显示

返回
boolean 是否高亮显示

◆ IsInLongTouchStatus()

function XUIWidget IsInLongTouchStatus ( )

判断当前是否处于长按状态

返回
boolean

◆ IsPassEvents()

function XUIWidget IsPassEvents ( )

获取控件是否阻断消息继续传播

返回
boolean 是否是否阻断消息继续传播

◆ IsPropagateTouchEvents()

function XUIWidget IsPropagateTouchEvents ( )

返回控件是否允许触摸事件传播到其父节点

返回
boolean 是否允许触摸事件传播到其父节点

◆ IsSwallowTouches()

function XUIWidget IsSwallowTouches ( )

获取控件是否吞噬触摸事件

返回
boolean 是否吞噬触摸事件

◆ IsTouchEnabled()

function XUIWidget IsTouchEnabled ( )

获取控件是否响应触摸事件

返回
boolean 是否响应触摸事件

◆ OnTouchBegan()

function XUIWidget OnTouchBegan ( pTouch  ,
pUnusedEvent   
)

触摸事件开始时的回调函数

参数
pTouchXUITouch 触点信息
pUnusedEventXUIEvent 触摸事件信息
返回
boolean 如果需要响应这个触摸事件则返回true，否则返回false

◆ OnTouchCancelled()

function XUIWidget OnTouchCancelled ( pTouch  ,
pUnusedEvent   
)

触摸事件取消时的回调函数

参数
pTouchXUITouch 触点信息
pUnusedEventXUIEvent 触摸事件信息
返回
void

◆ OnTouchEnded()

function XUIWidget OnTouchEnded ( pTouch  ,
pUnusedEvent   
)

触摸事件结束时的回调函数

参数
pTouchXUITouch 触点信息
pUnusedEventXUIEvent 触摸事件信息
返回
void

◆ OnTouchMoved()

function XUIWidget OnTouchMoved ( pTouch  ,
pUnusedEvent   
)

触摸事件中触点移动时的回调函数

参数
pTouchXUITouch 触点信息
pUnusedEventXUIEvent 触摸事件信息
返回
void

◆ SetBright()

function XUIWidget SetBright ( bBright  )

设置控件是否高亮，默认值是true，若设置为false，则控件外观是暗的

参数
bBrightboolean 是否高亮
返回
void

◆ SetBrightStyle()

function XUIWidget SetBrightStyle ( style  )

设置控件的高亮风格

参数
stylenumber 指定的高亮风格类型
返回
void

◆ SetColor()

function XUIWidget SetColor ( color  )

设置控件颜色

参数
colorXCOLORBASE 要设置的颜色
返回
void

◆ SetEnabled()

function XUIWidget SetEnabled ( enabled  )

设置是否启用了控件 如果设置为true则启用了控件，部件可以响应触摸事件，如果设置为false则控件是禁用的，不会响应触摸事件。 默认值是true,一个控件是默认启用触摸

参数
enabledboolean 设置为true来启用触摸，否则不启用触摸响应
返回
void

◆ SetFocused()

function XUIWidget SetFocused ( bFocus  )

切换控件是否拥有焦点

参数
bFocusboolean 是否拥有焦点
返回
void

◆ SetFocusEnabled()

function XUIWidget SetFocusEnabled ( bEnable  )

允许控件接受焦点

参数
bEnableboolean 通过传递true/false来启用或禁用一个控件获取焦点
返回
void

◆ SetHighlighted()

function XUIWidget SetHighlighted ( bHighlight  )

设置是否高亮显示,默认值是false，控件默认不高亮显示

参数
bHighlightboolean 是否高亮显示
返回
void

◆ SetLayoutParameter()

function XUIWidget SetLayoutParameter ( parameter  )

给控件设置一个布局参数

参数
parameterXUILayoutParameter 布局参数对象指针
返回
void

◆ SetListenerFixedPriority()

function XUIWidget SetListenerFixedPriority ( nPriority  )
参数
nPrioritynumber
返回
void

◆ SetLongTouchedCallback()

function XUIWidget SetLongTouchedCallback ( longTouchedCallback  )

@manual 设置长按回调事件 XUIWidget_SetLongTouchedCallback_manual

参数
longTouchedCallbackstd::function<void(void)>
返回
void

◆ SetLongTouchInterval()

function XUIWidget SetLongTouchInterval ( delta  )

开始启用长按事件的时间间隔

参数
deltanumber
返回
void

◆ SetPassEvents()

function XUIWidget SetPassEvents ( bPass  )

设置控件是否阻断消息继续传播

参数
bPassboolean true则不阻断传播,false则阻断传播。默认为false
返回
void

◆ SetPropagateTouchEvents()

function XUIWidget SetPropagateTouchEvents ( bPropagate  )

允许控件的触摸事件向上传播到父节点，设置为false会阻止向上传播

参数
bPropagateboolean true允许向上传播，false不允许
返回
void

◆ SetSwallowTouches()

function XUIWidget SetSwallowTouches ( bSwallow  )

设置控件是否吞噬触摸事件

参数
bSwallowboolean true则吞噬触摸事件，false不吞噬
返回
void

◆ SetTouchAreaOffset()

function XUIWidget SetTouchAreaOffset ( vTouchCenter  )

XUIWidget_SetTouchAreaOffset00

参数
vTouchCenterXVECTOR2
返回
void

◆ SetTouchAreaSize()

function XUIWidget SetTouchAreaSize ( vTouchSize  )

XUIWidget_SetTouchAreaSize00

参数
vTouchSizeXVECTOR2
返回
void

◆ SetTouchEnabled()

function XUIWidget SetTouchEnabled ( enabled  )

设置是否响应触摸事件。默认值是false，控件默认是禁用触摸的。

参数
enabledboolean 是否响应触摸事件
返回
void

◆ TriggerClickEventManually()

function XUIWidget TriggerClickEventManually ( )

XUIWidget_TriggerClickEventManually00

返回
void

◆ TriggerTouchEventManually()

function XUIWidget TriggerTouchEventManually ( eType  )

XUIWidget_TriggerTouchEventManually00

参数
eTypenumber
返回
void

◆ TriggerWidgetEventManually()

function XUIWidget TriggerWidgetEventManually ( eEvent  )

XUIWidget_TriggerWidgetEventManually00

参数
eEventnumber
返回
void

变量说明

◆ XUI_ABSOLUTE

XUIWidget XUI_ABSOLUTE = 0

◆ XUI_BEGAN

XUIWidget XUI_BEGAN = 0

◆ XUI_CANCELED

XUIWidget XUI_CANCELED = 0

◆ XUI_DOWN

XUIWidget XUI_DOWN = 0

◆ XUI_ENDED

XUIWidget XUI_ENDED = 0

◆ XUI_HIGHLIGHT

XUIWidget XUI_HIGHLIGHT = 0

◆ XUI_LEFT

XUIWidget XUI_LEFT = 0

◆ XUI_LOCAL

XUIWidget XUI_LOCAL = 0

◆ XUI_MOVED

XUIWidget XUI_MOVED = 0

◆ XUI_NONE

XUIWidget XUI_NONE = 0

◆ XUI_NORMAL

XUIWidget XUI_NORMAL = 0

◆ XUI_PERCENT

XUIWidget XUI_PERCENT = 0

◆ XUI_PLIST

XUIWidget XUI_PLIST = 0

◆ XUI_RIGHT

XUIWidget XUI_RIGHT = 0

◆ XUI_RTT_Tex

XUIWidget XUI_RTT_Tex = 0

◆ XUI_UP

XUIWidget XUI_UP = 0

◆ XUIWidget

XUIWidget = {}
制作者 doxygen 1.9.1