VBox is just a convenient wrapper class for vertical layout type. More...
Inherits Layout.
Public Member Functions | |
VBox () | |
Default constructor. | |
ctor () | |
Default constructor. | |
new () | |
Default constructor. | |
virtual | ~VBox () |
Default destructor. | |
Public Member Functions inherited from Layout | |
Layout () | |
Default constructor. | |
virtual | ~Layout () |
Default destructor. | |
void | setBackGroundImage (const std::string &fileName, TextureResType texType=TextureResType::LOCAL) |
Sets a background image for layout. More... | |
var | setBackGroundImage ( var fileName, var LOCAL) |
Sets a background image for layout. More... | |
local | setBackGroundImage ( local fileName, local LOCAL) |
Sets a background image for layout. More... | |
void | setBackGroundImageCapInsets (const Rect &capInsets) |
Sets a background image capInsets for layout, it only affects the scale9 enabled background image The capInsets in Rect. | |
var | setBackGroundImageCapInsets ( var capInsets) |
Sets a background image capInsets for layout, it only affects the scale9 enabled background image The capInsets in Rect. | |
local | setBackGroundImageCapInsets ( local capInsets) |
Sets a background image capInsets for layout, it only affects the scale9 enabled background image The capInsets in Rect. | |
const Rect & | getBackGroundImageCapInsets () const |
Query background image's capInsets size. More... | |
var | getBackGroundImageCapInsets () |
Query background image's capInsets size. More... | |
local | getBackGroundImageCapInsets () |
Query background image's capInsets size. More... | |
void | setBackGroundColorType (BackGroundColorType type) |
Sets Color Type for layout's background. | |
var | setBackGroundColorType ( var type) |
Sets Color Type for layout's background. | |
local | setBackGroundColorType ( local type) |
Sets Color Type for layout's background. | |
BackGroundColorType | getBackGroundColorType () const |
Query the layout's background color type. More... | |
local | getBackGroundColorType () |
Query the layout's background color type. More... | |
void | setBackGroundImageScale9Enabled (bool enabled) |
Enable background image scale9 rendering. More... | |
bool | isBackGroundImageScale9Enabled () const |
Query background image scale9 enable status. More... | |
var | isBackGroundImageScale9Enabled () |
Query background image scale9 enable status. More... | |
local | isBackGroundImageScale9Enabled () |
Query background image scale9 enable status. More... | |
void | setBackGroundColor (const Color3B &color) |
Set background color for layout The color only applies to layout when it's color type is BackGroundColorType::SOLID. More... | |
var | setBackGroundColor ( var color) |
Set background color for layout The color only applies to layout when it's color type is BackGroundColorType::SOLID. More... | |
const Color3B & | getBackGroundColor () const |
Query the layout's background color. More... | |
var | getBackGroundColor () |
Query the layout's background color. More... | |
local | getBackGroundColor () |
Query the layout's background color. More... | |
void | setBackGroundColor (const Color3B &startColor, const Color3B &endColor) |
Set start and end background color for layout. More... | |
var | setBackGroundColor ( var startColor, var endColor) |
Set start and end background color for layout. More... | |
local | setBackGroundColor ( local startColor, local endColor) |
Set start and end background color for layout. More... | |
const Color3B & | getBackGroundStartColor () const |
Get the gradient background start color. More... | |
var | getBackGroundStartColor () |
Get the gradient background start color. More... | |
local | getBackGroundStartColor () |
Get the gradient background start color. More... | |
const Color3B & | getBackGroundEndColor () const |
Get the gradient background end color. More... | |
var | getBackGroundEndColor () |
Get the gradient background end color. More... | |
local | getBackGroundEndColor () |
Get the gradient background end color. More... | |
void | setBackGroundColorOpacity (GLubyte opacity) |
Sets background color opacity of layout. More... | |
var | setBackGroundColorOpacity ( var opacity) |
Sets background color opacity of layout. More... | |
local | setBackGroundColorOpacity ( local opacity) |
Sets background color opacity of layout. More... | |
GLubyte | getBackGroundColorOpacity () const |
Get the layout's background color opacity. More... | |
var | getBackGroundColorOpacity () |
Get the layout's background color opacity. More... | |
local | getBackGroundColorOpacity () |
Get the layout's background color opacity. More... | |
void | setBackGroundColorVector (const Vec2 &vector) |
Sets background color vector for layout. More... | |
var | setBackGroundColorVector ( var vector) |
Sets background color vector for layout. More... | |
local | setBackGroundColorVector ( local vector) |
Sets background color vector for layout. More... | |
const Vec2 & | getBackGroundColorVector () const |
Get the layout's background color vector. More... | |
var | getBackGroundColorVector () |
Get the layout's background color vector. More... | |
local | getBackGroundColorVector () |
Get the layout's background color vector. More... | |
void | setBackGroundImageColor (const Color3B &color) |
Set layout's background image color. More... | |
var | setBackGroundImageColor ( var color) |
Set layout's background image color. More... | |
local | setBackGroundImageColor ( local color) |
Set layout's background image color. More... | |
void | setBackGroundImageOpacity (GLubyte opacity) |
Set opacity of background image. More... | |
var | setBackGroundImageOpacity ( var opacity) |
Set opacity of background image. More... | |
local | setBackGroundImageOpacity ( local opacity) |
Set opacity of background image. More... | |
const Color3B & | getBackGroundImageColor () const |
Get color of layout's background image. More... | |
var | getBackGroundImageColor () |
Get color of layout's background image. More... | |
local | getBackGroundImageColor () |
Get color of layout's background image. More... | |
GLubyte | getBackGroundImageOpacity () const |
Get the opacity of layout's background image. More... | |
var | getBackGroundImageOpacity () |
Get the opacity of layout's background image. More... | |
local | getBackGroundImageOpacity () |
Get the opacity of layout's background image. More... | |
void | removeBackGroundImage () |
Remove the background image of layout. | |
var | removeBackGroundImage () |
Remove the background image of layout. | |
local | removeBackGroundImage () |
Remove the background image of layout. | |
const Size & | getBackGroundImageTextureSize () const |
Gets background image texture size. More... | |
var | getBackGroundImageTextureSize () |
Gets background image texture size. More... | |
local | getBackGroundImageTextureSize () |
Gets background image texture size. More... | |
virtual void | setClippingEnabled (bool enabled) |
Toggle layout clipping. More... | |
var | setClippingEnabled ( var enabled) |
Toggle layout clipping. More... | |
local | setClippingEnabled ( local enabled) |
Toggle layout clipping. More... | |
void | setClippingType (ClippingType type) |
Change the clipping type of layout. More... | |
ClippingType | getClippingType () const |
virtual bool | isClippingEnabled () const |
Gets if layout is clipping enabled. More... | |
local | isClippingEnabled () |
Gets if layout is clipping enabled. More... | |
virtual std::string | getDescription () const override |
Returns the "class name" of widget. | |
var | getDescription () |
Returns the "class name" of widget. | |
local | getDescription () |
Returns the "class name" of widget. | |
virtual void | setLayoutType (Type type) |
Change the layout type. More... | |
var | setLayoutType ( var type) |
Change the layout type. More... | |
local | setLayoutType ( local type) |
Change the layout type. More... | |
virtual Type | getLayoutType () const |
Query layout type. More... | |
var | getLayoutType () |
Query layout type. More... | |
local | getLayoutType () |
Query layout type. More... | |
virtual void | addChild (Node *child) override |
Adds a child to the container with z-order as 0. More... | |
var | addChild ( var child) |
Adds a child to the container with z-order as 0. More... | |
local | addChild ( local child) |
Adds a child to the container with z-order as 0. More... | |
virtual void | addChild (Node *child, int localZOrder) override |
Adds a child to the container with a local z-order. More... | |
virtual void | addChild (Node *child, int localZOrder, int tag) override |
Adds a child to the container with z order and tag If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately. More... | |
local | addChild ( local child, local localZOrder, local tag) |
Adds a child to the container with z order and tag If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately. More... | |
virtual void | addChild (Node *child, int localZOrder, const std::string &name) override |
Adds a child to the container with z order and tag. More... | |
virtual void | visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override |
Visits this node's children and send their render command recursively. More... | |
local | visit ( local renderer, local parentTransform, local parentFlags) |
Visits this node's children and send their render command recursively. More... | |
virtual void | removeChild (Node *child, bool cleanup=true) override |
Removes a child from the container. More... | |
virtual void | removeAllChildren () override |
Removes all children from the container with a cleanup. | |
local | removeAllChildren () |
Removes all children from the container with a cleanup. | |
virtual void | removeAllChildrenWithCleanup (bool cleanup) override |
Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More... | |
local | removeAllChildren ( local cleanup) |
Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More... | |
virtual void | forceDoLayout () |
force refresh widget layout | |
virtual void | requestDoLayout () |
request to refresh widget layout | |
var | requestDoLayout () |
request to refresh widget layout | |
local | requestDoLayout () |
request to refresh widget layout | |
virtual void | onEnter () override |
Event callback that is invoked every time when Node enters the 'stage'. More... | |
virtual void | onExit () override |
Event callback that is invoked every time the Node leaves the 'stage'. More... | |
void | setLoopFocus (bool loop) |
If a layout is loop focused which means that the focus movement will be inside the layout pass true to let the focus movement loop inside the layout. | |
var | setLoopFocus ( var loop) |
If a layout is loop focused which means that the focus movement will be inside the layout pass true to let the focus movement loop inside the layout. | |
local | setLoopFocus ( local loop) |
If a layout is loop focused which means that the focus movement will be inside the layout pass true to let the focus movement loop inside the layout. | |
bool | isLoopFocus () const |
var | isLoopFocus () |
local | isLoopFocus () |
void | setPassFocusToChild (bool pass) |
var | setPassFocusToChild ( var pass) |
local | setPassFocusToChild ( local pass) |
bool | isPassFocusToChild () const |
var | isPassFocusToChild () |
local | isPassFocusToChild () |
virtual Widget * | findNextFocusedWidget (FocusDirection direction, Widget *current) override |
When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More... | |
var | findNextFocusedWidget ( var direction, var current) |
When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More... | |
local | findNextFocusedWidget ( local direction, local current) |
When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More... | |
virtual void | setCameraMask (unsigned short mask, bool applyChildren=true) override |
Override function. More... | |
ResourceData | getRenderFile () |
Return background image file name and type. | |
var | getRenderFile () |
Return background image file name and type. | |
local | getRenderFile () |
Return background image file name and type. | |
Public Member Functions inherited from Widget | |
Widget (void) | |
Default constructor. | |
ctor () | |
Default constructor. | |
new () | |
Default constructor. | |
virtual | ~Widget () |
Default destructor. | |
virtual void | setEnabled (bool enabled) |
Sets whether the widget is enabled. More... | |
local | setEnabled ( local enabled) |
Sets whether the widget is enabled. More... | |
bool | isEnabled () const |
Determines if the widget is enabled or not. More... | |
void | setBright (bool bright) |
Sets whether the widget is bright The default value is true, a widget is default to bright. More... | |
bool | isBright () const |
Determines if the widget is bright. More... | |
virtual void | setTouchEnabled (bool enabled) |
Sets whether the widget is touch enabled. More... | |
local | setTouchEnabled ( local enabled) |
Sets whether the widget is touch enabled. More... | |
void | setBrightStyle (BrightStyle style) |
To set the bright style of widget. More... | |
var | setBrightStyle ( var style) |
To set the bright style of widget. More... | |
local | setBrightStyle ( local style) |
To set the bright style of widget. More... | |
bool | isTouchEnabled () const |
Determines if the widget is touch enabled. More... | |
bool | isHighlighted () const |
Determines if the widget is highlighted. More... | |
void | setHighlighted (bool highlight) |
Sets whether the widget is highlighted. More... | |
var | setHighlighted ( var highlight) |
Sets whether the widget is highlighted. More... | |
local | setHighlighted ( local highlight) |
Sets whether the widget is highlighted. More... | |
float | getLeftInParent () |
Gets the left boundary position of this widget in parent's coordination system. More... | |
float | getLeftBoundary () const |
Gets the left boundary position of this widget in parent's coordination system. More... | |
float | getBottomInParent () |
Gets the bottom boundary position of this widget in parent's coordination system. More... | |
float | getBottomBoundary () const |
Gets the bottom boundary position of this widget in parent's coordination system. More... | |
float | getRightInParent () |
Gets the right boundary position of this widget in parent's coordination system. More... | |
float | getRightBoundary () const |
Gets the right boundary position of this widget in parent's coordination system. More... | |
float | getTopInParent () |
Gets the top boundary position of this widget in parent's coordination system. More... | |
float | getTopBoundary () const |
Gets the top boundary position of this widget in parent's coordination system. More... | |
void | addTouchEventListener (Ref *target, SEL_TouchEvent selector) |
Sets the touch event target/selector to the widget. | |
var | addTouchEventListener ( var target, var selector) |
Sets the touch event target/selector to the widget. | |
local | addTouchEventListener ( local target, local selector) |
Sets the touch event target/selector to the widget. | |
void | addTouchEventListener (const ccWidgetTouchCallback &callback) |
Set a callback to touch vent listener. More... | |
var | addTouchEventListener ( var callback) |
Set a callback to touch vent listener. More... | |
local | addTouchEventListener ( local callback) |
Set a callback to touch vent listener. More... | |
void | addClickEventListener (const ccWidgetClickCallback &callback) |
Set a click event handler to the widget. More... | |
virtual void | addCCSEventListener (const ccWidgetEventCallback &callback) |
Set a event handler to the widget in order to use cocostudio editor and framework The callback in ccWidgetEventCallback . | |
var | addCCSEventListener ( var callback) |
Set a event handler to the widget in order to use cocostudio editor and framework The callback in ccWidgetEventCallback . | |
virtual void | setPosition (const Vec2 &pos) override |
Changes the position (x,y) of the widget in OpenGL coordinates. More... | |
void | setPositionPercent (const Vec2 &percent) |
Set the percent(x,y) of the widget in OpenGL coordinates. More... | |
var | setPositionPercent ( var percent) |
Set the percent(x,y) of the widget in OpenGL coordinates. More... | |
local | setPositionPercent ( local percent) |
Set the percent(x,y) of the widget in OpenGL coordinates. More... | |
const Vec2 & | getPositionPercent () |
Gets the percent (x,y) of the widget in OpenGL coordinates. More... | |
var | getPositionPercent () |
Gets the percent (x,y) of the widget in OpenGL coordinates. More... | |
local | getPositionPercent () |
Gets the percent (x,y) of the widget in OpenGL coordinates. More... | |
void | setPositionType (PositionType type) |
Changes the position type of the widget. More... | |
var | setPositionType ( var type) |
Changes the position type of the widget. More... | |
local | setPositionType ( local type) |
Changes the position type of the widget. More... | |
PositionType | getPositionType () const |
Gets the position type of the widget. More... | |
var | getPositionType () |
Gets the position type of the widget. More... | |
local | getPositionType () |
Gets the position type of the widget. More... | |
virtual void | setFlippedX (bool flippedX) |
Sets whether the widget should be flipped horizontally or not. More... | |
local | setFlippedX ( local flippedX) |
Sets whether the widget should be flipped horizontally or not. More... | |
virtual bool | isFlippedX () const |
Returns the flag which indicates whether the widget is flipped horizontally or not. More... | |
virtual void | setFlippedY (bool flippedY) |
Sets whether the widget should be flipped vertically or not. More... | |
var | setFlippedY ( var flippedY) |
Sets whether the widget should be flipped vertically or not. More... | |
local | setFlippedY ( local flippedY) |
Sets whether the widget should be flipped vertically or not. More... | |
virtual bool | isFlippedY () const |
Return the flag which indicates whether the widget is flipped vertically or not. More... | |
bool | isFlipX () |
var | isFlipX () |
local | isFlipX () |
void | setFlipX (bool flipX) |
bool | isFlipY () |
void | setFlipY (bool flipY) |
var | setFlipY ( var flipY) |
local | setFlipY ( local flipY) |
virtual void | setScaleX (float scaleX) override |
Sets the scale (x) of the node. More... | |
var | setScaleX ( var scaleX) |
Sets the scale (x) of the node. More... | |
local | setScaleX ( local scaleX) |
Sets the scale (x) of the node. More... | |
virtual void | setScaleY (float scaleY) override |
Sets the scale (y) of the node. More... | |
var | setScaleY ( var scaleY) |
Sets the scale (y) of the node. More... | |
local | setScaleY ( local scaleY) |
Sets the scale (y) of the node. More... | |
virtual void | setScale (float scale) override |
Sets the scale (x,y,z) of the node. More... | |
local | setScale ( local scale) |
Sets the scale (x,y,z) of the node. More... | |
virtual void | setScale (float scalex, float scaley) override |
Sets the scale (x,y) of the node. More... | |
virtual float | getScaleX () const override |
Returns the scale factor on X axis of this node The scale factor on X axis. | |
var | getScaleX () |
Returns the scale factor on X axis of this node The scale factor on X axis. | |
local | getScaleX () |
Returns the scale factor on X axis of this node The scale factor on X axis. | |
virtual float | getScaleY () const override |
Returns the scale factor on Y axis of this node The scale factor on Y axis. | |
local | getScaleY () |
Returns the scale factor on Y axis of this node The scale factor on Y axis. | |
virtual float | getScale () const override |
Gets the scale factor of the node, when X and Y have the same scale factor. More... | |
var | getScale () |
Gets the scale factor of the node, when X and Y have the same scale factor. More... | |
local | getScale () |
Gets the scale factor of the node, when X and Y have the same scale factor. More... | |
bool | clippingParentAreaContainPoint (const Vec2 &pt) |
Checks a point if in parent's area. More... | |
var | clippingParentAreaContainPoint ( var pt) |
Checks a point if in parent's area. More... | |
local | clippingParentAreaContainPoint ( local pt) |
Checks a point if in parent's area. More... | |
bool | isClippingParentContainsPoint (const Vec2 &pt) |
Checks a point if in parent's area. More... | |
var | isClippingParentContainsPoint ( var pt) |
Checks a point if in parent's area. More... | |
local | isClippingParentContainsPoint ( local pt) |
Checks a point if in parent's area. More... | |
const Vec2 & | getTouchStartPos () const |
Gets the touch began point of widget when widget is selected. More... | |
var | getTouchStartPos () |
Gets the touch began point of widget when widget is selected. More... | |
local | getTouchStartPos () |
Gets the touch began point of widget when widget is selected. More... | |
const Vec2 & | getTouchBeganPosition () const |
Gets the touch began point of widget when widget is selected. More... | |
local | getTouchBeganPosition () |
Gets the touch began point of widget when widget is selected. More... | |
virtual void | setSize (const Size &size) |
Changes the widget's size Widget's size. | |
virtual void | setContentSize (const Size &contentSize) override |
Changes the widget's size Widget's size. | |
var | setContentSize ( var contentSize) |
Changes the widget's size Widget's size. | |
local | setContentSize ( local contentSize) |
Changes the widget's size Widget's size. | |
virtual void | setSizePercent (const Vec2 &percent) |
Changes the widget's size in percentage Widget's size in percentage. | |
void | setSizeType (SizeType type) |
Changes the size type of widget. More... | |
SizeType | getSizeType () const |
Gets the size type of widget. More... | |
var | getSizeType () |
Gets the size type of widget. More... | |
local | getSizeType () |
Gets the size type of widget. More... | |
const Size & | getSize () const |
Get the size of widget Widget content size. | |
var | getSize () |
Get the size of widget Widget content size. | |
local | getSize () |
Get the size of widget Widget content size. | |
const Size & | getCustomSize () const |
Get the user defined widget size. More... | |
var | getCustomSize () |
Get the user defined widget size. More... | |
local | getCustomSize () |
Get the user defined widget size. More... | |
virtual const Size & | getLayoutSize () |
Get the content size of widget. More... | |
var | getLayoutSize () |
Get the content size of widget. More... | |
local | getLayoutSize () |
Get the content size of widget. More... | |
const Vec2 & | getSizePercent () |
Get size percent of widget. More... | |
var | getSizePercent () |
Get size percent of widget. More... | |
local | getSizePercent () |
Get size percent of widget. More... | |
virtual bool | hitTest (const Vec2 &pt, const Camera *camera, Vec3 *p) const |
Checks a point is in widget's content space. More... | |
virtual bool | onTouchBegan (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch began event is issued. More... | |
virtual void | onTouchMoved (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch moved event is issued. More... | |
virtual void | onTouchEnded (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch ended event is issued. More... | |
virtual void | onTouchCancelled (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch cancelled event is issued. More... | |
var | onTouchCancelled ( var touch, var unusedEvent) |
A callback which will be called when touch cancelled event is issued. More... | |
local | onTouchCancelled ( local touch, local unusedEvent) |
A callback which will be called when touch cancelled event is issued. More... | |
void | setLayoutParameter (LayoutParameter *parameter) |
Sets a LayoutParameter to widget. More... | |
var | setLayoutParameter ( var parameter) |
Sets a LayoutParameter to widget. More... | |
local | setLayoutParameter ( local parameter) |
Sets a LayoutParameter to widget. More... | |
LayoutParameter * | getLayoutParameter () const override |
Gets LayoutParameter of widget. More... | |
var | getLayoutParameter () |
Gets LayoutParameter of widget. More... | |
local | getLayoutParameter () |
Gets LayoutParameter of widget. More... | |
LayoutParameter * | getLayoutParameter (LayoutParameter::Type type) |
Gets LayoutParameter of widget. More... | |
var | getLayoutParameter ( var type) |
Gets LayoutParameter of widget. More... | |
local | getLayoutParameter ( local type) |
Gets LayoutParameter of widget. More... | |
virtual void | ignoreContentAdaptWithSize (bool ignore) |
Toggle whether ignore user defined content size for widget. More... | |
var | ignoreContentAdaptWithSize ( var ignore) |
Toggle whether ignore user defined content size for widget. More... | |
local | ignoreContentAdaptWithSize ( local ignore) |
Toggle whether ignore user defined content size for widget. More... | |
bool | isIgnoreContentAdaptWithSize () const |
Query whether the widget ignores user defined content size or not True means ignore user defined content size, false otherwise. | |
var | isIgnoreContentAdaptWithSize () |
Query whether the widget ignores user defined content size or not True means ignore user defined content size, false otherwise. | |
local | isIgnoreContentAdaptWithSize () |
Query whether the widget ignores user defined content size or not True means ignore user defined content size, false otherwise. | |
Vec2 | getWorldPosition () const |
Gets position of widget in world space. More... | |
virtual Node * | getVirtualRenderer () |
Gets the inner Renderer node of widget. More... | |
virtual Size | getVirtualRendererSize () const |
Get the virtual renderer's size Widget virtual renderer size. | |
Widget * | clone () |
Create a new widget copy of the original one. More... | |
var | clone () |
Create a new widget copy of the original one. More... | |
local | clone () |
Create a new widget copy of the original one. More... | |
void | updateSizeAndPosition () |
Update all children's contents size and position recursively. | |
var | updateSizeAndPosition () |
Update all children's contents size and position recursively. | |
local | updateSizeAndPosition () |
Update all children's contents size and position recursively. | |
void | updateSizeAndPosition (const Size &parentSize) |
Update all children's contents size and position recursively. | |
var | updateSizeAndPosition ( var parentSize) |
Update all children's contents size and position recursively. | |
local | updateSizeAndPosition ( local parentSize) |
Update all children's contents size and position recursively. | |
void | setActionTag (int tag) |
Set the tag of action. More... | |
int | getActionTag () const |
Get the action tag. More... | |
var | getActionTag () |
Get the action tag. More... | |
local | getActionTag () |
Get the action tag. More... | |
void | setPropagateTouchEvents (bool isPropagate) |
Allow widget touch events to propagate to its parents. More... | |
var | setPropagateTouchEvents ( var isPropagate) |
Allow widget touch events to propagate to its parents. More... | |
local | setPropagateTouchEvents ( local isPropagate) |
Allow widget touch events to propagate to its parents. More... | |
bool | isPropagateTouchEvents () const |
Return whether the widget is propagate touch events to its parents or not whether touch event propagation is allowed or not. | |
var | isPropagateTouchEvents () |
Return whether the widget is propagate touch events to its parents or not whether touch event propagation is allowed or not. | |
local | isPropagateTouchEvents () |
Return whether the widget is propagate touch events to its parents or not whether touch event propagation is allowed or not. | |
void | setSwallowTouches (bool swallow) |
Toggle widget to swallow touches or not. More... | |
bool | isSwallowTouches () const |
Return whether the widget is swallowing touch or not Whether touch is swallowed. | |
bool | isFocused () const |
Query whether widget is focused or not. More... | |
void | setFocused (bool focus) |
Toggle widget focus status. More... | |
var | setFocused ( var focus) |
Toggle widget focus status. More... | |
local | setFocused ( local focus) |
Toggle widget focus status. More... | |
bool | isFocusEnabled () const |
Query widget's focus enable state. More... | |
void | setFocusEnabled (bool enable) |
Allow widget to accept focus. More... | |
var | setFocusEnabled ( var enable) |
Allow widget to accept focus. More... | |
local | setFocusEnabled ( local enable) |
Allow widget to accept focus. More... | |
void | requestFocus () |
when a widget calls this method, it will get focus immediately. | |
Widget * | getCurrentFocusedWidget (bool isWidget) |
Return a current focused widget in your UI scene. More... | |
local | getCurrentFocusedWidget ( local isWidget) |
Return a current focused widget in your UI scene. More... | |
void | setUnifySizeEnabled (bool enable) |
Toggle use unify size. More... | |
var | setUnifySizeEnabled ( var enable) |
Toggle use unify size. More... | |
local | setUnifySizeEnabled ( local enable) |
Toggle use unify size. More... | |
bool | isUnifySizeEnabled () const |
Query whether unify size enable state. More... | |
void | setCallbackName (const std::string &callbackName) |
Set callback name. More... | |
var | setCallbackName ( var callbackName) |
Set callback name. More... | |
local | setCallbackName ( local callbackName) |
Set callback name. More... | |
const std::string & | getCallbackName () const |
Query callback name. More... | |
void | setCallbackType (const std::string &callbackType) |
Set callback type. More... | |
var | setCallbackType ( var callbackType) |
Set callback type. More... | |
local | setCallbackType ( local callbackType) |
Set callback type. More... | |
const std::string & | getCallbackType () const |
Query callback type. More... | |
local | getCallbackType () |
Query callback type. More... | |
void | setLayoutComponentEnabled (bool enable) |
Toggle layout component enable. More... | |
var | setLayoutComponentEnabled ( var enable) |
Toggle layout component enable. More... | |
local | setLayoutComponentEnabled ( local enable) |
Toggle layout component enable. More... | |
bool | isLayoutComponentEnabled () const |
Query whether layout component is enabled or not. More... | |
var | isLayoutComponentEnabled () |
Query whether layout component is enabled or not. More... | |
local | isLayoutComponentEnabled () |
Query whether layout component is enabled or not. More... | |
Public Member Functions inherited from ProtectedNode | |
virtual void | cleanup () override |
Stops and removes all running actions and schedulers. | |
virtual void | onEnterTransitionDidFinish () override |
Event callback that is invoked when the Node enters in the 'stage'. More... | |
local | onEnterTransitionDidFinish () |
Event callback that is invoked when the Node enters in the 'stage'. More... | |
virtual void | onExitTransitionDidStart () override |
Event callback that is called every time the Node leaves the 'stage'. More... | |
local | onExitTransitionDidStart () |
Event callback that is called every time the Node leaves the 'stage'. More... | |
virtual void | addProtectedChild (Node *child) |
Adds a child to the container with z-order as 0. More... | |
var | addProtectedChild ( var child) |
Adds a child to the container with z-order as 0. More... | |
local | addProtectedChild ( local child) |
Adds a child to the container with z-order as 0. More... | |
virtual void | addProtectedChild (Node *child, int localZOrder) |
Adds a child to the container with a local z-order. More... | |
local | addProtectedChild ( local child, local localZOrder) |
Adds a child to the container with a local z-order. More... | |
virtual void | addProtectedChild (Node *child, int localZOrder, int tag) |
Adds a child to the container with z order and tag. More... | |
var | addProtectedChild ( var child, var localZOrder, var tag) |
Adds a child to the container with z order and tag. More... | |
local | addProtectedChild ( local child, local localZOrder, local tag) |
Adds a child to the container with z order and tag. More... | |
virtual Node * | getProtectedChildByTag (int tag) |
Gets a child from the container with its tag. More... | |
virtual void | removeProtectedChild (Node *child, bool cleanup=true) |
Removes a child from the container. More... | |
var | removeProtectedChild ( var child, var true) |
Removes a child from the container. More... | |
local | removeProtectedChild ( local child, local true) |
Removes a child from the container. More... | |
virtual void | removeProtectedChildByTag (int tag, bool cleanup=true) |
Removes a child from the container by tag value. More... | |
local | removeProtectedChildByTag ( local tag, local true) |
Removes a child from the container by tag value. More... | |
virtual void | removeAllProtectedChildren () |
Removes all children from the container with a cleanup. | |
virtual void | removeAllProtectedChildrenWithCleanup (bool cleanup) |
Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More... | |
virtual void | reorderProtectedChild (Node *child, int localZOrder) |
Reorders a child according to a new z value. More... | |
var | reorderProtectedChild ( var child, var localZOrder) |
Reorders a child according to a new z value. More... | |
local | reorderProtectedChild ( local child, local localZOrder) |
Reorders a child according to a new z value. More... | |
virtual void | sortAllProtectedChildren () |
Sorts the children array once before drawing, instead of every time when a child is added or reordered. More... | |
var | sortAllProtectedChildren () |
Sorts the children array once before drawing, instead of every time when a child is added or reordered. More... | |
local | sortAllProtectedChildren () |
Sorts the children array once before drawing, instead of every time when a child is added or reordered. More... | |
Public Member Functions inherited from Node | |
virtual bool | isRunning () const |
Returns whether or not the node is "running". More... | |
var | isRunning () |
Returns whether or not the node is "running". More... | |
local | isRunning () |
Returns whether or not the node is "running". More... | |
void | scheduleUpdateWithPriorityLua (int handler, int priority) |
Schedules for lua script. More... | |
local | scheduleUpdateWithPriorityLua ( local handler, local priority) |
Schedules for lua script. More... | |
virtual void | draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) |
Override this method to draw your own node. More... | |
local | draw ( local renderer, local transform, local flags) |
Override this method to draw your own node. More... | |
virtual Scene * | getScene () const |
Returns the Scene that contains the Node. More... | |
virtual Rect | getBoundingBox () const |
Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More... | |
virtual Rect | boundingBox () const |
local | boundingBox () |
virtual void | setEventDispatcher (EventDispatcher *dispatcher) |
Set event dispatcher for node. More... | |
virtual EventDispatcher * | getEventDispatcher () const |
Get the event dispatcher. More... | |
local | getEventDispatcher () |
Get the event dispatcher. More... | |
void | setPhysicsBody (PhysicsBody *body) |
Set the PhysicsBody that let the sprite effect with physics. More... | |
PhysicsBody * | getPhysicsBody () const |
Get the PhysicsBody the sprite have. More... | |
void | removeFromPhysicsWorld () |
Remove this node from physics world. More... | |
var | removeFromPhysicsWorld () |
Remove this node from physics world. More... | |
local | removeFromPhysicsWorld () |
Remove this node from physics world. More... | |
void | updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags) |
Update the transform matrix from physics. | |
var | updateTransformFromPhysics ( var parentTransform, var parentFlags) |
Update the transform matrix from physics. | |
local | updateTransformFromPhysics ( local parentTransform, local parentFlags) |
Update the transform matrix from physics. | |
virtual void | updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY) |
Update physics body transform matrix. | |
var | updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY) |
Update physics body transform matrix. | |
local | updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY) |
Update physics body transform matrix. | |
unsigned short | getCameraMask () const |
get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true | |
virtual void | setLocalZOrder (int localZOrder) |
LocalZOrder is the 'key' used to sort the node relative to its siblings. More... | |
virtual void | setZOrder (int localZOrder) |
virtual void | _setLocalZOrder (int z) |
local | _setLocalZOrder ( local z) |
virtual int | getLocalZOrder () const |
Gets the local Z order of this node. More... | |
var | getLocalZOrder () |
Gets the local Z order of this node. More... | |
local | getLocalZOrder () |
Gets the local Z order of this node. More... | |
virtual int | getZOrder () const |
virtual void | setGlobalZOrder (float globalZOrder) |
Defines the oder in which the nodes are renderer. More... | |
local | setGlobalZOrder ( local globalZOrder) |
Defines the oder in which the nodes are renderer. More... | |
virtual float | getGlobalZOrder () const |
Returns the Node's Global Z Order. More... | |
virtual void | setScaleZ (float scaleZ) |
Changes the scale factor on Z axis of this node. More... | |
local | setScaleZ ( local scaleZ) |
Changes the scale factor on Z axis of this node. More... | |
virtual float | getScaleZ () const |
Returns the scale factor on Z axis of this node The scale factor on Z axis. | |
virtual void | setNormalizedPosition (const Vec2 &position) |
Sets the position (x,y) using values between 0 and 1. More... | |
var | setNormalizedPosition ( var position) |
Sets the position (x,y) using values between 0 and 1. More... | |
local | setNormalizedPosition ( local position) |
Sets the position (x,y) using values between 0 and 1. More... | |
virtual const Vec2 & | getPosition () const |
Gets the position (x,y) of the node in its parent's coordinate system. More... | |
virtual const Vec2 & | getNormalizedPosition () const |
Returns the normalized position. More... | |
virtual void | setPosition (float x, float y) |
Sets the position (x,y) of the node in its parent's coordinate system. More... | |
var | setPosition ( var x, var y) |
Sets the position (x,y) of the node in its parent's coordinate system. More... | |
local | setPosition ( local x, local y) |
Sets the position (x,y) of the node in its parent's coordinate system. More... | |
virtual void | getPosition (float *x, float *y) const |
Gets position in a more efficient way, returns two number instead of a Vec2 object. More... | |
virtual void | setPositionX (float x) |
Sets the x coordinate of the node in its parent's coordinate system. More... | |
virtual float | getPositionX (void) const |
Gets the x coordinate of the node in its parent's coordinate system. More... | |
virtual void | setPositionY (float y) |
Sets the y coordinate of the node in its parent's coordinate system. More... | |
virtual float | getPositionY (void) const |
Gets the y coordinate of the node in its parent's coordinate system. More... | |
virtual void | setPosition3D (const Vec3 &position) |
Sets the position (X, Y, and Z) in its parent's coordinate system. More... | |
virtual Vec3 | getPosition3D () const |
Returns the position (X,Y,Z) in its parent's coordinate system. More... | |
virtual void | setPositionZ (float positionZ) |
Sets the 'z' coordinate in the position. More... | |
local | setPositionZ ( local positionZ) |
Sets the 'z' coordinate in the position. More... | |
virtual void | setVertexZ (float vertexZ) |
virtual float | getPositionZ () const |
Gets position Z coordinate of this node. More... | |
var | getVertexZ () |
Gets position Z coordinate of this node. More... | |
local | getPositionZ () |
Gets position Z coordinate of this node. More... | |
virtual float | getVertexZ () const |
virtual void | setSkewX (float skewX) |
Changes the X skew angle of the node in degrees. More... | |
local | setSkewX ( local skewX) |
Changes the X skew angle of the node in degrees. More... | |
virtual float | getSkewX () const |
Returns the X skew angle of the node in degrees. More... | |
var | getSkewX () |
Returns the X skew angle of the node in degrees. More... | |
local | getSkewX () |
Returns the X skew angle of the node in degrees. More... | |
virtual void | setSkewY (float skewY) |
Changes the Y skew angle of the node in degrees. More... | |
local | setSkewY ( local skewY) |
Changes the Y skew angle of the node in degrees. More... | |
virtual float | getSkewY () const |
Returns the Y skew angle of the node in degrees. More... | |
var | getSkewY () |
Returns the Y skew angle of the node in degrees. More... | |
local | getSkewY () |
Returns the Y skew angle of the node in degrees. More... | |
virtual void | setAnchorPoint (const Vec2 &anchorPoint) |
Sets the anchor point in percent. More... | |
local | setAnchorPoint ( local anchorPoint) |
Sets the anchor point in percent. More... | |
virtual const Vec2 & | getAnchorPoint () const |
Returns the anchor point in percent. More... | |
virtual const Vec2 & | getAnchorPointInPoints () const |
Returns the anchorPoint in absolute pixels. More... | |
virtual const Size & | getContentSize () const |
Returns the untransformed size of the node. More... | |
var | getContentSize () |
Returns the untransformed size of the node. More... | |
local | getContentSize () |
Returns the untransformed size of the node. More... | |
virtual void | setVisible (bool visible) |
Sets whether the node is visible. More... | |
local | setVisible ( local visible) |
Sets whether the node is visible. More... | |
virtual bool | isVisible () const |
Determines if the node is visible. More... | |
virtual void | setRotation (float rotation) |
Sets the rotation (angle) of the node in degrees. More... | |
local | setRotation ( local rotation) |
Sets the rotation (angle) of the node in degrees. More... | |
virtual float | getRotation () const |
Returns the rotation of the node in degrees. More... | |
var | getRotation () |
Returns the rotation of the node in degrees. More... | |
local | getRotation () |
Returns the rotation of the node in degrees. More... | |
virtual void | setRotation3D (const Vec3 &rotation) |
Sets the rotation (X,Y,Z) in degrees. More... | |
local | setRotation3D ( local rotation) |
Sets the rotation (X,Y,Z) in degrees. More... | |
virtual Vec3 | getRotation3D () const |
Returns the rotation (X,Y,Z) in degrees. More... | |
virtual void | setRotationQuat (const Quaternion &quat) |
Set rotation by quaternion. More... | |
local | setRotationQuat ( local quat) |
Set rotation by quaternion. More... | |
virtual Quaternion | getRotationQuat () const |
Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, The rotation in quaternion. | |
virtual void | setRotationSkewX (float rotationX) |
Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More... | |
local | setRotationSkewX ( local rotationX) |
Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More... | |
virtual void | setRotationX (float rotationX) |
var | setRotationX ( var rotationX) |
local | setRotationX ( local rotationX) |
virtual float | getRotationSkewX () const |
Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More... | |
local | getRotationSkewX () |
Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More... | |
virtual float | getRotationX () const |
virtual void | setRotationSkewY (float rotationY) |
Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More... | |
local | setRotationSkewY ( local rotationY) |
Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More... | |
virtual void | setRotationY (float rotationY) |
local | setRotationY ( local rotationY) |
virtual float | getRotationSkewY () const |
Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More... | |
local | getRotationSkewY () |
Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More... | |
virtual float | getRotationY () const |
void | setOrderOfArrival (int orderOfArrival) |
Sets the arrival order when this node has a same ZOrder with other children. More... | |
int | getOrderOfArrival () const |
Returns the arrival order, indicates which children is added previously. More... | |
void | setGLServerState (int serverState) |
var | setGLServerState ( var serverState) |
int | getGLServerState () const |
var | getGLServerState () |
virtual void | ignoreAnchorPointForPosition (bool ignore) |
Sets whether the anchor point will be (0,0) when you position this node. More... | |
virtual bool | isIgnoreAnchorPointForPosition () const |
Gets whether the anchor point will be (0,0) when you position this node. More... | |
virtual Node * | getChildByTag (int tag) const |
Gets a child from the container with its tag. More... | |
template<typename T > | |
T | getChildByTag (int tag) const |
Gets a child from the container with its tag that can be cast to Type T. More... | |
template<typename T > | |
var | getChildByTag ( var tag) |
Gets a child from the container with its tag that can be cast to Type T. More... | |
template<typename T > | |
local | getChildByTag ( local tag) |
Gets a child from the container with its tag that can be cast to Type T. More... | |
virtual Node * | getChildByName (const std::string &name) const |
Gets a child from the container with its name. More... | |
template<typename T > | |
T | getChildByName (const std::string &name) const |
Gets a child from the container with its name that can be cast to Type T. More... | |
virtual void | enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const |
Search the children of the receiving node to perform processing for nodes which share a name. More... | |
virtual Vector< Node * > & | getChildren () |
Returns the array of the node's children. More... | |
local | getChildren () |
Returns the array of the node's children. More... | |
virtual const Vector< Node * > & | getChildren () const |
local | getChildren () |
virtual ssize_t | getChildrenCount () const |
Returns the amount of children. More... | |
var | getChildrenCount () |
Returns the amount of children. More... | |
local | getChildrenCount () |
Returns the amount of children. More... | |
virtual void | setParent (Node *parent) |
Sets the parent node. More... | |
local | setParent ( local parent) |
Sets the parent node. More... | |
virtual Node * | getParent () |
Returns a pointer to the parent node. More... | |
virtual const Node * | getParent () const |
var | getParent () |
local | getParent () |
virtual void | removeFromParent () |
Removes this node itself from its parent node with a cleanup. More... | |
var | removeFromParent () |
Removes this node itself from its parent node with a cleanup. More... | |
local | removeFromParent () |
Removes this node itself from its parent node with a cleanup. More... | |
virtual void | removeFromParentAndCleanup (bool cleanup) |
Removes this node itself from its parent node. More... | |
local | removeFromParent ( local cleanup) |
Removes this node itself from its parent node. More... | |
virtual void | removeChildByTag (int tag, bool cleanup=true) |
Removes a child from the container by tag value. More... | |
var | removeChildByTag ( var tag, var true) |
Removes a child from the container by tag value. More... | |
local | removeChildByTag ( local tag, local true) |
Removes a child from the container by tag value. More... | |
virtual void | removeChildByName (const std::string &name, bool cleanup=true) |
Removes a child from the container by tag value. More... | |
var | removeChildByName ( var name, var true) |
Removes a child from the container by tag value. More... | |
local | removeChildByName ( local name, local true) |
Removes a child from the container by tag value. More... | |
virtual void | reorderChild (Node *child, int localZOrder) |
Reorders a child according to a new z value. More... | |
virtual void | sortAllChildren () |
Sorts the children array once before drawing, instead of every time when a child is added or reordered. More... | |
local | sortAllChildren () |
Sorts the children array once before drawing, instead of every time when a child is added or reordered. More... | |
virtual int | getTag () const |
Returns a tag that is used to identify the node easily. More... | |
var | getTag () |
Returns a tag that is used to identify the node easily. More... | |
local | getTag () |
Returns a tag that is used to identify the node easily. More... | |
virtual void | setTag (int tag) |
Changes the tag that is used to identify the node easily. More... | |
local | setTag ( local tag) |
Changes the tag that is used to identify the node easily. More... | |
virtual const std::string & | getName () const |
Returns a string that is used to identify the node. More... | |
local | getName () |
Returns a string that is used to identify the node. More... | |
virtual void | setName (const std::string &name) |
Changes the name that is used to identify the node easily. More... | |
var | setName ( var name) |
Changes the name that is used to identify the node easily. More... | |
local | setName ( local name) |
Changes the name that is used to identify the node easily. More... | |
virtual void * | getUserData () |
Returns a custom user data pointer. More... | |
virtual const void * | getUserData () const |
virtual void | setUserData (void *userData) |
Sets a custom user data pointer. More... | |
virtual Ref * | getUserObject () |
Returns a user assigned Object. More... | |
virtual const Ref * | getUserObject () const |
virtual void | setUserObject (Ref *userObject) |
Returns a user assigned Object. More... | |
local | setUserObject ( local userObject) |
Returns a user assigned Object. More... | |
GLProgram * | getGLProgram () const |
Return the GLProgram (shader) currently used for this node. More... | |
var | getGLProgram () |
Return the GLProgram (shader) currently used for this node. More... | |
local | getGLProgram () |
Return the GLProgram (shader) currently used for this node. More... | |
GLProgram * | getShaderProgram () const |
var | getShaderProgram () |
local | getShaderProgram () |
virtual void | setGLProgram (GLProgram *glprogram) |
Sets the shader program for this node. More... | |
local | setGLProgram ( local glprogram) |
Sets the shader program for this node. More... | |
void | setShaderProgram (GLProgram *glprogram) |
var | setShaderProgram ( var glprogram) |
local | setShaderProgram ( local glprogram) |
GLProgramState * | getGLProgramState () const |
Return the GLProgramState currently used for this node. More... | |
var | getGLProgramState () |
Return the GLProgramState currently used for this node. More... | |
local | getGLProgramState () |
Return the GLProgramState currently used for this node. More... | |
virtual void | setGLProgramState (GLProgramState *glProgramState) |
Set the GLProgramState for this node. More... | |
local | setGLProgramState ( local glProgramState) |
Set the GLProgramState for this node. More... | |
virtual void | setActionManager (ActionManager *actionManager) |
Sets the ActionManager object that is used by all actions. More... | |
var | setActionManager ( var actionManager) |
Sets the ActionManager object that is used by all actions. More... | |
local | setActionManager ( local actionManager) |
Sets the ActionManager object that is used by all actions. More... | |
virtual ActionManager * | getActionManager () |
Gets the ActionManager object that is used by all actions. More... | |
local | getActionManager () |
Gets the ActionManager object that is used by all actions. More... | |
virtual const ActionManager * | getActionManager () const |
local | getActionManager () |
virtual Action * | runAction (Action *action) |
Executes an action, and returns the action that is executed. More... | |
var | runAction ( var action) |
Executes an action, and returns the action that is executed. More... | |
local | runAction ( local action) |
Executes an action, and returns the action that is executed. More... | |
void | stopAllActions () |
Stops and removes all actions from the running action list . | |
var | stopAllActions () |
Stops and removes all actions from the running action list . | |
local | stopAllActions () |
Stops and removes all actions from the running action list . | |
void | stopAction (Action *action) |
Stops and removes an action from the running action list. More... | |
var | stopAction ( var action) |
Stops and removes an action from the running action list. More... | |
local | stopAction ( local action) |
Stops and removes an action from the running action list. More... | |
void | stopActionByTag (int tag) |
Removes an action from the running action list by its tag. More... | |
var | stopActionByTag ( var tag) |
Removes an action from the running action list by its tag. More... | |
local | stopActionByTag ( local tag) |
Removes an action from the running action list by its tag. More... | |
void | stopAllActionsByTag (int tag) |
Removes all actions from the running action list by its tag. More... | |
var | stopAllActionsByTag ( var tag) |
Removes all actions from the running action list by its tag. More... | |
local | stopAllActionsByTag ( local tag) |
Removes all actions from the running action list by its tag. More... | |
void | stopActionsByFlags (unsigned int flags) |
Removes all actions from the running action list by its flags. More... | |
Action * | getActionByTag (int tag) |
Gets an action from the running action list by its tag. More... | |
ssize_t | getNumberOfRunningActions () const |
Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More... | |
ssize_t | numberOfRunningActions () const |
local | numberOfRunningActions () |
virtual void | setScheduler (Scheduler *scheduler) |
Sets a Scheduler object that is used to schedule all "updates" and timers. More... | |
virtual Scheduler * | getScheduler () |
Gets a Sheduler object. More... | |
virtual const Scheduler * | getScheduler () const |
local | getScheduler () |
bool | isScheduled (SEL_SCHEDULE selector) |
Checks whether a selector is scheduled. More... | |
bool | isScheduled (const std::string &key) |
Checks whether a lambda function is scheduled. More... | |
void | scheduleUpdate (void) |
Schedules the "update" method. More... | |
void | scheduleUpdateWithPriority (int priority) |
Schedules the "update" method with a custom priority. More... | |
void | unscheduleUpdate (void) |
void | schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay) |
Schedules a custom selector. More... | |
void | schedule (SEL_SCHEDULE selector, float interval) |
Schedules a custom selector with an interval time in seconds. More... | |
void | scheduleOnce (SEL_SCHEDULE selector, float delay) |
Schedules a selector that runs only once, with a delay of 0 or larger The SEL_SCHEDULE selector to be scheduled. More... | |
void | scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key) |
Schedules a lambda function that runs only once, with a delay of 0 or larger The lambda function to be scheduled. More... | |
void | schedule (SEL_SCHEDULE selector) |
Schedules a custom selector, the scheduled selector will be ticked every frame. More... | |
void | schedule (const std::function< void(float)> &callback, const std::string &key) |
Schedules a lambda function. More... | |
void | schedule (const std::function< void(float)> &callback, float interval, const std::string &key) |
Schedules a lambda function. More... | |
void | schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key) |
Schedules a lambda function. More... | |
var | schedule ( var callback, var interval, var repeat, var delay, var key) |
Schedules a lambda function. More... | |
void | unschedule (SEL_SCHEDULE selector) |
Unschedules a custom selector. More... | |
var | unschedule ( var selector) |
Unschedules a custom selector. More... | |
void | unschedule (const std::string &key) |
Unschedules a lambda function. More... | |
var | unschedule ( var key) |
Unschedules a lambda function. More... | |
void | unscheduleAllCallbacks () |
Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. | |
var | unscheduleAllCallbacks () |
Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. | |
void | unscheduleAllSelectors () |
var | unscheduleAllSelectors () |
local | unscheduleAllSelectors () |
virtual void | resume (void) |
Resumes all scheduled selectors, actions and event listeners. More... | |
local | resume () |
Resumes all scheduled selectors, actions and event listeners. More... | |
virtual void | pause (void) |
Pauses all scheduled selectors, actions and event listeners. More... | |
local | pause () |
Pauses all scheduled selectors, actions and event listeners. More... | |
void | resumeSchedulerAndActions () |
Resumes all scheduled selectors, actions and event listeners. More... | |
void | pauseSchedulerAndActions () |
Pauses all scheduled selectors, actions and event listeners. More... | |
var | pauseSchedulerAndActions () |
Pauses all scheduled selectors, actions and event listeners. More... | |
local | pauseSchedulerAndActions () |
Pauses all scheduled selectors, actions and event listeners. More... | |
virtual void | update (float delta) |
Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". | |
var | update ( var delta) |
Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". | |
local | update ( local delta) |
Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". | |
virtual void | updateTransform () |
Calls children's updateTransform() method recursively. More... | |
virtual const Mat4 & | getNodeToParentTransform () const |
Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
virtual AffineTransform | getNodeToParentAffineTransform () const |
local | getNodeToParentAffineTransform () |
virtual Mat4 | getNodeToParentTransform (Node *ancestor) const |
Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
local | getNodeToParentTransform ( local ancestor) |
Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
virtual AffineTransform | getNodeToParentAffineTransform (Node *ancestor) const |
Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
local | getNodeToParentAffineTransform ( local ancestor) |
Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
virtual void | setNodeToParentTransform (const Mat4 &transform) |
Sets the transformation matrix manually. More... | |
var | setNodeToParentTransform ( var transform) |
Sets the transformation matrix manually. More... | |
local | setNodeToParentTransform ( local transform) |
Sets the transformation matrix manually. More... | |
virtual AffineTransform | nodeToParentTransform () const |
local | nodeToParentTransform () |
virtual const Mat4 & | getParentToNodeTransform () const |
Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More... | |
var | getParentToNodeTransform () |
Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More... | |
local | getParentToNodeTransform () |
Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More... | |
virtual AffineTransform | getParentToNodeAffineTransform () const |
local | getParentToNodeAffineTransform () |
virtual AffineTransform | parentToNodeTransform () const |
local | parentToNodeTransform () |
virtual Mat4 | getNodeToWorldTransform () const |
Returns the world affine transform matrix. More... | |
var | getNodeToWorldTransform () |
Returns the world affine transform matrix. More... | |
local | getNodeToWorldTransform () |
Returns the world affine transform matrix. More... | |
virtual AffineTransform | getNodeToWorldAffineTransform () const |
local | getNodeToWorldAffineTransform () |
virtual AffineTransform | nodeToWorldTransform () const |
local | nodeToWorldTransform () |
virtual Mat4 | getWorldToNodeTransform () const |
Returns the inverse world affine transform matrix. More... | |
var | getWorldToNodeTransform () |
Returns the inverse world affine transform matrix. More... | |
local | getWorldToNodeTransform () |
Returns the inverse world affine transform matrix. More... | |
virtual AffineTransform | getWorldToNodeAffineTransform () const |
local | getWorldToNodeAffineTransform () |
virtual AffineTransform | worldToNodeTransform () const |
local | worldToNodeTransform () |
Vec2 | convertToNodeSpace (const Vec2 &worldPoint) const |
Converts a Vec2 to node (local) space coordinates. More... | |
Vec2 | convertToWorldSpace (const Vec2 &nodePoint) const |
Converts a Vec2 to world space coordinates. More... | |
Vec2 | convertToNodeSpaceAR (const Vec2 &worldPoint) const |
Converts a Vec2 to node (local) space coordinates. More... | |
Vec2 | convertToWorldSpaceAR (const Vec2 &nodePoint) const |
Converts a local Vec2 to world space coordinates.The result is in Points. More... | |
Vec2 | convertTouchToNodeSpace (Touch *touch) const |
Convenience methods which take a Touch instead of Vec2. More... | |
var | convertTouchToNodeSpace ( var touch) |
Convenience methods which take a Touch instead of Vec2. More... | |
local | convertTouchToNodeSpace ( local touch) |
Convenience methods which take a Touch instead of Vec2. More... | |
Vec2 | convertTouchToNodeSpaceAR (Touch *touch) const |
Converts a Touch (world coordinates) into a local coordinate. More... | |
void | setAdditionalTransform (Mat4 *additionalTransform) |
Sets an additional transform matrix to the node. More... | |
void | setAdditionalTransform (const AffineTransform &additionalTransform) |
var | setAdditionalTransform ( var additionalTransform) |
local | setAdditionalTransform ( local additionalTransform) |
Component * | getComponent (const std::string &name) |
Gets a component by its name. More... | |
var | getComponent ( var name) |
Gets a component by its name. More... | |
local | getComponent ( local name) |
Gets a component by its name. More... | |
virtual bool | addComponent (Component *component) |
Adds a component. More... | |
virtual bool | removeComponent (const std::string &name) |
Removes a component by its name. More... | |
local | removeComponent ( local name) |
Removes a component by its name. More... | |
virtual bool | removeComponent (Component *component) |
Removes a component by its pointer. More... | |
local | removeComponent ( local component) |
Removes a component by its pointer. More... | |
virtual void | removeAllComponents () |
Removes all components. | |
Public Member Functions inherited from Ref | |
void | retain () |
Retains the ownership. More... | |
local | retain () |
Retains the ownership. More... | |
void | release () |
Releases the ownership immediately. More... | |
Ref * | autorelease () |
Releases the ownership sometime soon automatically. More... | |
unsigned int | getReferenceCount () const |
Returns the Ref's current reference count. More... | |
local | getReferenceCount () |
Returns the Ref's current reference count. More... | |
virtual | ~Ref () |
Destructor. | |
Public Member Functions inherited from LayoutParameterProtocol | |
virtual | ~LayoutParameterProtocol () |
Default destructor. | |
local | ~LayoutParameterProtocol () |
Default destructor. | |
Static Public Member Functions | |
static VBox * | create () |
Create a empty VBox instance. More... | |
local | create () |
Create a empty VBox instance. More... | |
static VBox * | create (const Size &size) |
Create a VBox with a certain size. More... | |
var | create ( var size) |
Create a VBox with a certain size. More... | |
local | create ( local size) |
Create a VBox with a certain size. More... | |
Static Public Member Functions inherited from Layout | |
static Layout * | create () |
Create a empty layout. | |
var | create () |
Create a empty layout. | |
local | create () |
Create a empty layout. | |
Static Public Member Functions inherited from Widget | |
static Widget * | create () |
Create and return a empty Widget instance pointer. | |
var | create () |
Create and return a empty Widget instance pointer. | |
local | create () |
Create and return a empty Widget instance pointer. | |
static Widget * | getCurrentFocusedWidget () |
Return a current focused widget in your UI scene. More... | |
var | getCurrentFocusedWidget () |
Return a current focused widget in your UI scene. More... | |
local | getCurrentFocusedWidget () |
Return a current focused widget in your UI scene. More... | |
Static Public Member Functions inherited from ProtectedNode | |
static ProtectedNode * | create (void) |
Creates a ProtectedNode with no argument. More... | |
var | create () |
Creates a ProtectedNode with no argument. More... | |
local | create () |
Creates a ProtectedNode with no argument. More... | |
Static Public Member Functions inherited from Node | |
static Node * | create () |
Allocates and initializes a node. More... | |
var | create () |
Allocates and initializes a node. More... | |
local | create () |
Allocates and initializes a node. More... | |
Additional Inherited Members | |
Public Types inherited from Layout | |
enum | Type |
Layout type, default is ABSOLUTE. | |
enum | ClippingType |
Clipping Type, default is STENCIL. | |
enum | BackGroundColorType |
Background color type, default is NONE. | |
Public Types inherited from Widget | |
enum | FocusDirection |
Widget focus direction. | |
enum | PositionType |
Widget position type for layout. | |
enum | SizeType |
Widget size type for layout. | |
enum | TouchEventType |
Touch event type. | |
enum | TextureResType |
Texture resource type. More... | |
enum | BrightStyle |
Widget bright style. | |
typedef std::function< void(Ref *, Widget::TouchEventType)> | ccWidgetTouchCallback |
Widget touch event callback. | |
typedef std::function< void(Ref *)> | ccWidgetClickCallback |
Widget click event callback. | |
typedef std::function< void(Ref *, int)> | ccWidgetEventCallback |
Widget custom event callback. More... | |
Public Attributes inherited from Layout | |
std::function< int(FocusDirection, Widget *)> | onPassFocusToChild |
To specify a user-defined functor to decide which child widget of the layout should get focused the finding direction previous focused widget return the index of widget in the layout. | |
Public Attributes inherited from Widget | |
std::function< void(Widget *, Widget *)> | onFocusChanged |
When a widget lose/get focus, this method will be called. More... | |
std::function< Widget *(FocusDirection)> | onNextFocusedWidget |
Use this function to manually specify the next focused widget regards to each direction. | |
Public Attributes inherited from Ref | |
unsigned int | _ID |
object id, ScriptSupport need public _ID | |
local | _ID |
object id, ScriptSupport need public _ID | |
int | _luaID |
Lua reference id. | |
local | _luaID |
Lua reference id. | |
void * | _scriptObject |
scriptObject, support for swift | |
local | _scriptObject |
scriptObject, support for swift | |
bool | _rooted |
When true, it means that the object was already rooted. | |
local | _rooted |
When true, it means that the object was already rooted. | |
bool | _scriptOwned |
The life of the object is scrolled by the scripting engine. More... | |
local | _scriptOwned |
The life of the object is scrolled by the scripting engine. More... | |
Static Public Attributes inherited from Node | |
static const int | INVALID_TAG = -1 |
Default tag used for all the nodes. | |
var | INVALID_TAG = -1 |
Default tag used for all the nodes. | |
local | INVALID_TAG = -1 |
Default tag used for all the nodes. | |
Protected Member Functions inherited from Widget | |
void | propagateTouchEvent (TouchEventType event, Widget *sender, Touch *touch) |
Propagate touch events to its parents. | |
var | propagateTouchEvent ( var event, var sender, var touch) |
Propagate touch events to its parents. | |
local | propagateTouchEvent ( local event, local sender, local touch) |
Propagate touch events to its parents. | |
void | onFocusChange (Widget *widgetLostFocus, Widget *widgetGetFocus) |
This method is called when a focus change event happens The widget which lose its focus The widget which get its focus. | |
var | onFocusChange ( var widgetLostFocus, var widgetGetFocus) |
This method is called when a focus change event happens The widget which lose its focus The widget which get its focus. | |
local | onFocusChange ( local widgetLostFocus, local widgetGetFocus) |
This method is called when a focus change event happens The widget which lose its focus The widget which get its focus. | |
void | dispatchFocusEvent (Widget *widgetLoseFocus, Widget *widgetGetFocus) |
Dispatch a EventFocus through a EventDispatcher The widget which lose its focus The widget which get its focus. | |
VBox is just a convenient wrapper class for vertical layout type.
VBox lays out its children in a single vertical column.
|
static |
|
static |