AR_Engine_SDK
|
Functions | |
function XUINode | Create () end |
function XUINode | new () end |
function XUINode | GetParent () end |
function XUINode | RemoveFromParent (bClean) end |
function XUINode | RemoveAllChildren (bClean) end |
function XUINode | GetAllChildByNameRecrusive (strChild) end |
function XUINode | GetAllChildByGUIDRecrusive (unGUID) end |
function XUINode | AddChild (pChild) end |
function XUINode | AddChild (pChild, localZOrder) end |
function XUINode | GetChildrenNum () end |
function XUINode | GetChildren () end |
function XUINode | GetChildByName (strChild) end |
function XUINode | GetChildByNameRecrusive (strChild) end |
function XUINode | GetChildByGUIDRecrusive (unGUID) end |
function XUINode | RemoveChild (pChild, bClean) end |
function XUINode | SortChildren () end |
function XUINode | AddProtectedChild (pChild) end |
function XUINode | GetProtectedChildrenNum () end |
function XUINode | GetProtectedChildren () end |
function XUINode | GetProtectedChildByName (strChild) end |
function XUINode | GetProtectedChildByNameRecrusive (strChild) end |
function XUINode | GetProtectedChildByGUIDRecrusive (unGUID) end |
function XUINode | RemoveProtectedChild (pChild, bClean) end |
function XUINode | SortProtectedChildren () end |
function XUINode | MakeProtectedName (strName) end |
function XUINode | Clone () end |
function XUINode | IsProtected () end |
function XUINode | GetTypeString () end |
function XUINode | GetTypeID () end |
function XUINode | GetScene () end |
function XUINode | GetGUID () end |
function XUINode | GetName () end |
function XUINode | SetName (strName) end |
function XUINode | GetUserData () end |
function XUINode | SetUserData (strUserData) end |
function XUINode | SetLocalZOrder (nLocalZOrder) end |
function XUINode | SetLocalZOrderNV (nLocalZOrder) end |
function XUINode | GetLocalZOrder () end |
function XUINode | SetGlobalZOrder (fGlobalZOrder) end |
function XUINode | SetGlobalZOrderNV (fGlobalZOrder, setChildren) end |
function XUINode | GetGlobalZOrder () end |
function XUINode | SetScaleX (fScaleX) end |
function XUINode | GetScaleX () end |
function XUINode | SetScaleY (fScaleY) end |
function XUINode | GetScaleY () end |
function XUINode | SetScale (fScaleX, fScaleY) end |
function XUINode | SetScale (vScale) end |
function XUINode | GetScale () end |
function XUINode | SetPositionX (x) end |
function XUINode | GetPositionX () end |
function XUINode | SetPositionY (y) end |
function XUINode | GetPositionY () end |
function XUINode | SetPosition (x, y) end |
function XUINode | SetPosition (vPos) end |
function XUINode | GetPosition () end |
function XUINode | SetAnchorPoint (vAnchorPoint) end |
function XUINode | GetAnchorPoint () end |
function XUINode | GetAnchorPointInPoints () end |
function XUINode | SetContentSize (vContentSize) end |
function XUINode | SetContentSize (fContentX, fContentY) end |
function XUINode | GetContentSize () end |
function XUINode | SetContentSizeX (fContentX) end |
function XUINode | GetContentSizeX () end |
function XUINode | SetContentSizeY (fContentY) end |
function XUINode | GetContentSizeY () end |
function XUINode | SetRotation (fRotation) end |
function XUINode | GetRotation () end |
function XUINode | SetVisible (bVisible) end |
function XUINode | IsVisible () end |
function XUINode | IsRunning () end |
function XUINode | OnEnter () end |
function XUINode | OnExit () end |
function XUINode | Resume () end |
function XUINode | Pause () end |
function XUINode | Cleanup () end |
function XUINode | RunAction (pAction) end |
function XUINode | StopAllActions () end |
function XUINode | StopAction (pAction) end |
function XUINode | FirstTick () end |
function XUINode | Tick (fDelta) end |
function XUINode | Update (fDelta) end |
function XUINode | Draw (pWorld, unParentFlags) end |
function XUINode | EnableMask (bEnable) end |
function XUINode | IsMask () end |
function XUINode | SetScreenMask (vPos, vWAxis, vHAxis, fWidth, fHeight) end |
function XUINode | GetMask (vPosAndWH, vWHAxis) end |
function XUINode | GetMask () end |
function XUINode | GetBoundingBox () end |
function XUINode | GetLeftBoundary () end |
function XUINode | GetRightBoundary () end |
function XUINode | GetTopBoundary () end |
function XUINode | GetBottomBoundary () end |
function XUINode | ForceUpdateTransform () end |
function XUINode | GetLocalToParentTransform () end |
function XUINode | GetScreenToLocalOriginTransform () end |
function XUINode | GetLocalOriginToScreenTransform () end |
function XUINode | GetLocalOriginToWorldTransform () end |
function XUINode | GetLocalToScreenTransform () end |
function XUINode | GetLocalToWorldTransform () end |
function XUINode | RefreshLayout () end |
function XUINode | InsertChild (index, pChild) end |
function XUINode | Destroy () end |
Variables | |
UIID_UNKNOWN = 0 | |
UIID_NODE = 0 | |
UIID_WIDGET = 0 | |
UIID_IMAGE = 0 | |
UIID_IMAGEARRAY = 0 | |
UIID_LABEL = 0 | |
UIID_FX = 0 | |
UIID_LAYOUT = 0 | |
UI_VIRTUALLIST = 0 | |
UIID_PANEL = 0 | |
UIID_SCENE = 0 | |
XUINode = {} | |
function XUINode AddChild | ( | pChild | ) |
添加一个子节点到父节点内,z-order是0. 如果子节点被添加到了一个“running(活动着的)”节点,那么'onEnter'和 'onEnterTransitionDidFinish' 将会立即调用
pChild | XUINode 子节点 |
function XUINode AddChild | ( | pChild | , |
localZOrder | |||
) |
添加一个子节点到父节点内,z-order是 localzorder. 如果子节点被添加到了一个“running(活动着的)”节点,那么'onEnter'和 'onEnterTransitionDidFinish' 将会立即调用
pChild | XUINode 子节点 |
localZOrder | number 用于渲染排序的zorder值.详细可参考函数<tt>SetLocalZOrder(xint32). |
function XUINode AddProtectedChild | ( | pChild | ) |
添加一个 Z 值为 0 的子节点。如果当前节点正在运行,那么 'onEnter' 和 'onEnterTransitionDidFinish' 会被立即调用
pChild | XUINode 一个子节点 |
function XUINode Cleanup | ( | ) |
停止并移除所有的活动着的动作和调度器
function XUINode Destroy | ( | ) |
XUINode_Destroy00
function XUINode Draw | ( | pWorld | , |
unParentFlags | |||
) |
重写这个方法来绘制你自己的节点
pWorld | IXRenderSet 给定的世界指针 |
unParentFlags | number 渲染器标签 |
function XUINode EnableMask | ( | bEnable | ) |
XUINode_EnableMask00
bEnable | boolean |
function XUINode FirstTick | ( | ) |
第一帧被调用的函数,不应当被手动调用。
function XUINode ForceUpdateTransform | ( | ) |
强制更新Transform,通过SetPosition、SetScale等函数修改该节点的Transform时,数据不会立即更新,而是等到该节点需要绘制的时候才会更新,在有些情景下(比如需要使用GetLocalToScreenTransform函数),我们希望该节点的Transform是最新的,这时候需要手动调用该函数。
function XUINode GetAllChildByGUIDRecrusive | ( | unGUID | ) |
递归地通过名称获取子节点,该函数会返回ID为unGUID的最先找到的一个子孙节点,这意味着该函数不仅仅只找自己的子节点,而是还会找子节点的子节点的子节点的子节点的......
unGUID | number 要找的XUINode的ID值 |
function XUINode GetAllChildByNameRecrusive | ( | strChild | ) |
递归地通过名称获取子节点,该函数会返回名字为strChild的最先找到的一个子孙节点,这意味着该函数不仅仅只找自己的子节点,而是还会找子节点的子节点的子节点的子节点的......
strChild | string 要找的XUINode的Name值 |
function XUINode GetAnchorPoint | ( | ) |
返回用百分比表示的锚点
function XUINode GetAnchorPointInPoints | ( | ) |
返回锚点的绝对像素位置
function XUINode GetBottomBoundary | ( | ) |
XUINode_GetBottomBoundary00
function XUINode GetChildByGUIDRecrusive | ( | unGUID | ) |
递归地通过名称获取子节点,该函数会返回ID为unGUID的最先找到的一个子孙节点,这意味着该函数不仅仅只找自己的子节点,而是还会找子节点的子节点的子节点的子节点的......
unGUID | number 要找的XUINode的ID值 |
function XUINode GetChildByName | ( | strChild | ) |
function XUINode GetChildByNameRecrusive | ( | strChild | ) |
递归地通过名称获取子节点,该函数会返回名字为strChild的最先找到的一个子孙节点,这意味着该函数不仅仅只找自己的子节点,而是还会找子节点的子节点的子节点的子节点的......
strChild | string 要找的XUINode的Name值 |
function XUINode GetChildrenNum | ( | ) |
获取子节点总个数
function XUINode GetContentSize | ( | ) |
返回节点的大小。
function XUINode GetContentSizeX | ( | ) |
返回节点的宽度。
function XUINode GetContentSizeY | ( | ) |
返回节点的高度。
function XUINode GetGlobalZOrder | ( | ) |
返回节点的全局Z顺序
function XUINode GetGUID | ( | ) |
获取GUID并返回
function XUINode GetLeftBoundary | ( | ) |
XUINode_GetLeftBoundary00
function XUINode GetLocalOriginToScreenTransform | ( | ) |
XUINode_GetLocalOriginToScreenTransform00
function XUINode GetLocalOriginToWorldTransform | ( | ) |
XUINode_GetLocalOriginToWorldTransform00
function XUINode GetLocalToParentTransform | ( | ) |
获得相对于父节点的Transform矩阵(里面有位置、旋转、缩放信息)
function XUINode GetLocalToScreenTransform | ( | ) |
XUINode_GetLocalToScreenTransform00
function XUINode GetLocalToWorldTransform | ( | ) |
XUINode_GetLocalToWorldTransform00
function XUINode GetLocalZOrder | ( | ) |
得到这个节点的局部Z顺序
function XUINode GetMask | ( | vPosAndWH | , |
vWHAxis | |||
) |
XUINode_GetMask00
vPosAndWH | XVECTOR4 |
vWHAxis | XVECTOR4 |
function XUINode GetMask | ( | ) |
XUINode_GetMask01
function XUINode GetName | ( | ) |
获取节点名称并返回
function XUINode GetParent | ( | ) |
function XUINode GetPosition | ( | ) |
得到在父节点坐标系中节点的位置(x,y,以XVECTOR2形式)
function XUINode GetPositionX | ( | ) |
获取节点在父节点坐标系下的X轴位置
function XUINode GetPositionY | ( | ) |
获取节点在父节点坐标系下的Y轴位置
function XUINode GetProtectedChildByGUIDRecrusive | ( | unGUID | ) |
function XUINode GetProtectedChildByName | ( | strChild | ) |
function XUINode GetProtectedChildByNameRecrusive | ( | strChild | ) |
function XUINode GetProtectedChildrenNum | ( | ) |
获取所有子节点数目
function XUINode GetRightBoundary | ( | ) |
XUINode_GetRightBoundary00
function XUINode GetRotation | ( | ) |
返回节点的旋转角度
function XUINode GetScale | ( | ) |
返回节点的缩放因子(x,y)。
function XUINode GetScaleX | ( | ) |
返回该节点的X轴的缩放因子。 它是一个缩放因子,将会乘以节点的宽以及它的子节点
function XUINode GetScaleY | ( | ) |
返回该节点的Y轴的缩放因子。 它是一个缩放因子,将会乘以节点的宽以及它的子节点
function XUINode GetScreenToLocalOriginTransform | ( | ) |
XUINode_GetScreenToLocalOriginTransform00
function XUINode GetTopBoundary | ( | ) |
XUINode_GetTopBoundary00
function XUINode GetTypeID | ( | ) |
获取节点类型id,并返回
function XUINode GetTypeString | ( | ) |
获取类型字符串,并返回
function XUINode GetUserData | ( | ) |
XUINode_GetUserData00
function XUINode InsertChild | ( | index | , |
pChild | |||
) |
插入一个子节点到父节点内,z-order同原先位置处子节点的z-order. 如果子节点被添加到了一个“running(活动着的)”节点,那么'onEnter'将会立即调用
index | number 子节点序列 |
pChild | XUINode 子节点 |
function XUINode IsMask | ( | ) |
XUINode_IsMask00
function XUINode IsProtected | ( | ) |
判断是否是protected节点(Z值为0)
function XUINode IsRunning | ( | ) |
返回节点是否是“running(活动的)”。 如果节点是活动的,它将会允许事件回调就像onEnter(), onExit(), update()
function XUINode IsVisible | ( | ) |
返回节点的可见状态
function XUINode MakeProtectedName | ( | strName | ) |
XUINode_MakeProtectedName00
strName | string |
function XUINode OnEnter | ( | ) |
事件回调函数 每次当Node进入“stage”时才调用事件回调。 如果Node进入“stage”状态时伴随着一个转换(transition), 那么事件将会在这个转换开始的时候被调用。 在onEnter过程中,你不能够接入“sister/brother”兄妹节点。 如果你重写了onEnter方法,你应该调用它的父类.
function XUINode OnExit | ( | ) |
事件回调函数 每次当Node离开“stage”时才调用事件回调。 如果Node离开“stage”状态时伴随着一个转换(transition), 那么事件将会在这个转换结束的时候被调用。 在onEnter过程中中你不能够接入一个兄妹节点。 如果你重写onExit, 你应该调用它的父类,
function XUINode Pause | ( | ) |
暂停所有的调度过的选择器,动作和事件监听器。 这个方法被onExit方法在内部调用
function XUINode RefreshLayout | ( | ) |
刷新布局
function XUINode RemoveAllChildren | ( | bClean | ) |
从父节点中删除所有的孩子。
bClean | boolean true:在这个节点上所有的动作和回调都会被删除并释放其内存(真正被删掉),false:不会释放,还可以继续使用该节点,并通过AddChild函数将其移入其他父节点下。 |
function XUINode RemoveChild | ( | pChild | , |
bClean | |||
) |
从容器中删除一个孩子,取决于cleanup参数,同时可能会清除所有的活动的动作
pChild | XUINode 希望被删除的子节点 |
bClean | boolean true在这个节点上所有的动作和回调都会被删除,false就不会删除 |
function XUINode RemoveFromParent | ( | bClean | ) |
从父节点中删除一个节点 如果这个节点是一个孤儿节点,那么什么都不会发生。
bClean | boolean true:在这个节点上所有的动作和回调都会被删除并释放其内存(真正被删掉),false:不会释放,还可以继续使用该节点,并通过AddChild函数将其移入其他父节点下。 |
function XUINode RemoveProtectedChild | ( | pChild | , |
bClean | |||
) |
删除一个子节点。可以通过设置 cleanup 的参数值清理所有正在运行的 action
pChild | XUINode 将被删除的子节点 |
bClean | boolean 如果为true,将清理子节点相关的action和回调 |
function XUINode Resume | ( | ) |
恢复所有的调度过的选择器,动作和事件监听器。 这个方法被onEnter方法在内部调用
function XUINode RunAction | ( | pAction | ) |
function XUINode SetAnchorPoint | ( | vAnchorPoint | ) |
设置锚点,用百分比表示。 一个锚点是所有的转换和定位操作发生的点。 它就像在节点上连接其父类的大头针。 锚点是标准化的,就像百分比一样。(0,0)表示左下角,(1,1)表示右上角。 但是你可以使用比(1,1,)更高的值或者比(0,0)更低的值。 默认的锚点是(0.5,0.5),因此它开始于节点的中心位置
vAnchorPoint | XVECTOR2 节点的锚点 |
function XUINode SetContentSize | ( | vContentSize | ) |
设置节点的大小。 contentSize依然是相同的,无论节点是缩放或者旋转。 所有的节点都有大小。图层和场景有相同的屏幕大小。
vContentSize | XVECTOR2 未转换节点的大小 |
function XUINode SetContentSize | ( | fContentX | , |
fContentY | |||
) |
设置缩放为1时,节点的大小。 contentSize依然是相同的,无论节点是缩放或者旋转。所有的节点都有大小。图层和场景有相同的屏幕大小。
fContentX | number 节点的大小x |
fContentY | number 节点的大小y |
function XUINode SetContentSizeX | ( | fContentX | ) |
设置节点的宽度。
fContentX | number 节点的宽度 |
function XUINode SetContentSizeY | ( | fContentY | ) |
设置节点的高度。
fContentY | number 节点的高度 |
function XUINode SetGlobalZOrder | ( | fGlobalZOrder | ) |
定义渲染节点的顺序 拥有全局Z顺序越小的节点,最先渲染 假设两个或者更多的节点拥有相同的全局Z顺序,那么渲染顺序无法保证。 唯一的例外是如果节点的全局Z顺序为零, 那么场景图顺序是可以使用的。 默认的,所有的节点全局Z顺序都是零。这就是说,默认使用场景图顺序来渲染节点。 全局Z顺序是非常有用的当你需要渲染节点按照不同的顺序而不是场景图顺序。 局限性: 全局Z顺序不能够被拥有继承“SpriteBatchNode”的节点使用。 并且如果“ClippingNode”是其中之一的上代, 那么“global Z order” 将会和“ClippingNode”有关
fGlobalZOrder | number 全局Z轴顺序新版本该接口废弃//19.12.25 |
function XUINode SetGlobalZOrderNV | ( | fGlobalZOrder | , |
setChildren | |||
) |
定义渲染节点的顺序 拥有全局Z顺序越小的节点,最先渲染 假设两个或者更多的节点拥有相同的全局Z顺序,那么渲染顺序无法保证。 唯一的例外是如果节点的全局Z顺序为零, 那么场景图顺序是可以使用的。 默认的,所有的节点全局Z顺序都是零。这就是说,默认使用场景图顺序来渲染节点。 全局Z顺序是非常有用的当你需要渲染节点按照不同的顺序而不是场景图顺序。 局限性: 全局Z顺序不能够被拥有继承“SpriteBatchNode”的节点使用。 并且如果“ClippingNode”是其中之一的上代, 那么“global Z order” 将会和“ClippingNode”有关
fGlobalZOrder | number 全局Z轴顺序 |
setChildren | boolean |
function XUINode SetLocalZOrder | ( | nLocalZOrder | ) |
XUINode_SetLocalZOrder00
nLocalZOrder | number |
function XUINode SetLocalZOrderNV | ( | nLocalZOrder | ) |
LocalZOrder是“key”(关键)来分辨节点和它兄弟节点的相关性。 父节点将会通过LocalZOrder的值来分辨所有的子节点。 如果两个节点有同样的LocalZOrder,那么先加入子节点数组的节点将会显示在后加入的节点的前面。 同样的,场景图使用“In-Order(按顺序)”遍历数算法来遍历 并且拥有小于0的LocalZOrder的值的节点是“left”子树(左子树) 所以拥有大于0的LocalZOrder的值得节点是“right”子树(右子树)
nLocalZOrder | number 相邻节点中的顺序值 |
function XUINode SetName | ( | strName | ) |
设置节点名称
strName | string 要设置的名称字符串 |
设置节点的位置在父节点的坐标系系统中。
x | number 这个节点的位置x |
y | number 这个节点的位置y |
设置节点的位置在父节点的坐标系系统中。 通常我们使用XVECTOR2(x,y) 来组成 XVECTOR2对象
vPos | XVECTOR2 这个节点的位置(x,y) |
function XUINode SetRotation | ( | fRotation | ) |
设置节点的旋转(angle)角度。 0 是默认的旋转角度。 负数顺时针旋转节点,正数逆时针旋转节点。
fRotation | number 节点的旋转角度 |
function XUINode SetScale | ( | fScaleX | , |
fScaleY | |||
) |
设置节点的缩放因子(x,y)。 缩放因子将会乘以该节点和它子节点的宽,高和深度
fScaleX | number X轴的缩放因子 |
fScaleY | number Y轴的缩放因子 |
function XUINode SetScale | ( | vScale | ) |
设置节点的缩放因子(x,y)。 缩放因子将会乘以该节点和它子节点的宽,高和深度
vScale | XVECTOR2 X轴,Y轴的缩放因子 |
function XUINode SetScaleX | ( | fScaleX | ) |
设置节点的缩放(x)。 它是一个缩放因子,将会乘以节点的宽以及它的子节点
fScaleX | number X轴的缩放因子 |
function XUINode SetScaleY | ( | fScaleY | ) |
设置节点的缩放(y)。 它是一个缩放因子,将会乘以节点的宽以及它的子节点
fScaleY | number Y轴的缩放因子 |
XUINode_SetScreenMask00
vPos | XVECTOR2 |
vWAxis | XVECTOR2 |
vHAxis | XVECTOR2 |
fWidth | number |
fHeight | number |
function XUINode SetUserData | ( | strUserData | ) |
XUINode_SetUserData00
strUserData | string |
function XUINode SetVisible | ( | bVisible | ) |
设置节点是否可见。默认值是true,一个节点默认是可见的
bVisible | boolean true,如果节点是可见的,false,如果节点是隐藏的 |
function XUINode SortChildren | ( | ) |
在绘画之前,排列所有的孩子数组一次,而不是每次添加或者删除子节点时都排序。 这个方法可以大幅度地提高性能
function XUINode SortProtectedChildren | ( | ) |
在绘制之前对所有子节点进行一次排序。相对于每添加一个节点就排序一次,可以大大提高性能
function XUINode StopAllActions | ( | ) |
停止并且从活动动作列表中删除所有的动作
function XUINode Tick | ( | fDelta | ) |
每一帧被调用的函数,不应当被手动调用。
fDelta | number 与上一帧Tick函数的间隔时间。 |
function XUINode Update | ( | fDelta | ) |
如果"scheduleUpdate"被调用并且这个节点是活跃的话,update方法将会被每帧自动调用 ,通过重载该函数的方式在每一帧处理自定义事件。
fDelta | number 与上一帧Tick函数的间隔时间。 |
UI_VIRTUALLIST = 0 |
UIID_FX = 0 |
UIID_IMAGE = 0 |
UIID_IMAGEARRAY = 0 |
UIID_LABEL = 0 |
UIID_LAYOUT = 0 |
UIID_NODE = 0 |
UIID_PANEL = 0 |
UIID_SCENE = 0 |
UIID_UNKNOWN = 0 |
UIID_WIDGET = 0 |
XUINode = {} |