cocos2d-x  3.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ScrollView Class Reference

#include <UIScrollView.h>

Inheritance diagram for ScrollView:
Layout Widget LayoutProtocol ProtectedNode LayoutParameterProtocol Node Ref ListView

Public Types

enum  Direction { NONE, VERTICAL, HORIZONTAL, BOTH }
 
enum  EventType {
  SCROLL_TO_TOP, SCROLL_TO_BOTTOM, SCROLL_TO_LEFT, SCROLL_TO_RIGHT,
  SCROLLING, BOUNCE_TOP, BOUNCE_BOTTOM, BOUNCE_LEFT,
  BOUNCE_RIGHT
}
 
typedef std::function< void(Ref
*, EventType)> 
ccScrollViewCallback
- Public Types inherited from Layout
enum  Type { ABSOLUTE, VERTICAL, HORIZONTAL, RELATIVE }
 
enum  ClippingType { STENCIL, SCISSOR }
 
enum  BackGroundColorType { NONE, SOLID, GRADIENT }
 
- Public Types inherited from Widget
enum  FocusDirection { LEFT, RIGHT, UP, DOWN }
 
enum  PositionType { ABSOLUTE, PERCENT }
 
enum  SizeType { ABSOLUTE, PERCENT }
 
enum  TouchEventType { BEGAN, MOVED, ENDED, CANCELED }
 
enum  TextureResType { LOCAL = 0, PLIST = 1 }
 
enum  BrightStyle { NONE = -1, NORMAL, HIGHLIGHT }
 
typedef std::function< void(Ref
*, Widget::TouchEventType)> 
ccWidgetTouchCallback
typedef std::function< void(Ref *)> ccWidgetClickCallback
typedef std::function< void(Ref
*, int)> 
ccWidgetEventCallback
- Public Types inherited from Node
enum  { FLAGS_TRANSFORM_DIRTY = (1 << 0), FLAGS_CONTENT_SIZE_DIRTY = (1 << 1), FLAGS_RENDER_AS_3D = (1 << 3), FLAGS_DIRTY_MASK = (FLAGS_TRANSFORM_DIRTY | FLAGS_CONTENT_SIZE_DIRTY) }
 

Public Member Functions

 ScrollView ()
 Default constructor. More...
 
virtual ~ScrollView ()
 Default destructor. More...
 
var ~ScrollView ()
 Default destructor. More...
 
local ~ScrollView ()
 Default destructor. More...
 
virtual void setDirection (Direction dir)
 Changes scroll direction of scrollview. More...
 
var setDirection ( var dir)
 Changes scroll direction of scrollview. More...
 
local setDirection ( local dir)
 Changes scroll direction of scrollview. More...
 
Direction getDirection () const
 Gets scroll direction of scrollview. More...
 
LayoutgetInnerContainer () const
 Gets inner container of scrollview. More...
 
void scrollToBottom (float time, bool attenuated)
 Scroll inner container to bottom boundary of scrollview. More...
 
var scrollToBottom ( var time, var attenuated)
 Scroll inner container to bottom boundary of scrollview. More...
 
local scrollToBottom ( local time, local attenuated)
 Scroll inner container to bottom boundary of scrollview. More...
 
void scrollToTop (float time, bool attenuated)
 Scroll inner container to top boundary of scrollview. More...
 
void scrollToLeft (float time, bool attenuated)
 Scroll inner container to left boundary of scrollview. More...
 
var scrollToLeft ( var time, var attenuated)
 Scroll inner container to left boundary of scrollview. More...
 
local scrollToLeft ( local time, local attenuated)
 Scroll inner container to left boundary of scrollview. More...
 
void scrollToRight (float time, bool attenuated)
 Scroll inner container to right boundary of scrollview. More...
 
var scrollToRight ( var time, var attenuated)
 Scroll inner container to right boundary of scrollview. More...
 
local scrollToRight ( local time, local attenuated)
 Scroll inner container to right boundary of scrollview. More...
 
void scrollToTopLeft (float time, bool attenuated)
 Scroll inner container to top and left boundary of scrollview. More...
 
var scrollToTopLeft ( var time, var attenuated)
 Scroll inner container to top and left boundary of scrollview. More...
 
local scrollToTopLeft ( local time, local attenuated)
 Scroll inner container to top and left boundary of scrollview. More...
 
void scrollToTopRight (float time, bool attenuated)
 Scroll inner container to top and right boundary of scrollview. More...
 
void scrollToBottomLeft (float time, bool attenuated)
 Scroll inner container to bottom and left boundary of scrollview. More...
 
void scrollToBottomRight (float time, bool attenuated)
 Scroll inner container to bottom and right boundary of scrollview. More...
 
void scrollToPercentVertical (float percent, float time, bool attenuated)
 Scroll inner container to vertical percent position of scrollview. More...
 
var scrollToPercentVertical ( var percent, var time, var attenuated)
 Scroll inner container to vertical percent position of scrollview. More...
 
local scrollToPercentVertical ( local percent, local time, local attenuated)
 Scroll inner container to vertical percent position of scrollview. More...
 
void scrollToPercentHorizontal (float percent, float time, bool attenuated)
 Scroll inner container to horizontal percent position of scrollview. More...
 
void scrollToPercentBothDirection (const Vec2 &percent, float time, bool attenuated)
 Scroll inner container to both direction percent position of scrollview. More...
 
void jumpToBottom ()
 Move inner container to bottom boundary of scrollview. More...
 
var jumpToBottom ()
 Move inner container to bottom boundary of scrollview. More...
 
local jumpToBottom ()
 Move inner container to bottom boundary of scrollview. More...
 
void jumpToTop ()
 Move inner container to top boundary of scrollview. More...
 
var jumpToTop ()
 Move inner container to top boundary of scrollview. More...
 
local jumpToTop ()
 Move inner container to top boundary of scrollview. More...
 
void jumpToLeft ()
 Move inner container to left boundary of scrollview. More...
 
var jumpToLeft ()
 Move inner container to left boundary of scrollview. More...
 
local jumpToLeft ()
 Move inner container to left boundary of scrollview. More...
 
void jumpToRight ()
 Move inner container to right boundary of scrollview. More...
 
var jumpToRight ()
 Move inner container to right boundary of scrollview. More...
 
local jumpToRight ()
 Move inner container to right boundary of scrollview. More...
 
void jumpToTopLeft ()
 Move inner container to top and left boundary of scrollview. More...
 
var jumpToTopLeft ()
 Move inner container to top and left boundary of scrollview. More...
 
local jumpToTopLeft ()
 Move inner container to top and left boundary of scrollview. More...
 
void jumpToTopRight ()
 Move inner container to top and right boundary of scrollview. More...
 
var jumpToTopRight ()
 Move inner container to top and right boundary of scrollview. More...
 
local jumpToTopRight ()
 Move inner container to top and right boundary of scrollview. More...
 
void jumpToBottomLeft ()
 Move inner container to bottom and left boundary of scrollview. More...
 
void jumpToBottomRight ()
 Move inner container to bottom and right boundary of scrollview. More...
 
void jumpToPercentVertical (float percent)
 Move inner container to vertical percent position of scrollview. More...
 
void jumpToPercentHorizontal (float percent)
 Move inner container to horizontal percent position of scrollview. More...
 
void jumpToPercentBothDirection (const Vec2 &percent)
 Move inner container to both direction percent position of scrollview. More...
 
void setInnerContainerSize (const Size &size)
 Changes inner container size of scrollview. More...
 
const SizegetInnerContainerSize () const
 Gets inner container size of scrollview. More...
 
var getInnerContainerSize ()
 Gets inner container size of scrollview. More...
 
local getInnerContainerSize ()
 Gets inner container size of scrollview. More...
 
void addEventListenerScrollView (Ref *target, SEL_ScrollViewEvent selector)
 Add call back function called scrollview event triggered. More...
 
var addEventListenerScrollView ( var target, var selector)
 Add call back function called scrollview event triggered. More...
 
local addEventListenerScrollView ( local target, local selector)
 Add call back function called scrollview event triggered. More...
 
virtual void addEventListener (const ccScrollViewCallback &callback)
virtual void addChild (Node *child) override
 Adds a child to the container with z order and tag. More...
 
var addChild ( var child)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child)
 Adds a child to the container with z order and tag. More...
 
virtual void addChild (Node *child, int localZOrder) override
 Adds a child to the container with a local z-order. More...
 
var addChild ( var child, var localZOrder)
 Adds a child to the container with a local z-order. More...
 
local addChild ( local child, local localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addChild (Node *child, int zOrder, int tag) override
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual void addChild (Node *child, int zOrder, const std::string &name) override
 Adds a child to the container with z order and tag. More...
 
var addChild ( var child, var zOrder, var name)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local name)
 Adds a child to the container with z order and tag. More...
 
virtual void removeAllChildren () override
 Removes all children from the container with a cleanup. More...
 
var removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
local removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
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 removeAllChildrenWithCleanup ( local cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void removeChild (Node *child, bool cleaup=true) override
 Removes a child from the container. More...
 
virtual Vector< Node * > & getChildren () override
 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 override
local getChildren ()
virtual ssize_t getChildrenCount () const override
 Returns the amount of children. More...
 
local getChildrenCount ()
 Returns the amount of children. More...
 
virtual NodegetChildByTag (int tag) const override
 Gets a child from the container with its tag. More...
 
var getChildByTag ( var tag)
 Gets a child from the container with its tag. More...
 
local getChildByTag ( local tag)
 Gets a child from the container with its tag. More...
 
virtual NodegetChildByName (const std::string &name) const override
 Gets a child from the container with its name. More...
 
var getChildByName ( var name)
 Gets a child from the container with its name. More...
 
local getChildByName ( local name)
 Gets a child from the container with its name. More...
 
virtual bool onTouchBegan (Touch *touch, Event *unusedEvent) override
local onTouchBegan ( local touch, local unusedEvent)
virtual void onTouchMoved (Touch *touch, Event *unusedEvent) override
local onTouchMoved ( local touch, local unusedEvent)
virtual void onTouchEnded (Touch *touch, Event *unusedEvent) override
local onTouchEnded ( local touch, local unusedEvent)
virtual void onTouchCancelled (Touch *touch, Event *unusedEvent) override
local onTouchCancelled ( local touch, local unusedEvent)
virtual void update (float dt) override
var update ( var dt)
local update ( local dt)
void setBounceEnabled (bool enabled)
var setBounceEnabled ( var enabled)
local setBounceEnabled ( local enabled)
bool isBounceEnabled () const
var isBounceEnabled ()
local isBounceEnabled ()
void setInertiaScrollEnabled (bool enabled)
var setInertiaScrollEnabled ( var enabled)
local setInertiaScrollEnabled ( local enabled)
bool isInertiaScrollEnabled () const
var isInertiaScrollEnabled ()
local isInertiaScrollEnabled ()
virtual void setLayoutType (Type type) override
 Sets LayoutType. More...
 
var setLayoutType ( var type)
 Sets LayoutType. More...
 
local setLayoutType ( local type)
 Sets LayoutType. More...
 
virtual Type getLayoutType () const override
 Gets LayoutType. More...
 
var getLayoutType ()
 Gets LayoutType. More...
 
local getLayoutType ()
 Gets LayoutType. More...
 
virtual std::string getDescription () const override
 Returns the "class name" of widget. More...
 
local getDescription ()
 Returns the "class name" of widget. More...
 
virtual void onEnter () override
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
var onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
local onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual WidgetfindNextFocusedWidget (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...
 
- Public Member Functions inherited from Layout
 Layout ()
 Default constructor. More...
 
virtual ~Layout ()
 Default destructor. More...
 
void setBackGroundImage (const std::string &fileName, TextureResType texType=TextureResType::LOCAL)
 Sets a background image for layout. More...
 
void setBackGroundImageCapInsets (const Rect &capInsets)
 Sets a background image capinsets for layout, if the background image is a scale9 render. More...
 
const RectgetBackGroundImageCapInsets () const
void setBackGroundColorType (BackGroundColorType type)
 Sets Color Type for layout. More...
 
BackGroundColorType getBackGroundColorType () const
void setBackGroundImageScale9Enabled (bool enabled)
 Sets background iamge use scale9 renderer. More...
 
bool isBackGroundImageScale9Enabled () const
void setBackGroundColor (const Color3B &color)
 Sets background color for layout, if color type is BackGroundColorType::SOLIDE. More...
 
const Color3BgetBackGroundColor () const
void setBackGroundColor (const Color3B &startColor, const Color3B &endColor)
 Sets background color for layout, if color type is BackGroundColorType::GRADIENT. More...
 
const Color3BgetBackGroundStartColor () const
const Color3BgetBackGroundEndColor () const
void setBackGroundColorOpacity (GLubyte opacity)
 Sets background opacity layout. More...
 
GLubyte getBackGroundColorOpacity () const
void setBackGroundColorVector (const Vec2 &vector)
 Sets background color vector for layout, if color type is BackGroundColorType::GRADIENT. More...
 
const Vec2getBackGroundColorVector () const
void setBackGroundImageColor (const Color3B &color)
void setBackGroundImageOpacity (GLubyte opacity)
const Color3BgetBackGroundImageColor () const
GLubyte getBackGroundImageOpacity () const
void removeBackGroundImage ()
 Remove the background image of layout. More...
 
const SizegetBackGroundImageTextureSize () const
 Gets background image texture size. More...
 
virtual void setClippingEnabled (bool enabled)
 Changes if layout can clip it's content and child. More...
 
void setClippingType (ClippingType type)
ClippingType getClippingType () const
virtual bool isClippingEnabled () const
 Gets if layout is clipping enabled. More...
 
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
 Visits this node's children and draw them recursively. More...
 
virtual void forceDoLayout ()
 force refresh widget layout More...
 
void requestDoLayout ()
 request to refresh widget layout 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. More...
 
bool isLoopFocus () const
void setPassFocusToChild (bool pass)
bool isPassFocusToChild () const
virtual WidgetfindNextFocusedWidget (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...
 
- Public Member Functions inherited from Widget
 Widget (void)
virtual ~Widget ()
 Default destructor. More...
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
bool isEnabled () const
 Determines if the widget is enabled. More...
 
void setBright (bool bright)
 Sets whether the widget is 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...
 
void setBrightStyle (BrightStyle 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 hilight)
 Sets whether the widget is hilighted. More...
 
float getLeftInParent ()
 Gets the left boundary position of this widget in parent's coordination system. More...
 
float getLeftBoundary () const
float getBottomInParent ()
 Gets the bottom boundary position of this widget in parent's coordination system. More...
 
float getBottomBoundary () const
float getRightInParent ()
 Gets the right boundary position of this widget in parent's coordination system. More...
 
float getRightBoundary () const
float getTopInParent ()
 Gets the top boundary position of this widget in parent's coordination system. More...
 
float getTopBoundary () const
void addTouchEventListener (Ref *target, SEL_TouchEvent selector)
 Sets the touch event target/selector to the widget. More...
 
void addTouchEventListener (const ccWidgetTouchCallback &callback)
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. More...
 
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...
 
const Vec2getPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionType (PositionType type)
 Changes the position type of the widget. More...
 
PositionType getPositionType () const
 Gets the position type of the widget. More...
 
virtual void setFlippedX (bool 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...
 
virtual bool isFlippedY () const
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
bool isFlipX ()
void setFlipX (bool flipX)
bool isFlipY ()
void setFlipY (bool flipY)
virtual void setScaleX (float scaleX) override
 Sets the scale (x) of the node. More...
 
virtual void setScaleY (float scaleY) override
 Sets the scale (y) of the node. More...
 
virtual void setScale (float scale) override
 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. More...
 
virtual float getScaleY () const override
 Returns the scale factor on Y axis of this node. More...
 
virtual float getScale () const override
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
bool clippingParentAreaContainPoint (const Vec2 &pt)
bool isClippingParentContainsPoint (const Vec2 &pt)
const Vec2getTouchStartPos () const
const Vec2getTouchBeganPosition () const
const Vec2getTouchMovePos () const
const Vec2getTouchMovePosition () const
const Vec2getTouchEndPos () const
const Vec2getTouchEndPosition () const
virtual void setSize (const Size &size)
 Changes the size that is widget's size. More...
 
virtual void setContentSize (const Size &contentSize) override
 Sets the untransformed size of the node. More...
 
virtual void setSizePercent (const Vec2 &percent)
 Changes the percent that is widget's percent size. More...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
const SizegetSize () const
 Returns size of widget. More...
 
const SizegetCustomSize () const
virtual const SizegetLayoutSize ()
const Vec2getSizePercent ()
 Returns size percent of widget. More...
 
virtual bool hitTest (const Vec2 &pt)
 Checks a point if is in widget's space. More...
 
void setLayoutParameter (LayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
LayoutParametergetLayoutParameter () const override
 Gets LayoutParameter of widget. More...
 
LayoutParametergetLayoutParameter (LayoutParameter::Type type)
virtual void ignoreContentAdaptWithSize (bool ignore)
 Note: when you set _ignoreSize to true, no matther you call setContentSize or not, the widget size is always equal to the return value of the member function getVirtualRendererSize. More...
 
bool isIgnoreContentAdaptWithSize () const
 Query whether the widget ignores user deinfed content size or not. More...
 
Vec2 getWorldPosition () const
 Gets world position of widget. More...
 
virtual NodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
virtual Size getVirtualRendererSize () const
Widgetclone ()
void updateSizeAndPosition ()
void updateSizeAndPosition (const Size &parentSize)
void setActionTag (int tag)
int getActionTag () const
void setPropagateTouchEvents (bool 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. More...
 
void setSwallowTouches (bool swallow)
 Specify widget to swallow touches or not. More...
 
bool isSwallowTouches () const
 Return whether the widget is swallowing touch or not. More...
 
bool isFocused () const
void setFocused (bool focus)
bool isFocusEnabled () const
void setFocusEnabled (bool enable)
void requestFocus ()
 when a widget calls this method, it will get focus immediately. More...
 
WidgetgetCurrentFocusedWidget (bool isWidget)
 no matter what widget object you call this method on , it will return you the exact one focused widget More...
 
WidgetgetCurrentFocusedWidget () const
void setUnifySizeEnabled (bool enable)
bool isUnifySizeEnabled () const
void setCallbackName (const std::string &callbackName)
 callbackName getter and setter. More...
 
const std::string & getCallbackName () const
void setCallbackType (const std::string &callbackType)
 callbackType getter and setter. More...
 
const std::string & getCallbackType () const
void setLayoutComponentEnabled (bool enable)
bool isLayoutComponentEnabled () const
void propagateTouchEvent (TouchEventType event, Widget *sender, Touch *touch)
 Propagate touch events to its parents. More...
 
void onFocusChange (Widget *widgetLostFocus, Widget *widgetGetFocus)
 This method is called when a focus change event happens. More...
 
void dispatchFocusEvent (Widget *widgetLoseFocus, Widget *widgetGetFocus)
 Dispatch a EventFocus through a EventDispatcher. More...
 
- Public Member Functions inherited from ProtectedNode
virtual void cleanup () override
 Stops all running actions and schedulers. More...
 
var cleanup ()
 Stops all running actions and schedulers. More...
 
local cleanup ()
 Stops all running actions and schedulers. More...
 
virtual void onEnterTransitionDidFinish () override
 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...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity) override
var updateDisplayedOpacity ( var parentOpacity)
local updateDisplayedOpacity ( local parentOpacity)
virtual void updateDisplayedColor (const Color3B &parentColor) override
var updateDisplayedColor ( var parentColor)
local updateDisplayedColor ( local parentColor)
virtual void disableCascadeColor () override
var disableCascadeColor ()
local disableCascadeColor ()
virtual void disableCascadeOpacity () override
local disableCascadeOpacity ()
virtual ~ProtectedNode ()
local ~ProtectedNode ()
virtual void addProtectedChild (Node *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...
 
local addProtectedChild ( local child, local localZOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual NodegetProtectedChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
var getProtectedChildByTag ( var tag)
 Gets a child from the container with its tag. More...
 
local getProtectedChildByTag ( local 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...
 
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...
 
var removeProtectedChildByTag ( var tag, var 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. More...
 
var removeAllProtectedChildren ()
 Removes all children from the container with a cleanup. More...
 
local removeAllProtectedChildren ()
 Removes all children from the container with a cleanup. More...
 
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...
 
var removeAllChildren ( var cleanup)
 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 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...
 
- 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...
 
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 void draw () final
var draw ()
local draw ()
virtual void visit () final
virtual ScenegetScene () const
 Returns the Scene that contains the Node. More...
 
var getScene ()
 Returns the Scene that contains the Node. More...
 
local getScene ()
 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)
local setEventDispatcher ( local dispatcher)
virtual EventDispatchergetEventDispatcher () const
local getEventDispatcher ()
void setPhysicsBody (PhysicsBody *body)
 set the PhysicsBody that let the sprite effect with physics More...
 
PhysicsBodygetPhysicsBody () const
 get the PhysicsBody the sprite have More...
 
var getPhysicsBody ()
 get the PhysicsBody the sprite have More...
 
local getPhysicsBody ()
 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)
virtual void updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
var updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
local updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
virtual GLubyte getOpacity () const
virtual GLubyte getDisplayedOpacity () const
var getDisplayedOpacity ()
local getDisplayedOpacity ()
virtual void setOpacity (GLubyte opacity)
local setOpacity ( local opacity)
virtual bool isCascadeOpacityEnabled () const
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
local setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
virtual const Color3BgetColor () const
local getColor ()
virtual const Color3BgetDisplayedColor () const
local getDisplayedColor ()
virtual void setColor (const Color3B &color)
var setColor ( var color)
local setColor ( local color)
virtual bool isCascadeColorEnabled () const
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
local setCascadeColorEnabled ( local cascadeColorEnabled)
virtual void setOpacityModifyRGB (bool value)
var setOpacityModifyRGB ( var value)
local setOpacityModifyRGB ( local value)
virtual bool isOpacityModifyRGB () const
void setOnEnterCallback (const std::function< void()> &callback)
var setOnEnterCallback ( var callback)
local setOnEnterCallback ( local callback)
const std::function< void()> & getOnEnterCallback () const
local getOnEnterCallback ()
void setOnExitCallback (const std::function< void()> &callback)
var setOnExitCallback ( var callback)
local setOnExitCallback ( local callback)
const std::function< void()> & getOnExitCallback () const
local getOnExitCallback ()
void setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
var setonEnterTransitionDidFinishCallback ( var callback)
local setonEnterTransitionDidFinishCallback ( local callback)
const std::function< void()> & getonEnterTransitionDidFinishCallback () const
local getonEnterTransitionDidFinishCallback ()
void setonExitTransitionDidStartCallback (const std::function< void()> &callback)
var setonExitTransitionDidStartCallback ( var callback)
local setonExitTransitionDidStartCallback ( local callback)
const std::function< void()> & getonExitTransitionDidStartCallback () const
local getonExitTransitionDidStartCallback ()
unsigned short getCameraMask () const
 get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true More...
 
void setCameraMask (unsigned short mask, bool applyChildren=true)
local setCameraMask ( local mask, local true)
virtual ~Node ()
var ~Node ()
local ~Node ()
virtual bool init ()
var init ()
local init ()
virtual void setLocalZOrder (int localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
local setLocalZOrder ( local 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)
var _setLocalZOrder ( var 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...
 
var setScaleZ ( var 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. More...
 
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 Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const Vec2getNormalizedPosition () 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...
 
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)
 Gets/Sets x or y coordinate individually for position. More...
 
var setPositionX ( var x)
 Gets/Sets x or y coordinate individually for position. More...
 
local setPositionX ( local x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
local getPositionX ()
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
var getPositionY ()
local getPositionY ()
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)
var setVertexZ ( var vertexZ)
local setVertexZ ( local vertexZ)
virtual float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
var getPositionZ ()
 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...
 
var setSkewY ( var 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 Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
local getAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual const SizegetContentSize () const
 Returns the untransformed size of the node. More...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
var setVisible ( var 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...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
var setRotation3D ( var 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...
 
var setRotationQuat ( var 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, it equals to RotationY * RotationX otherwise More...
 
local getRotationQuat ()
 return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise More...
 
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
var getRotationX ()
local getRotationX ()
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)
var setRotationY ( var 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
var getRotationY ()
local getRotationY ()
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)
int getGLServerState () const
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...
 
template<typename 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 void setParent (Node *parent)
 Sets the parent node. More...
 
var setParent ( var parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
local getParent ()
virtual void 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...
 
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...
 
local reorderChild ( local child, local 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...
 
virtual int getTag () const
 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 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 RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
GLProgramgetGLProgram () 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...
 
GLProgramgetShaderProgram () const
local getShaderProgram ()
GLProgramStategetGLProgramState () const
var getGLProgramState ()
local getGLProgramState ()
virtual void setGLProgramState (GLProgramState *glProgramState)
local setGLProgramState ( local glProgramState)
virtual void setGLProgram (GLProgram *glprogram)
 Sets the shader program for this node. More...
 
var setGLProgram ( var 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)
virtual void setActionManager (ActionManager *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 ActionManagergetActionManager ()
 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 ActionManagergetActionManager () const
var getActionManager ()
virtual ActionrunAction (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 . More...
 
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...
 
ActiongetActionByTag (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...
 
local getNumberOfRunningActions ()
 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
var numberOfRunningActions ()
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
local getScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
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)
var unscheduleUpdate ()
local unscheduleUpdate ()
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. More...
 
var scheduleOnce ( var selector, var delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. 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. 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...
 
void unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions Actions are not affected by this method. More...
 
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...
 
local 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 updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
var updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
local updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const Mat4getNodeToParentTransform () 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 void setNodeToParentTransform (const Mat4 &transform)
 Sets the Transformation matrix manually. More...
 
virtual AffineTransform nodeToParentTransform () const
var nodeToParentTransform ()
local nodeToParentTransform ()
virtual const Mat4getParentToNodeTransform () 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...
 
var convertToNodeSpace ( var worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
local convertToNodeSpace ( local worldPoint)
 Converts a Vec2 to node (local) space coordinates. More...
 
Vec2 convertToWorldSpace (const Vec2 &nodePoint) const
 Converts a Vec2 to world space coordinates. More...
 
var convertToWorldSpace ( var nodePoint)
 Converts a Vec2 to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 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...
 
var convertTouchToNodeSpaceAR ( var touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
var setAdditionalTransform ( var additionalTransform)
local setAdditionalTransform ( local additionalTransform)
ComponentgetComponent (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...
 
local addComponent ( local component)
 adds a component More...
 
virtual bool removeComponent (const std::string &name)
 removes a component by its name More...
 
var removeComponent ( var 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 More...
 
var removeAllComponents ()
 removes all components More...
 
local removeAllComponents ()
 removes all components More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from LayoutParameterProtocol
virtual ~LayoutParameterProtocol ()
- Public Member Functions inherited from LayoutProtocol
 LayoutProtocol ()
virtual ~LayoutProtocol ()
var ~LayoutProtocol ()
local ~LayoutProtocol ()

Static Public Member Functions

static ScrollViewcreate ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from Layout
static Layoutcreate ()
 Allocates and initializes a layout. More...
 
- Static Public Member Functions inherited from Widget
static Widgetcreate ()
 Allocates and initializes a widget. More...
 
static void enableDpadNavigation (bool enable)
- Static Public Member Functions inherited from ProtectedNode
static ProtectedNodecreate (void)
- Static Public Member Functions inherited from Node
static Nodecreate ()
 Allocates and initializes a node. More...
 
var create ()
 Allocates and initializes a node. More...
 
local create ()
 Allocates and initializes a node. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
- 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. More...
 
CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
- 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 More...
 
CC_CONSTRUCTOR_ACCESS __pad0__: virtual bool init() override
- Public Attributes inherited from ProtectedNode
CC_CONSTRUCTOR_ACCESS __pad0__: ProtectedNode()
- Public Attributes inherited from Node
CC_CONSTRUCTOR_ACCESS __pad0__: Node()

Protected Member Functions

virtual void initRenderer () override
virtual void onSizeChanged () override
local onSizeChanged ()
virtual void doLayout () override
local doLayout ()
virtual WidgetcreateCloneInstance () override
local createCloneInstance ()
virtual void copySpecialProperties (Widget *model) override
local copySpecialProperties ( local model)
virtual void copyClonedWidgetChildren (Widget *model) override
var copyClonedWidgetChildren ( var model)
local copyClonedWidgetChildren ( local model)
void moveChildren (float offsetX, float offsetY)
var moveChildren ( var offsetX, var offsetY)
local moveChildren ( local offsetX, local offsetY)
void autoScrollChildren (float dt)
var autoScrollChildren ( var dt)
local autoScrollChildren ( local dt)
void bounceChildren (float dt)
var bounceChildren ( var dt)
local bounceChildren ( local dt)
void checkBounceBoundary ()
var checkBounceBoundary ()
local checkBounceBoundary ()
bool checkNeedBounce ()
var checkNeedBounce ()
local checkNeedBounce ()
void startAutoScrollChildrenWithOriginalSpeed (const Vec2 &dir, float v, bool attenuated, float acceleration)
void startAutoScrollChildrenWithDestination (const Vec2 &des, float time, bool attenuated)
var startAutoScrollChildrenWithDestination ( var des, var time, var attenuated)
local startAutoScrollChildrenWithDestination ( local des, local time, local attenuated)
void jumpToDestination (const Vec2 &des)
void stopAutoScrollChildren ()
var stopAutoScrollChildren ()
local stopAutoScrollChildren ()
void startBounceChildren (float v)
var startBounceChildren ( var v)
local startBounceChildren ( local v)
void stopBounceChildren ()
var stopBounceChildren ()
local stopBounceChildren ()
bool checkCustomScrollDestination (float *touchOffsetX, float *touchOffsetY)
var checkCustomScrollDestination ( var touchOffsetX, var touchOffsetY)
local checkCustomScrollDestination ( local touchOffsetX, local touchOffsetY)
virtual bool scrollChildren (float touchOffsetX, float touchOffsetY)
var scrollChildren ( var touchOffsetX, var touchOffsetY)
local scrollChildren ( local touchOffsetX, local touchOffsetY)
bool scrollChildrenVertical (float touchOffsetX, float touchOffsetY)
var scrollChildrenVertical ( var touchOffsetX, var touchOffsetY)
local scrollChildrenVertical ( local touchOffsetX, local touchOffsetY)
bool scrollChildrenHorizontal (float touchOffsetX, float touchOffestY)
var scrollChildrenHorizontal ( var touchOffsetX, var touchOffestY)
local scrollChildrenHorizontal ( local touchOffsetX, local touchOffestY)
bool scrollChildrenBoth (float touchOffsetX, float touchOffsetY)
var scrollChildrenBoth ( var touchOffsetX, var touchOffsetY)
local scrollChildrenBoth ( local touchOffsetX, local touchOffsetY)
bool bounceScrollChildren (float touchOffsetX, float touchOffsetY)
var bounceScrollChildren ( var touchOffsetX, var touchOffsetY)
local bounceScrollChildren ( local touchOffsetX, local touchOffsetY)
void startRecordSlidAction ()
var startRecordSlidAction ()
local startRecordSlidAction ()
virtual void endRecordSlidAction ()
var endRecordSlidAction ()
local endRecordSlidAction ()
virtual void handlePressLogic (Touch *touch)
var handlePressLogic ( var touch)
local handlePressLogic ( local touch)
virtual void handleMoveLogic (Touch *touch)
var handleMoveLogic ( var touch)
local handleMoveLogic ( local touch)
virtual void handleReleaseLogic (Touch *touch)
local handleReleaseLogic ( local touch)
virtual void interceptTouchEvent (Widget::TouchEventType event, Widget *sender, Touch *touch) override
void recordSlidTime (float dt)
void scrollToTopEvent ()
var scrollToTopEvent ()
local scrollToTopEvent ()
void scrollToBottomEvent ()
var scrollToBottomEvent ()
local scrollToBottomEvent ()
void scrollToLeftEvent ()
var scrollToLeftEvent ()
local scrollToLeftEvent ()
void scrollToRightEvent ()
var scrollToRightEvent ()
local scrollToRightEvent ()
void scrollingEvent ()
var scrollingEvent ()
local scrollingEvent ()
void bounceTopEvent ()
var bounceTopEvent ()
local bounceTopEvent ()
void bounceBottomEvent ()
var bounceBottomEvent ()
local bounceBottomEvent ()
void bounceLeftEvent ()
var bounceLeftEvent ()
local bounceLeftEvent ()
void bounceRightEvent ()
var bounceRightEvent ()
local bounceRightEvent ()
- Protected Member Functions inherited from Layout
void addBackGroundImage ()
void supplyTheLayoutParameterLackToChild (Widget *child)
void stencilClippingVisit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
void scissorClippingVisit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
void setStencilClippingSize (const Size &size)
const RectgetClippingRect ()
virtual LayoutManagercreateLayoutManager () override
virtual Size getLayoutContentSize () const override
virtual const Vector< Node * > & getLayoutElements () const override
void onBeforeVisitStencil ()
void onAfterDrawStencil ()
void onAfterVisitStencil ()
void drawFullScreenQuadClearStencil ()
 draw fullscreen quad to clear stencil bits More...
 
void onBeforeVisitScissor ()
void onAfterVisitScissor ()
void updateBackGroundImageColor ()
void updateBackGroundImageOpacity ()
void updateBackGroundImageRGBA ()
Size getLayoutAccumulatedSize () const
 get the content size of the layout, it will accumulate all its children's content size More...
 
int findNearestChildWidgetIndex (FocusDirection direction, Widget *baseWidget)
 When the layout get focused, it the layout pass the focus to its child, it will use this method to determine which child will get the focus. More...
 
int findFarthestChildWidgetIndex (FocusDirection direction, Widget *baseWidget)
 When the layout get focused, it the layout pass the focus to its child, it will use this method to determine which child will get the focus. More...
 
float calculateNearestDistance (Widget *baseWidget)
 caculate the nearest distance between the baseWidget and the children of the layout More...
 
float calculateFarthestDistance (Widget *baseWidget)
 caculate the farthest distance between the baseWidget and the children of the layout More...
 
void findProperSearchingFunctor (FocusDirection dir, Widget *baseWidget)
 when a layout pass the focus to it's child, use this method to determine which algorithm to use, nearest or farthest distance algorithm or not More...
 
WidgetfindFirstNonLayoutWidget ()
 find the first non-layout widget in this layout More...
 
int findFirstFocusEnabledWidgetIndex ()
 find the fisrt focus enabled widget index in the layout, it will recusive searching the child widget More...
 
WidgetfindFocusEnabledChildWidgetByIndex (ssize_t index)
 find a focus enabled child Widget in the layout by index More...
 
Vec2 getWorldCenterPoint (Widget *node) const
 get the center point of a widget in world space More...
 
WidgetgetNextFocusedWidget (FocusDirection direction, Widget *current)
 this method is called internally by nextFocusedWidget. More...
 
WidgetgetPreviousFocusedWidget (FocusDirection direction, Widget *current)
 this method is called internally by nextFocusedWidget. More...
 
WidgetgetChildWidgetByIndex (ssize_t index) const
 find the nth elment in the _children array. More...
 
bool isLastWidgetInContainer (Widget *widget, FocusDirection direction) const
 whether it is the last element according to all their parents More...
 
bool isWidgetAncestorSupportLoopFocus (Widget *widget, FocusDirection direction) const
 Lookup any parent widget with a layout type as the direction, if the layout is loop focused, then return true, otherwise It returns false. More...
 
WidgetpassFocusToChild (FocusDirection direction, Widget *current)
 pass the focus to the layout's next focus enabled child More...
 
bool checkFocusEnabledChild () const
 If there are no focus enabled child in the layout, it will return false, otherwise it returns true. More...
 
- Protected Member Functions inherited from Widget
GLProgramStategetNormalGLProgramState () const
 Get a normal state GLProgramState. More...
 
GLProgramStategetGrayGLProgramState () const
 Get a disabled state GLProgramState. More...
 
virtual void onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
void pushDownEvent ()
void moveEvent ()
virtual void releaseUpEvent ()
virtual void cancelUpEvent ()
virtual void adaptRenderers ()
void updateChildrenDisplayedRGBA ()
void copyProperties (Widget *model)
WidgetgetWidgetParent ()
void updateContentSizeWithTextureSize (const Size &size)
bool isAncestorsEnabled ()
WidgetgetAncensterWidget (Node *node)
bool isAncestorsVisible (Node *node)
void cleanupWidget ()
LayoutComponentgetOrCreateLayoutComponent ()
- Protected Member Functions inherited from ProtectedNode
void insertProtectedChild (Node *child, int z)
 helper that reorder a child More...
 
var insertProtectedChild ( var child, var z)
 helper that reorder a child More...
 
local insertProtectedChild ( local child, local z)
 helper that reorder a child More...
 
- Protected Member Functions inherited from Node
void childrenAlloc (void)
 lazy allocs More...
 
var childrenAlloc ()
 lazy allocs More...
 
local childrenAlloc ()
 lazy allocs More...
 
void insertChild (Node *child, int z)
 helper that reorder a child More...
 
var insertChild ( var child, var z)
 helper that reorder a child More...
 
local insertChild ( local child, local z)
 helper that reorder a child More...
 
void detachChild (Node *child, ssize_t index, bool doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
local detachChild ( local child, local index, local doCleanup)
 Removes a child, call child->onExit(), do cleanup, remove it from children array. More...
 
Vec2 convertToWindowSpace (const Vec2 &nodePoint) const
 Convert cocos2d coordinates to UI windows coordinate. More...
 
var convertToWindowSpace ( var nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
local convertToWindowSpace ( local nodePoint)
 Convert cocos2d coordinates to UI windows coordinate. More...
 
Mat4 transform (const Mat4 &parentTransform)
var transform ( var parentTransform)
local transform ( local parentTransform)
uint32_t processParentFlags (const Mat4 &parentTransform, uint32_t parentFlags)
var processParentFlags ( var parentTransform, var parentFlags)
local processParentFlags ( local parentTransform, local parentFlags)
virtual void updateCascadeOpacity ()
var updateCascadeOpacity ()
local updateCascadeOpacity ()
virtual void updateCascadeColor ()
var updateCascadeColor ()
local updateCascadeColor ()
virtual void updateColor ()
var updateColor ()
local updateColor ()
bool doEnumerate (std::string name, std::function< bool(Node *)> callback) const
var doEnumerate ( var name, var callback)
local doEnumerate ( local name, local callback)
bool doEnumerateRecursive (const Node *node, const std::string &name, std::function< bool(Node *)> callback) const
var doEnumerateRecursive ( var node, var name, var callback)
local doEnumerateRecursive ( local node, local name, local callback)
bool isVisitableByVisitingCamera () const
void updateRotationQuat ()
var updateRotationQuat ()
local updateRotationQuat ()
void updateRotation3D ()
var updateRotation3D ()
local updateRotation3D ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Protected Attributes

Layout_innerContainer
Direction _direction
var _direction
local _direction
Vec2 _autoScrollDir
var _autoScrollDir
local _autoScrollDir
float _topBoundary
var _topBoundary
local _topBoundary
float _bottomBoundary
var _bottomBoundary
local _bottomBoundary
float _leftBoundary
var _leftBoundary
local _leftBoundary
float _rightBoundary
var _rightBoundary
local _rightBoundary
float _bounceTopBoundary
var _bounceTopBoundary
local _bounceTopBoundary
float _bounceBottomBoundary
var _bounceBottomBoundary
local _bounceBottomBoundary
float _bounceLeftBoundary
var _bounceLeftBoundary
local _bounceLeftBoundary
float _bounceRightBoundary
var _bounceRightBoundary
local _bounceRightBoundary
bool _autoScroll
var _autoScroll
local _autoScroll
float _autoScrollAddUpTime
var _autoScrollAddUpTime
local _autoScrollAddUpTime
float _autoScrollOriginalSpeed
var _autoScrollOriginalSpeed
local _autoScrollOriginalSpeed
float _autoScrollAcceleration
var _autoScrollAcceleration
local _autoScrollAcceleration
bool _isAutoScrollSpeedAttenuated
var _isAutoScrollSpeedAttenuated
local _isAutoScrollSpeedAttenuated
bool _needCheckAutoScrollDestination
var _needCheckAutoScrollDestination
local _needCheckAutoScrollDestination
Vec2 _autoScrollDestination
var _autoScrollDestination
local _autoScrollDestination
bool _bePressed
var _bePressed
local _bePressed
float _slidTime
var _slidTime
local _slidTime
Vec2 _moveChildPoint
var _moveChildPoint
local _moveChildPoint
float _childFocusCancelOffset
var _childFocusCancelOffset
local _childFocusCancelOffset
bool _leftBounceNeeded
var _leftBounceNeeded
local _leftBounceNeeded
bool _topBounceNeeded
var _topBounceNeeded
local _topBounceNeeded
bool _rightBounceNeeded
var _rightBounceNeeded
local _rightBounceNeeded
bool _bottomBounceNeeded
var _bottomBounceNeeded
local _bottomBounceNeeded
bool _bounceEnabled
var _bounceEnabled
local _bounceEnabled
bool _bouncing
var _bouncing
local _bouncing
Vec2 _bounceDir
var _bounceDir
local _bounceDir
float _bounceOriginalSpeed
var _bounceOriginalSpeed
local _bounceOriginalSpeed
bool _inertiaScrollEnabled
var _inertiaScrollEnabled
local _inertiaScrollEnabled
Ref_scrollViewEventListener
var _scrollViewEventListener
local _scrollViewEventListener
SEL_ScrollViewEvent _scrollViewEventSelector
var _scrollViewEventSelector
local _scrollViewEventSelector
ccScrollViewCallback _eventCallback
var _eventCallback
local _eventCallback
- Protected Attributes inherited from Layout
bool _backGroundScale9Enabled
Scale9Sprite_backGroundImage
std::string _backGroundImageFileName
Rect _backGroundImageCapInsets
BackGroundColorType _colorType
TextureResType _bgImageTexType
Size _backGroundImageTextureSize
Color3B _backGroundImageColor
GLubyte _backGroundImageOpacity
LayerColor_colorRender
LayerGradient_gradientRender
Color3B _cColor
Color3B _gStartColor
Color3B _gEndColor
Vec2 _alongVector
GLubyte _cOpacity
bool _clippingEnabled
Type _layoutType
ClippingType _clippingType
DrawNode_clippingStencil
bool _scissorRectDirty
Rect _clippingRect
Layout_clippingParent
bool _clippingRectDirty
GLboolean _currentStencilEnabled
GLuint _currentStencilWriteMask
GLenum _currentStencilFunc
GLint _currentStencilRef
GLuint _currentStencilValueMask
GLenum _currentStencilFail
GLenum _currentStencilPassDepthFail
GLenum _currentStencilPassDepthPass
GLboolean _currentDepthWriteMask
GLboolean _currentAlphaTestEnabled
GLenum _currentAlphaTestFunc
GLclampf _currentAlphaTestRef
GLint _mask_layer_le
GroupCommand _groupCommand
CustomCommand _beforeVisitCmdStencil
CustomCommand _afterDrawStencilCmd
CustomCommand _afterVisitCmdStencil
CustomCommand _beforeVisitCmdScissor
CustomCommand _afterVisitCmdScissor
bool _doLayoutDirty
bool _isInterceptTouch
bool _loopFocus
bool _passFocusToChild
bool _isFocusPassing
- Protected Attributes inherited from Widget
bool _usingLayoutComponent
bool _unifySize
bool _enabled
bool _bright
bool _touchEnabled
bool _highlight
bool _affectByClipping
bool _ignoreSize
bool _propagateTouchEvents
BrightStyle _brightStyle
SizeType _sizeType
PositionType _positionType
int _actionTag
Size _customSize
Vec2 _sizePercent
Vec2 _positionPercent
bool _hitted
EventListenerTouchOneByOne_touchListener
Vec2 _touchBeganPosition
Vec2 _touchMovePosition
Vec2 _touchEndPosition
bool _flippedX
bool _flippedY
Map< int, LayoutParameter * > _layoutParameterDictionary
LayoutParameter::Type _layoutParameterType
bool _focused
bool _focusEnabled
Ref_touchEventListener
SEL_TouchEvent _touchEventSelector
ccWidgetTouchCallback _touchEventCallback
ccWidgetClickCallback _clickEventListener
ccWidgetEventCallback _ccEventCallback
std::string _callbackType
std::string _callbackName
- Protected Attributes inherited from ProtectedNode
Vector< Node * > _protectedChildren
 array of children nodes More...
 
bool _reorderProtectedChildDirty
var _reorderProtectedChildDirty
local _reorderProtectedChildDirty
- Protected Attributes inherited from Node
float _rotationX
 rotation on the X-axis More...
 
float _rotationY
 rotation on the Y-axis More...
 
var _rotationY
 rotation on the Y-axis More...
 
local _rotationY
 rotation on the Y-axis More...
 
float _rotationZ_X
 rotation angle on Z-axis, component X More...
 
var _rotationZ_X
 rotation angle on Z-axis, component X More...
 
local _rotationZ_X
 rotation angle on Z-axis, component X More...
 
float _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
var _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
local _rotationZ_Y
 rotation angle on Z-axis, component Y More...
 
Quaternion _rotationQuat
var _rotationQuat
local _rotationQuat
float _scaleX
 rotation using quaternion, if _rotationZ_X == _rotationZ_Y, _rotationQuat = RotationZ_X * RotationY * RotationX, else _rotationQuat = RotationY * RotationX More...
 
var _scaleX
 rotation using quaternion, if _rotationZ_X == _rotationZ_Y, _rotationQuat = RotationZ_X * RotationY * RotationX, else _rotationQuat = RotationY * RotationX More...
 
local _scaleX
 rotation using quaternion, if _rotationZ_X == _rotationZ_Y, _rotationQuat = RotationZ_X * RotationY * RotationX, else _rotationQuat = RotationY * RotationX More...
 
float _scaleY
 scaling factor on y-axis More...
 
float _scaleZ
 scaling factor on z-axis More...
 
var _scaleZ
 scaling factor on z-axis More...
 
local _scaleZ
 scaling factor on z-axis More...
 
Vec2 _position
 position of the node More...
 
var _position
 position of the node More...
 
local _position
 position of the node More...
 
float _positionZ
 OpenGL real Z position. More...
 
var _positionZ
 OpenGL real Z position. More...
 
local _positionZ
 OpenGL real Z position. More...
 
Vec2 _normalizedPosition
var _normalizedPosition
local _normalizedPosition
bool _usingNormalizedPosition
var _usingNormalizedPosition
local _usingNormalizedPosition
bool _normalizedPositionDirty
var _normalizedPositionDirty
local _normalizedPositionDirty
float _skewX
 skew angle on x-axis More...
 
var _skewX
 skew angle on x-axis More...
 
local _skewX
 skew angle on x-axis More...
 
float _skewY
 skew angle on y-axis More...
 
var _skewY
 skew angle on y-axis More...
 
local _skewY
 skew angle on y-axis More...
 
Vec2 _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Vec2 _anchorPoint
 anchor point normalized (NOT in points) More...
 
var _anchorPoint
 anchor point normalized (NOT in points) More...
 
local _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
bool _contentSizeDirty
 whether or not the contentSize is dirty More...
 
var _contentSizeDirty
 whether or not the contentSize is dirty More...
 
local _contentSizeDirty
 whether or not the contentSize is dirty More...
 
Mat4 _modelViewTransform
 ModelView transform of the Node. More...
 
var _modelViewTransform
 ModelView transform of the Node. More...
 
local _modelViewTransform
 ModelView transform of the Node. More...
 
Mat4 _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
Mat4 _inverse
 inverse transform More...
 
local _inverse
 inverse transform More...
 
bool _inverseDirty
 inverse transform dirty flag More...
 
var _inverseDirty
 inverse transform dirty flag More...
 
local _inverseDirty
 inverse transform dirty flag More...
 
Mat4 _additionalTransform
 transform More...
 
var _additionalTransform
 transform More...
 
local _additionalTransform
 transform More...
 
bool _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
var _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
local _useAdditionalTransform
 The flag to check whether the additional transform is dirty. More...
 
bool _transformUpdated
 Whether or not the Transform object was updated since the last frame. More...
 
int _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
var _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
local _localZOrder
 Local order (relative to its siblings) used to sort the node. More...
 
float _globalZOrder
 Global order used to sort the node. More...
 
var _globalZOrder
 Global order used to sort the node. More...
 
local _globalZOrder
 Global order used to sort the node. More...
 
Vector< Node * > _children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
var _parent
 weak reference to parent node More...
 
local _parent
 weak reference to parent node More...
 
Director_director
var _director
local _director
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
std::string _name
 a string label, an user defined string to identify this node More...
 
var _name
 a string label, an user defined string to identify this node More...
 
local _name
 a string label, an user defined string to identify this node More...
 
size_t _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
var _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
local _hashOfName
 hash value of _name, used for speed in getChildByName More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
var _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Ref_userObject
 A user assigned Object. More...
 
var _userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgramState_glProgramState
 OpenGL Program State. More...
 
var _glProgramState
 OpenGL Program State. More...
 
local _glProgramState
 OpenGL Program State. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
var _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
local _orderOfArrival
 used to preserve sequence while sorting children with the same localZOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
EventDispatcher_eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
var _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
local _eventDispatcher
 event dispatcher used to dispatch all kinds of events More...
 
bool _running
 is running More...
 
var _running
 is running More...
 
local _running
 is running More...
 
bool _visible
 is this node visible More...
 
var _visible
 is this node visible More...
 
local _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Vec2 will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
bool _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
var _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
local _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
PhysicsBody_physicsBody
 the physicsBody the node have More...
 
var _physicsBody
 the physicsBody the node have More...
 
local _physicsBody
 the physicsBody the node have More...
 
float _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
var _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
local _physicsScaleStartX
 the scale x value when setPhysicsBody More...
 
float _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
var _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
local _physicsScaleStartY
 the scale y value when setPhysicsBody More...
 
float _physicsRotation
var _physicsRotation
local _physicsRotation
bool _physicsTransformDirty
var _physicsTransformDirty
local _physicsTransformDirty
bool _updateTransformFromPhysics
var _updateTransformFromPhysics
local _updateTransformFromPhysics
GLubyte _displayedOpacity
var _displayedOpacity
local _displayedOpacity
GLubyte _realOpacity
var _realOpacity
local _realOpacity
Color3B _displayedColor
var _displayedColor
local _displayedColor
Color3B _realColor
var _realColor
local _realColor
bool _cascadeColorEnabled
var _cascadeColorEnabled
local _cascadeColorEnabled
bool _cascadeOpacityEnabled
var _cascadeOpacityEnabled
local _cascadeOpacityEnabled
unsigned short _cameraMask
var _cameraMask
local _cameraMask
std::function< void()> _onEnterCallback
var _onEnterCallback
local _onEnterCallback
std::function< void()> _onExitCallback
var _onExitCallback
local _onExitCallback
std::function< void()> _onEnterTransitionDidFinishCallback
std::function< void()> _onExitTransitionDidStartCallback
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
var _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Additional Inherited Members

- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
var INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
local INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
- Static Protected Attributes inherited from Widget
static Widget_focusedWidget
 store the only one focued widget More...
 
- Static Protected Attributes inherited from Node
static int s_globalOrderOfArrival
var s_globalOrderOfArrival
local s_globalOrderOfArrival

Member Typedef Documentation

typedef std::function<void(Ref*,
EventType)>
ccScrollViewCallback

Member Enumeration Documentation

enum Direction
strong
Enumerator
NONE 
VERTICAL 
HORIZONTAL 
BOTH 
var Direction
strong
Enumerator
NONE 
VERTICAL 
HORIZONTAL 
BOTH 
local Direction
strong
Enumerator
NONE 
VERTICAL 
HORIZONTAL 
BOTH 
enum EventType
strong
Enumerator
SCROLL_TO_TOP 
SCROLL_TO_BOTTOM 
SCROLL_TO_LEFT 
SCROLL_TO_RIGHT 
SCROLLING 
BOUNCE_TOP 
BOUNCE_BOTTOM 
BOUNCE_LEFT 
BOUNCE_RIGHT 
var EventType
strong
Enumerator
SCROLL_TO_TOP 
SCROLL_TO_BOTTOM 
SCROLL_TO_LEFT 
SCROLL_TO_RIGHT 
SCROLLING 
BOUNCE_TOP 
BOUNCE_BOTTOM 
BOUNCE_LEFT 
BOUNCE_RIGHT 
local EventType
strong
Enumerator
SCROLL_TO_TOP 
SCROLL_TO_BOTTOM 
SCROLL_TO_LEFT 
SCROLL_TO_RIGHT 
SCROLLING 
BOUNCE_TOP 
BOUNCE_BOTTOM 
BOUNCE_LEFT 
BOUNCE_RIGHT 

Constructor & Destructor Documentation

Default constructor.

var ScrollView ( )

Default constructor.

local ScrollView ( )

Default constructor.

virtual ~ScrollView ( )
virtual

Default destructor.

var ~ScrollView ( )
virtual

Default destructor.

local ~ScrollView ( )
virtual

Default destructor.

Member Function Documentation

virtual void addChild ( Node child)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagA interger to identify the node easily. Please refer to setTag(int)

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagA interger to identify the node easily. Please refer to setTag(int)

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagA interger to identify the node easily. Please refer to setTag(int)

Reimplemented from Layout.

Reimplemented in ListView.

virtual void addChild ( Node child,
int  localZOrder 
)
overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child,
var  localZOrder 
)
overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child,
local  localZOrder 
)
overridevirtual

Adds a child to the container with a local z-order.

If the child is added to a 'running' node, then 'onEnter' and 'onEnterTransitionDidFinish' will be called immediately.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)

Reimplemented from Layout.

Reimplemented in ListView.

virtual void addChild ( Node child,
int  localZOrder,
int  tag 
)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagAn integer to identify the node easily. Please refer to setTag(int)

Please use addChild(Node* child, int localZOrder, const std::string &name) instead.

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child,
var  localZOrder,
var  tag 
)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagAn integer to identify the node easily. Please refer to setTag(int)

Please use addChild(Node* child, int localZOrder, const std::string &name) instead.

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child,
local  localZOrder,
local  tag 
)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
tagAn integer to identify the node easily. Please refer to setTag(int)

Please use addChild(Node* child, int localZOrder, const std::string &name) instead.

Reimplemented from Layout.

Reimplemented in ListView.

virtual void addChild ( Node child,
int  localZOrder,
const std::string &  name 
)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
nameA string to identify the node easily. Please refer to setName(int)

Reimplemented from Layout.

Reimplemented in ListView.

var addChild ( var  child,
var  localZOrder,
var  name 
)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
nameA string to identify the node easily. Please refer to setName(int)

Reimplemented from Layout.

Reimplemented in ListView.

local addChild ( local  child,
local  localZOrder,
local  name 
)
overridevirtual

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.

Parameters
childA child node
zOrderZ order for drawing priority. Please refer to setLocalZOrder(int)
nameA string to identify the node easily. Please refer to setName(int)

Reimplemented from Layout.

Reimplemented in ListView.

virtual void addEventListener ( const ccScrollViewCallback callback)
virtual

Reimplemented in ListView.

var addEventListener ( var  callback)
virtual

Reimplemented in ListView.

local addEventListener ( local  callback)
virtual

Reimplemented in ListView.

void addEventListenerScrollView ( Ref target,
SEL_ScrollViewEvent  selector 
)

Add call back function called scrollview event triggered.

var addEventListenerScrollView ( var  target,
var  selector 
)

Add call back function called scrollview event triggered.

local addEventListenerScrollView ( local  target,
local  selector 
)

Add call back function called scrollview event triggered.

void autoScrollChildren ( float  dt)
protected
var autoScrollChildren ( var  dt)
protected
local autoScrollChildren ( local  dt)
protected
void bounceBottomEvent ( )
protected
var bounceBottomEvent ( )
protected
local bounceBottomEvent ( )
protected
void bounceChildren ( float  dt)
protected
var bounceChildren ( var  dt)
protected
local bounceChildren ( local  dt)
protected
void bounceLeftEvent ( )
protected
var bounceLeftEvent ( )
protected
local bounceLeftEvent ( )
protected
void bounceRightEvent ( )
protected
var bounceRightEvent ( )
protected
local bounceRightEvent ( )
protected
bool bounceScrollChildren ( float  touchOffsetX,
float  touchOffsetY 
)
protected
var bounceScrollChildren ( var  touchOffsetX,
var  touchOffsetY 
)
protected
local bounceScrollChildren ( local  touchOffsetX,
local  touchOffsetY 
)
protected
void bounceTopEvent ( )
protected
var bounceTopEvent ( )
protected
local bounceTopEvent ( )
protected
void checkBounceBoundary ( )
protected
var checkBounceBoundary ( )
protected
local checkBounceBoundary ( )
protected
bool checkCustomScrollDestination ( float *  touchOffsetX,
float *  touchOffsetY 
)
protected
var checkCustomScrollDestination ( var  touchOffsetX,
var  touchOffsetY 
)
protected
local checkCustomScrollDestination ( local  touchOffsetX,
local  touchOffsetY 
)
protected
bool checkNeedBounce ( )
protected
var checkNeedBounce ( )
protected
local checkNeedBounce ( )
protected
virtual void
copyClonedWidgetChildren
( Widget model)
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

var copyClonedWidgetChildren ( var  model)
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

local copyClonedWidgetChildren ( local  model)
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

virtual void copySpecialProperties ( Widget model)
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

var copySpecialProperties ( var  model)
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

local copySpecialProperties ( local  model)
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

static ScrollView* create ( )
static

Allocates and initializes.

var create ( )
static

Allocates and initializes.

local create ( )
static

Allocates and initializes.

virtual Widget* createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

var createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

local createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

virtual void doLayout ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

var doLayout ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

local doLayout ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

virtual void endRecordSlidAction ( )
protectedvirtual
var endRecordSlidAction ( )
protectedvirtual
local endRecordSlidAction ( )
protectedvirtual
virtual Widget*
findNextFocusedWidget
( FocusDirection  direction,
Widget current 
)
overridevirtual

When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.

If the widget is not in a layout, it will return itself

Parameters
dirthe direction to look for the next focused widget in a layout
currentthe current focused widget
Returns
the next focused widget in a layout

Reimplemented from Widget.

var findNextFocusedWidget ( var  direction,
var  current 
)
overridevirtual

When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.

If the widget is not in a layout, it will return itself

Parameters
dirthe direction to look for the next focused widget in a layout
currentthe current focused widget
Returns
the next focused widget in a layout

Reimplemented from Widget.

local findNextFocusedWidget ( local  direction,
local  current 
)
overridevirtual

When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.

If the widget is not in a layout, it will return itself

Parameters
dirthe direction to look for the next focused widget in a layout
currentthe current focused widget
Returns
the next focused widget in a layout

Reimplemented from Widget.

virtual Node* getChildByName ( const std::string &  name) const
overridevirtual

Gets a child from the container with its name.

Parameters
nameAn identifier to find the child node.
Returns
a Node object whose name equals to the input parameter
Since
v3.2

Reimplemented from Node.

var getChildByName ( var  name)
overridevirtual

Gets a child from the container with its name.

Parameters
nameAn identifier to find the child node.
Returns
a Node object whose name equals to the input parameter
Since
v3.2

Reimplemented from Node.

local getChildByName ( local  name)
overridevirtual

Gets a child from the container with its name.

Parameters
nameAn identifier to find the child node.
Returns
a Node object whose name equals to the input parameter
Since
v3.2

Reimplemented from Node.

virtual Node* getChildByTag ( int  tag) const
overridevirtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Please use getChildByName() instead

Reimplemented from Node.

var getChildByTag ( var  tag)
overridevirtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Please use getChildByName() instead

Reimplemented from Node.

local getChildByTag ( local  tag)
overridevirtual

Gets a child from the container with its tag.

Parameters
tagAn identifier to find the child node.
Returns
a Node object whose tag equals to the input parameter

Please use getChildByName() instead

Reimplemented from Node.

virtual Vector<Node*>& getChildren ( )
overridevirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented from Node.

var getChildren ( )
overridevirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented from Node.

local getChildren ( )
overridevirtual

Returns the array of the node's children.

Returns
the array the node's children

Reimplemented from Node.

virtual const Vector<Node*>
& getChildren
( ) const
overridevirtual

Reimplemented from Node.

var getChildren ( )
overridevirtual

Reimplemented from Node.

local getChildren ( )
overridevirtual

Reimplemented from Node.

virtual ssize_t getChildrenCount ( ) const
overridevirtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented from Node.

var getChildrenCount ( )
overridevirtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented from Node.

local getChildrenCount ( )
overridevirtual

Returns the amount of children.

Returns
The amount of children.

Reimplemented from Node.

virtual std::string getDescription ( ) const
overridevirtual

Returns the "class name" of widget.

Reimplemented from Layout.

Reimplemented in ListView.

var getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from Layout.

Reimplemented in ListView.

local getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from Layout.

Reimplemented in ListView.

Direction getDirection ( ) const

Gets scroll direction of scrollview.

See also
Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll
Returns
Direction
var getDirection ( )

Gets scroll direction of scrollview.

See also
Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll
Returns
Direction
local getDirection ( )

Gets scroll direction of scrollview.

See also
Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll
Returns
Direction
Layout* getInnerContainer ( ) const

Gets inner container of scrollview.

Inner container is the container of scrollview's children.

Returns
inner container.
var getInnerContainer ( )

Gets inner container of scrollview.

Inner container is the container of scrollview's children.

Returns
inner container.
local getInnerContainer ( )

Gets inner container of scrollview.

Inner container is the container of scrollview's children.

Returns
inner container.
const Size& getInnerContainerSize ( ) const

Gets inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns
inner container size.
var getInnerContainerSize ( )

Gets inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns
inner container size.
local getInnerContainerSize ( )

Gets inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns
inner container size.
virtual Type getLayoutType ( ) const
overridevirtual

Gets LayoutType.

See also
LayoutType
Returns
LayoutType

Reimplemented from Layout.

var getLayoutType ( )
overridevirtual

Gets LayoutType.

See also
LayoutType
Returns
LayoutType

Reimplemented from Layout.

local getLayoutType ( )
overridevirtual

Gets LayoutType.

See also
LayoutType
Returns
LayoutType

Reimplemented from Layout.

virtual void handleMoveLogic ( Touch touch)
protectedvirtual
var handleMoveLogic ( var  touch)
protectedvirtual
local handleMoveLogic ( local  touch)
protectedvirtual
virtual void handlePressLogic ( Touch touch)
protectedvirtual
var handlePressLogic ( var  touch)
protectedvirtual
local handlePressLogic ( local  touch)
protectedvirtual
virtual void handleReleaseLogic ( Touch touch)
protectedvirtual
var handleReleaseLogic ( var  touch)
protectedvirtual
local handleReleaseLogic ( local  touch)
protectedvirtual
virtual void initRenderer ( )
overrideprotectedvirtual

Reimplemented from Widget.

var initRenderer ( )
overrideprotectedvirtual

Reimplemented from Widget.

local initRenderer ( )
overrideprotectedvirtual

Reimplemented from Widget.

virtual void interceptTouchEvent ( Widget::TouchEventType  event,
Widget sender,
Touch touch 
)
overrideprotectedvirtual

Reimplemented from Widget.

Reimplemented in ListView.

var interceptTouchEvent ( var  event,
var  sender,
var  touch 
)
overrideprotectedvirtual

Reimplemented from Widget.

Reimplemented in ListView.

local interceptTouchEvent ( local  event,
local  sender,
local  touch 
)
overrideprotectedvirtual

Reimplemented from Widget.

Reimplemented in ListView.

bool isBounceEnabled ( ) const
var isBounceEnabled ( )
local isBounceEnabled ( )
bool isInertiaScrollEnabled ( ) const
var isInertiaScrollEnabled ( )
local isInertiaScrollEnabled ( )
void jumpToBottom ( )

Move inner container to bottom boundary of scrollview.

var jumpToBottom ( )

Move inner container to bottom boundary of scrollview.

local jumpToBottom ( )

Move inner container to bottom boundary of scrollview.

void jumpToBottomLeft ( )

Move inner container to bottom and left boundary of scrollview.

var jumpToBottomLeft ( )

Move inner container to bottom and left boundary of scrollview.

local jumpToBottomLeft ( )

Move inner container to bottom and left boundary of scrollview.

void jumpToBottomRight ( )

Move inner container to bottom and right boundary of scrollview.

var jumpToBottomRight ( )

Move inner container to bottom and right boundary of scrollview.

local jumpToBottomRight ( )

Move inner container to bottom and right boundary of scrollview.

void jumpToDestination ( const Vec2 des)
protected
var jumpToDestination ( var  des)
protected
local jumpToDestination ( local  des)
protected
void jumpToLeft ( )

Move inner container to left boundary of scrollview.

var jumpToLeft ( )

Move inner container to left boundary of scrollview.

local jumpToLeft ( )

Move inner container to left boundary of scrollview.

void jumpToPercentBothDirection ( const Vec2 percent)

Move inner container to both direction percent position of scrollview.

var jumpToPercentBothDirection ( var  percent)

Move inner container to both direction percent position of scrollview.

local jumpToPercentBothDirection ( local  percent)

Move inner container to both direction percent position of scrollview.

void jumpToPercentHorizontal ( float  percent)

Move inner container to horizontal percent position of scrollview.

var jumpToPercentHorizontal ( var  percent)

Move inner container to horizontal percent position of scrollview.

local jumpToPercentHorizontal ( local  percent)

Move inner container to horizontal percent position of scrollview.

void jumpToPercentVertical ( float  percent)

Move inner container to vertical percent position of scrollview.

var jumpToPercentVertical ( var  percent)

Move inner container to vertical percent position of scrollview.

local jumpToPercentVertical ( local  percent)

Move inner container to vertical percent position of scrollview.

void jumpToRight ( )

Move inner container to right boundary of scrollview.

var jumpToRight ( )

Move inner container to right boundary of scrollview.

local jumpToRight ( )

Move inner container to right boundary of scrollview.

void jumpToTop ( )

Move inner container to top boundary of scrollview.

var jumpToTop ( )

Move inner container to top boundary of scrollview.

local jumpToTop ( )

Move inner container to top boundary of scrollview.

void jumpToTopLeft ( )

Move inner container to top and left boundary of scrollview.

var jumpToTopLeft ( )

Move inner container to top and left boundary of scrollview.

local jumpToTopLeft ( )

Move inner container to top and left boundary of scrollview.

void jumpToTopRight ( )

Move inner container to top and right boundary of scrollview.

var jumpToTopRight ( )

Move inner container to top and right boundary of scrollview.

local jumpToTopRight ( )

Move inner container to top and right boundary of scrollview.

void moveChildren ( float  offsetX,
float  offsetY 
)
protected
var moveChildren ( var  offsetX,
var  offsetY 
)
protected
local moveChildren ( local  offsetX,
local  offsetY 
)
protected
virtual void onEnter ( )
overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Layout.

var onEnter ( )
overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Layout.

local onEnter ( )
overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Layout.

virtual void onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

var onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

local onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from Layout.

Reimplemented in ListView.

virtual bool onTouchBegan ( Touch touch,
Event unusedEvent 
)
overridevirtual

Reimplemented from Widget.

var onTouchBegan ( var  touch,
var  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

local onTouchBegan ( local  touch,
local  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

virtual void onTouchCancelled ( Touch touch,
Event unusedEvent 
)
overridevirtual

Reimplemented from Widget.

var onTouchCancelled ( var  touch,
var  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

local onTouchCancelled ( local  touch,
local  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

virtual void onTouchEnded ( Touch touch,
Event unusedEvent 
)
overridevirtual

Reimplemented from Widget.

var onTouchEnded ( var  touch,
var  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

local onTouchEnded ( local  touch,
local  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

virtual void onTouchMoved ( Touch touch,
Event unusedEvent 
)
overridevirtual

Reimplemented from Widget.

var onTouchMoved ( var  touch,
var  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

local onTouchMoved ( local  touch,
local  unusedEvent 
)
overridevirtual

Reimplemented from Widget.

void recordSlidTime ( float  dt)
protected
var recordSlidTime ( var  dt)
protected
local recordSlidTime ( local  dt)
protected
virtual void removeAllChildren ( )
overridevirtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented from Layout.

Reimplemented in ListView.

var removeAllChildren ( )
overridevirtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented from Layout.

Reimplemented in ListView.

local removeAllChildren ( )
overridevirtual

Removes all children from the container with a cleanup.

See also
removeAllChildrenWithCleanup(bool)

Reimplemented from Layout.

Reimplemented in ListView.

virtual void
removeAllChildrenWithCleanup
( bool  cleanup)
overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters
cleanuptrue if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Layout.

Reimplemented in ListView.

var removeAllChildrenWithCleanup ( var  cleanup)
overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters
cleanuptrue if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Layout.

Reimplemented in ListView.

local removeAllChildrenWithCleanup ( local  cleanup)
overridevirtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Parameters
cleanuptrue if all running actions on all children nodes should be cleanup, false oterwise.

Reimplemented from Layout.

Reimplemented in ListView.

virtual void removeChild ( Node child,
bool  cleanup = true 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Layout.

Reimplemented in ListView.

var removeChild ( var  child,
var  cleanup = true 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Layout.

Reimplemented in ListView.

local removeChild ( local  child,
local  cleanup = true 
)
overridevirtual

Removes a child from the container.

It will also cleanup all running actions depending on the cleanup parameter.

Parameters
childThe child node which will be removed.
cleanuptrue if all running actions and callbacks on the child node will be cleanup, false otherwise.

Reimplemented from Layout.

Reimplemented in ListView.

virtual bool scrollChildren ( float  touchOffsetX,
float  touchOffsetY 
)
protectedvirtual
var scrollChildren ( var  touchOffsetX,
var  touchOffsetY 
)
protectedvirtual
local scrollChildren ( local  touchOffsetX,
local  touchOffsetY 
)
protectedvirtual
bool scrollChildrenBoth ( float  touchOffsetX,
float  touchOffsetY 
)
protected
var scrollChildrenBoth ( var  touchOffsetX,
var  touchOffsetY 
)
protected
local scrollChildrenBoth ( local  touchOffsetX,
local  touchOffsetY 
)
protected
bool scrollChildrenHorizontal ( float  touchOffsetX,
float  touchOffestY 
)
protected
var scrollChildrenHorizontal ( var  touchOffsetX,
var  touchOffestY 
)
protected
local scrollChildrenHorizontal ( local  touchOffsetX,
local  touchOffestY 
)
protected
bool scrollChildrenVertical ( float  touchOffsetX,
float  touchOffsetY 
)
protected
var scrollChildrenVertical ( var  touchOffsetX,
var  touchOffsetY 
)
protected
local scrollChildrenVertical ( local  touchOffsetX,
local  touchOffsetY 
)
protected
void scrollingEvent ( )
protected
var scrollingEvent ( )
protected
local scrollingEvent ( )
protected
void scrollToBottom ( float  time,
bool  attenuated 
)

Scroll inner container to bottom boundary of scrollview.

var scrollToBottom ( var  time,
var  attenuated 
)

Scroll inner container to bottom boundary of scrollview.

local scrollToBottom ( local  time,
local  attenuated 
)

Scroll inner container to bottom boundary of scrollview.

void scrollToBottomEvent ( )
protected
var scrollToBottomEvent ( )
protected
local scrollToBottomEvent ( )
protected
void scrollToBottomLeft ( float  time,
bool  attenuated 
)

Scroll inner container to bottom and left boundary of scrollview.

var scrollToBottomLeft ( var  time,
var  attenuated 
)

Scroll inner container to bottom and left boundary of scrollview.

local scrollToBottomLeft ( local  time,
local  attenuated 
)

Scroll inner container to bottom and left boundary of scrollview.

void scrollToBottomRight ( float  time,
bool  attenuated 
)

Scroll inner container to bottom and right boundary of scrollview.

var scrollToBottomRight ( var  time,
var  attenuated 
)

Scroll inner container to bottom and right boundary of scrollview.

local scrollToBottomRight ( local  time,
local  attenuated 
)

Scroll inner container to bottom and right boundary of scrollview.

void scrollToLeft ( float  time,
bool  attenuated 
)

Scroll inner container to left boundary of scrollview.

var scrollToLeft ( var  time,
var  attenuated 
)

Scroll inner container to left boundary of scrollview.

local scrollToLeft ( local  time,
local  attenuated 
)

Scroll inner container to left boundary of scrollview.

void scrollToLeftEvent ( )
protected
var scrollToLeftEvent ( )
protected
local scrollToLeftEvent ( )
protected
void scrollToPercentBothDirection ( const Vec2 percent,
float  time,
bool  attenuated 
)

Scroll inner container to both direction percent position of scrollview.

var scrollToPercentBothDirection ( var  percent,
var  time,
var  attenuated 
)

Scroll inner container to both direction percent position of scrollview.

local scrollToPercentBothDirection ( local  percent,
local  time,
local  attenuated 
)

Scroll inner container to both direction percent position of scrollview.

void scrollToPercentHorizontal ( float  percent,
float  time,
bool  attenuated 
)

Scroll inner container to horizontal percent position of scrollview.

var scrollToPercentHorizontal ( var  percent,
var  time,
var  attenuated 
)

Scroll inner container to horizontal percent position of scrollview.

local scrollToPercentHorizontal ( local  percent,
local  time,
local  attenuated 
)

Scroll inner container to horizontal percent position of scrollview.

void scrollToPercentVertical ( float  percent,
float  time,
bool  attenuated 
)

Scroll inner container to vertical percent position of scrollview.

var scrollToPercentVertical ( var  percent,
var  time,
var  attenuated 
)

Scroll inner container to vertical percent position of scrollview.

local scrollToPercentVertical ( local  percent,
local  time,
local  attenuated 
)

Scroll inner container to vertical percent position of scrollview.

void scrollToRight ( float  time,
bool  attenuated 
)

Scroll inner container to right boundary of scrollview.

var scrollToRight ( var  time,
var  attenuated 
)

Scroll inner container to right boundary of scrollview.

local scrollToRight ( local  time,
local  attenuated 
)

Scroll inner container to right boundary of scrollview.

void scrollToRightEvent ( )
protected
var scrollToRightEvent ( )
protected
local scrollToRightEvent ( )
protected
void scrollToTop ( float  time,
bool  attenuated 
)

Scroll inner container to top boundary of scrollview.

var scrollToTop ( var  time,
var  attenuated 
)

Scroll inner container to top boundary of scrollview.

local scrollToTop ( local  time,
local  attenuated 
)

Scroll inner container to top boundary of scrollview.

void scrollToTopEvent ( )
protected
var scrollToTopEvent ( )
protected
local scrollToTopEvent ( )
protected
void scrollToTopLeft ( float  time,
bool  attenuated 
)

Scroll inner container to top and left boundary of scrollview.

var scrollToTopLeft ( var  time,
var  attenuated 
)

Scroll inner container to top and left boundary of scrollview.

local scrollToTopLeft ( local  time,
local  attenuated 
)

Scroll inner container to top and left boundary of scrollview.

void scrollToTopRight ( float  time,
bool  attenuated 
)

Scroll inner container to top and right boundary of scrollview.

var scrollToTopRight ( var  time,
var  attenuated 
)

Scroll inner container to top and right boundary of scrollview.

local scrollToTopRight ( local  time,
local  attenuated 
)

Scroll inner container to top and right boundary of scrollview.

void setBounceEnabled ( bool  enabled)
var setBounceEnabled ( var  enabled)
local setBounceEnabled ( local  enabled)
virtual void setDirection ( Direction  dir)
virtual

Changes scroll direction of scrollview.

See also
Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll
Parameters
dir

Reimplemented in ListView.

var setDirection ( var  dir)
virtual

Changes scroll direction of scrollview.

See also
Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll
Parameters
dir

Reimplemented in ListView.

local setDirection ( local  dir)
virtual

Changes scroll direction of scrollview.

See also
Direction Direction::VERTICAL means vertical scroll, Direction::HORIZONTAL means horizontal scroll
Parameters
dir

Reimplemented in ListView.

void setInertiaScrollEnabled ( bool  enabled)
var setInertiaScrollEnabled ( var  enabled)
local setInertiaScrollEnabled ( local  enabled)
void setInnerContainerSize ( const Size size)

Changes inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters
innercontainer size.
var setInnerContainerSize ( var  size)

Changes inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters
innercontainer size.
local setInnerContainerSize ( local  size)

Changes inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters
innercontainer size.
virtual void setLayoutType ( Type  type)
overridevirtual

Sets LayoutType.

See also
LayoutType
Parameters
LayoutType

Reimplemented from Layout.

var setLayoutType ( var  type)
overridevirtual

Sets LayoutType.

See also
LayoutType
Parameters
LayoutType

Reimplemented from Layout.

local setLayoutType ( local  type)
overridevirtual

Sets LayoutType.

See also
LayoutType
Parameters
LayoutType

Reimplemented from Layout.

void
startAutoScrollChildrenWithDestination
( const Vec2 des,
float  time,
bool  attenuated 
)
protected
var
startAutoScrollChildrenWithDestination
( var  des,
var  time,
var  attenuated 
)
protected
local
startAutoScrollChildrenWithDestination
( local  des,
local  time,
local  attenuated 
)
protected
void
startAutoScrollChildrenWithOriginalSpeed
( const Vec2 dir,
float  v,
bool  attenuated,
float  acceleration 
)
protected
var
startAutoScrollChildrenWithOriginalSpeed
( var  dir,
var  v,
var  attenuated,
var  acceleration 
)
protected
local
startAutoScrollChildren