ScrollView support for cocos2d-x. More...

#include <CCScrollView.h>

Inheritance diagram for ScrollView:

Public Types
enum	Direction { NONE = -1, HORIZONTAL = 0, VERTICAL, BOTH }

Public Member Functions
	ScrollView ()
virtual	~ScrollView ()
bool	init ()
bool	initWithViewSize (Size size, Node *container=NULL)
	Returns a scroll view object. More...

var	initWithViewSize ( var size, var NULL)
	Returns a scroll view object. More...

local	initWithViewSize ( local size, local NULL)
	Returns a scroll view object. More...

void	setContentOffset (Vec2 offset, bool animated=false)
	Sets a new content offset. More...

Vec2	getContentOffset ()
void	setContentOffsetInDuration (Vec2 offset, float dt)
	Sets a new content offset. More...

var	setContentOffsetInDuration ( var offset, var dt)
	Sets a new content offset. More...

local	setContentOffsetInDuration ( local offset, local dt)
	Sets a new content offset. More...

void	setZoomScale (float s)
void	setZoomScale (float s, bool animated)
	Sets a new scale and does that for a predefined duration. More...

var	setZoomScale ( var s, var animated)
	Sets a new scale and does that for a predefined duration. More...

local	setZoomScale ( local s, local animated)
	Sets a new scale and does that for a predefined duration. More...

float	getZoomScale ()
void	setZoomScaleInDuration (float s, float dt)
	Sets a new scale for container in a given duration. More...

var	setZoomScaleInDuration ( var s, var dt)
	Sets a new scale for container in a given duration. More...

local	setZoomScaleInDuration ( local s, local dt)
	Sets a new scale for container in a given duration. More...

Vec2	minContainerOffset ()
	Returns the current container's minimum offset. More...

Vec2	maxContainerOffset ()
	Returns the current container's maximum offset. More...

bool	isNodeVisible (Node *node)
	Determines if a given node's bounding box is in visible bounds. More...

void	pause (Ref *sender)
	Provided to make scroll view compatible with SWLayer's pause method. More...

void	resume (Ref *sender)
	Provided to make scroll view compatible with SWLayer's resume method. More...

void	setTouchEnabled (bool enabled)
bool	isTouchEnabled () const
bool	isDragging () const
bool	isTouchMoved () const
bool	isBounceable () const
var	isBounceable ()
local	isBounceable ()
void	setBounceable (bool bBounceable)
var	setBounceable ( var bBounceable)
local	setBounceable ( local bBounceable)
Size	getViewSize () const
	size to clip. More...

void	setViewSize (Size size)
Node *	getContainer ()
void	setContainer (Node *pContainer)
var	setContainer ( var pContainer)
local	setContainer ( local pContainer)
Direction	getDirection () const
	direction allowed to scroll. More...

virtual void	setDirection (Direction eDirection)
local	setDirection ( local eDirection)
ScrollViewDelegate *	getDelegate ()
void	setDelegate (ScrollViewDelegate *pDelegate)
void	updateInset ()
bool	isClippingToBounds ()
	Determines whether it clips its children or not. More...

var	isClippingToBounds ()
	Determines whether it clips its children or not. More...

local	isClippingToBounds ()
	Determines whether it clips its children or not. More...

void	setClippingToBounds (bool bClippingToBounds)
var	setClippingToBounds ( var bClippingToBounds)
local	setClippingToBounds ( local bClippingToBounds)
virtual bool	onTouchBegan (Touch touch, Event event)
virtual void	onTouchMoved (Touch touch, Event event)
local	onTouchMoved ( local touch, local event)
virtual void	onTouchEnded (Touch touch, Event event)
var	onTouchEnded ( var touch, var event)
local	onTouchEnded ( local touch, local event)
virtual void	onTouchCancelled (Touch touch, Event event)
local	onTouchCancelled ( local touch, local event)
virtual void	setContentSize (const Size &size) override
	Sets the untransformed size of the node. More...

virtual const Size &	getContentSize () const override
	Returns the untransformed size of the node. More...

virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, bool parentTransformUpdated) override
	Visits this node's children and draw them recursively. More...

virtual void	addChild (Node *child, int zOrder, int tag) override
	Adds a child to the container with z order and tag. More...

void	updateTweenAction (float value, const std::string &key)
	CCActionTweenDelegate. More...

var	updateTweenAction ( var value, var key)
	CCActionTweenDelegate. More...

local	updateTweenAction ( local value, local key)
	CCActionTweenDelegate. More...

Public Member Functions inherited from Layer
virtual CC_DEPRECATED_ATTRIBUTE bool	ccTouchBegan (Touch pTouch, Event pEvent) final
local	ccTouchBegan ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchMoved (Touch pTouch, Event pEvent) final
local	ccTouchMoved ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchEnded (Touch pTouch, Event pEvent) final
var	ccTouchEnded ( var pTouch, var pEvent)
local	ccTouchEnded ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchCancelled (Touch pTouch, Event pEvent) final
local	ccTouchCancelled ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesBegan (__Set pTouches, Event pEvent) final
local	ccTouchesBegan ( local pTouches, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesMoved (__Set pTouches, Event pEvent) final
local	ccTouchesMoved ( local pTouches, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesEnded (__Set pTouches, Event pEvent) final
var	ccTouchesEnded ( var pTouches, var pEvent)
local	ccTouchesEnded ( local pTouches, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesCancelled (__Set pTouches, Event pEvent) final
local	ccTouchesCancelled ( local pTouches, local pEvent)
virtual void	onTouchesBegan (const std::vector< Touch * > &touches, Event *unused_event)
var	onTouchesBegan ( var touches, var unused_event)
local	onTouchesBegan ( local touches, local unused_event)
virtual void	onTouchesMoved (const std::vector< Touch * > &touches, Event *unused_event)
var	onTouchesMoved ( var touches, var unused_event)
local	onTouchesMoved ( local touches, local unused_event)
virtual void	onTouchesEnded (const std::vector< Touch * > &touches, Event *unused_event)
var	onTouchesEnded ( var touches, var unused_event)
local	onTouchesEnded ( local touches, local unused_event)
virtual void	onTouchesCancelled (const std::vector< Touch * > &touches, Event *unused_event)
local	onTouchesCancelled ( local touches, local unused_event)
virtual CC_DEPRECATED_ATTRIBUTE void	didAccelerate (Acceleration *accelerationValue) final
local	didAccelerate ( local accelerationValue)
virtual void	onAcceleration (Acceleration acc, Event unused_event)
var	onAcceleration ( var acc, var unused_event)
local	onAcceleration ( local acc, local unused_event)
virtual CC_DEPRECATED_ATTRIBUTE void	registerWithTouchDispatcher () final
	If isTouchEnabled, this method is called onEnter. More...

local	registerWithTouchDispatcher ()
	If isTouchEnabled, this method is called onEnter. More...

CC_DEPRECATED_ATTRIBUTE bool	isTouchEnabled () const
	whether or not it will receive Touch events. More...

CC_DEPRECATED_ATTRIBUTE void	setTouchEnabled (bool value)
var	setTouchEnabled ( var value)
local	setTouchEnabled ( local value)
virtual CC_DEPRECATED_ATTRIBUTE void	setTouchMode (Touch::DispatchMode mode)
local	setTouchMode ( local mode)
virtual CC_DEPRECATED_ATTRIBUTE Touch::DispatchMode	getTouchMode () const
local	getTouchMode ()
virtual CC_DEPRECATED_ATTRIBUTE void	setSwallowsTouches (bool swallowsTouches)
	swallowsTouches of the touch events. More...

local	setSwallowsTouches ( local swallowsTouches)
	swallowsTouches of the touch events. More...

virtual CC_DEPRECATED_ATTRIBUTE bool	isSwallowsTouches () const
local	isSwallowsTouches ()
virtual CC_DEPRECATED_ATTRIBUTE bool	isAccelerometerEnabled () const
	whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property. More...

var	isAccelerometerEnabled ()
	whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property. More...

local	isAccelerometerEnabled ()
	whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property. More...

virtual CC_DEPRECATED_ATTRIBUTE void	setAccelerometerEnabled (bool value)
var	setAccelerometerEnabled ( var value)
local	setAccelerometerEnabled ( local value)
virtual CC_DEPRECATED_ATTRIBUTE void	setAccelerometerInterval (double interval)
local	setAccelerometerInterval ( local interval)
virtual CC_DEPRECATED_ATTRIBUTE bool	isKeyboardEnabled () const
	whether or not it will receive keyboard or keypad events You can enable / disable accelerometer events with this property. More...

local	isKeyboardEnabled ()
	whether or not it will receive keyboard or keypad events You can enable / disable accelerometer events with this property. More...

virtual CC_DEPRECATED_ATTRIBUTE void	setKeyboardEnabled (bool value)
local	setKeyboardEnabled ( local value)
virtual CC_DEPRECATED_ATTRIBUTE void	keyPressed (int keyCode) final
	Please use onKeyPressed instead. More...

local	keyPressed ( local keyCode)
	Please use onKeyPressed instead. More...

virtual CC_DEPRECATED_ATTRIBUTE void	keyReleased (int keyCode) final
	Please use onKeyReleased instead. More...

local	keyReleased ( local keyCode)
	Please use onKeyReleased instead. More...

virtual void	onKeyPressed (EventKeyboard::KeyCode keyCode, Event *event)
var	onKeyPressed ( var keyCode, var event)
local	onKeyPressed ( local keyCode, local event)
virtual void	onKeyReleased (EventKeyboard::KeyCode keyCode, Event *event)
var	onKeyReleased ( var keyCode, var event)
local	onKeyReleased ( local keyCode, local event)
virtual CC_DEPRECATED_ATTRIBUTE bool	isKeypadEnabled () const final
local	isKeypadEnabled ()
virtual CC_DEPRECATED_ATTRIBUTE void	setKeypadEnabled (bool value)
local	setKeypadEnabled ( local value)
virtual CC_DEPRECATED_ATTRIBUTE void	keyBackClicked () final
var	keyBackClicked ()
local	keyBackClicked ()
virtual CC_DEPRECATED_ATTRIBUTE void	keyMenuClicked () final
local	keyMenuClicked ()
virtual std::string	getDescription () const override
	Gets the description string. More...

local	getDescription ()
	Gets the description string. More...

virtual	~Layer ()
var	~Layer ()
local	~Layer ()
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	cleanup ()
	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	draw (Renderer *renderer, const Mat4 &transform, bool transformUpdated)
	Override this method to draw your own node. More...

local	draw ( local renderer, local transform, local transformUpdated)
	Override this method to draw your own node. More...

virtual void	draw () final
var	draw ()
local	draw ()
virtual void	visit () final
virtual Scene *	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 CC_DEPRECATED_ATTRIBUTE Rect	boundingBox () const
local	boundingBox ()
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
var	setEventDispatcher ( var dispatcher)
local	setEventDispatcher ( local dispatcher)
virtual EventDispatcher *	getEventDispatcher () const
local	getEventDispatcher ()
virtual GLubyte	getOpacity () const
var	getOpacity ()
local	getOpacity ()
virtual GLubyte	getDisplayedOpacity () const
local	getDisplayedOpacity ()
virtual void	setOpacity (GLubyte opacity)
local	setOpacity ( local opacity)
virtual void	updateDisplayedOpacity (GLubyte parentOpacity)
var	updateDisplayedOpacity ( var parentOpacity)
local	updateDisplayedOpacity ( local parentOpacity)
virtual bool	isCascadeOpacityEnabled () const
var	isCascadeOpacityEnabled ()
local	isCascadeOpacityEnabled ()
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const Color3B &	getColor (void) const
local	getColor ()
virtual const Color3B &	getDisplayedColor () const
local	getDisplayedColor ()
virtual void	setColor (const Color3B &color)
var	setColor ( var color)
local	setColor ( local color)
virtual void	updateDisplayedColor (const Color3B &parentColor)
local	updateDisplayedColor ( local parentColor)
virtual bool	isCascadeColorEnabled () const
var	isCascadeColorEnabled ()
local	isCascadeColorEnabled ()
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void	setOpacityModifyRGB (bool bValue)
var	setOpacityModifyRGB ( var bValue)
local	setOpacityModifyRGB ( local bValue)
virtual bool	isOpacityModifyRGB () const
var	isOpacityModifyRGB ()
local	isOpacityModifyRGB ()
virtual	~Node ()
var	~Node ()
local	~Node ()
virtual void	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...

var	setLocalZOrder ( var 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 CC_DEPRECATED_ATTRIBUTE void	setZOrder (int localZOrder)
local	setZOrder ( local 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...

local	getLocalZOrder ()
	Gets the local Z order of this node. More...

virtual CC_DEPRECATED_ATTRIBUTE int	getZOrder () const
local	getZOrder ()
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	setScaleX (float scaleX)
	Sets the scale (x) of the node. More...

local	setScaleX ( local scaleX)
	Sets the scale (x) of the node. More...

virtual float	getScaleX () const
	Returns the scale factor on X axis of this node. More...

virtual void	setScaleY (float scaleY)
	Sets the scale (y) of the node. More...

local	setScaleY ( local scaleY)
	Sets the scale (y) of the node. More...

virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node. More...

virtual void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node. More...

local	setScaleZ ( local scaleZ)
	Changes the scale factor on Z axis of this node. More...

virtual float	getScaleZ () const
	Returns the scale factor on Z axis of this node. More...

virtual void	setScale (float scale)
	Sets the scale (x,y,z) of the node. More...

var	setScale ( var scale)
	Sets the scale (x,y,z) of the node. More...

local	setScale ( local scale)
	Sets the scale (x,y,z) of the node. More...

virtual float	getScale () const
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

virtual void	setScale (float scaleX, float scaleY)
	Sets the scale (x,y) of the node. More...

local	setScale ( local scaleX, local scaleY)
	Sets the scale (x,y) of the node. More...

virtual void	setPosition (const Vec2 &position)
	Sets the position (x,y) of the node in its parent's coordinate system. More...

virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. 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...

var	getPosition ( var x, var y)
	Gets position in a more efficient way, returns two number instead of a Vec2 object. More...

local	getPosition ( local x, local y)
	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
var	getPositionX ()
local	getPositionX ()
virtual void	setPositionY (float y)
local	setPositionY ( local y)
virtual float	getPositionY (void) const
local	getPositionY ()
virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...

local	setPosition3D ( local 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 CC_DEPRECATED_ATTRIBUTE void	setVertexZ (float vertexZ)
local	setVertexZ ( local vertexZ)
virtual float	getPositionZ () const
	Gets position Z coordinate of this node. More...

virtual CC_DEPRECATED_ATTRIBUTE float	getVertexZ () const
local	getVertexZ ()
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...

local	getSkewX ()
	Returns the X skew angle of the node in degrees. More...

virtual void	setSkewY (float skewY)
	Changes the Y skew angle of the node in degrees. More...

local	setSkewY ( local skewY)
	Changes the Y skew angle of the node in degrees. More...

virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees. More...

virtual void	setAnchorPoint (const Vec2 &anchorPoint)
	Sets the anchor point in percent. More...

local	setAnchorPoint ( local anchorPoint)
	Sets the anchor point in percent. More...

virtual const Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent. More...

virtual const Vec2 &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

local	setVisible ( local visible)
	Sets whether the node is visible. More...

virtual bool	isVisible () const
	Determines if the node is visible. More...

virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...

var	setRotation ( var 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...

var	getRotation3D ()
	returns the rotation (X,Y,Z) in degrees. More...

local	getRotation3D ()
	returns the rotation (X,Y,Z) in degrees. 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 CC_DEPRECATED_ATTRIBUTE void	setRotationX (float 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...

virtual CC_DEPRECATED_ATTRIBUTE float	getRotationX () const
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 CC_DEPRECATED_ATTRIBUTE void	setRotationY (float rotationY)
local	setRotationY ( local rotationY)
virtual float	getRotationSkewY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual CC_DEPRECATED_ATTRIBUTE float	getRotationY () const
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...

CC_DEPRECATED_ATTRIBUTE void	setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE 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...

virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0. More...

var	addChild ( var child)
	Adds a child to the container with z-order as 0. More...

local	addChild ( local child)
	Adds a child to the container with z-order as 0. More...

virtual void	addChild (Node *child, int localZOrder)
	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 Node *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual Vector< Node * > &	getChildren ()
	Returns the array of the node's children. More...

local	getChildren ()
	Returns the array of the node's children. More...

virtual const Vector< Node * > &	getChildren () const
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Returns the amount of children. More...

virtual void	setParent (Node *parent)
	Sets the parent node. More...

local	setParent ( local parent)
	Sets the parent node. More...

virtual Node *	getParent ()
	Returns a pointer to the parent node. More...

virtual const Node *	getParent () const
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	removeChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...

local	removeChild ( local child, local true)
	Removes a child from the container. 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	removeAllChildren ()
	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)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	reorderChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...

var	reorderChild ( var child, var 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 void *	getUserData ()
	Returns a custom user data pointer. More...

virtual const void *	getUserData () const
virtual void	setUserData (void *userData)
	Sets a custom user data pointer. More...

virtual Ref *	getUserObject ()
	Returns a user assigned Object. More...

virtual const Ref *	getUserObject () const
virtual void	setUserObject (Ref *userObject)
	Returns a user assigned Object. More...

local	setUserObject ( local userObject)
	Returns a user assigned Object. More...

GLProgram *	getGLProgram ()
	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...

CC_DEPRECATED_ATTRIBUTE GLProgram *	getShaderProgram ()
local	getShaderProgram ()
GLProgramState *	getGLProgramState ()
var	getGLProgramState ()
local	getGLProgramState ()
void	setGLProgramState (GLProgramState *glProgramState)
var	setGLProgramState ( var glProgramState)
local	setGLProgramState ( local glProgramState)
void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...

CC_DEPRECATED_ATTRIBUTE void	setShaderProgram (GLProgram *glprogram)
local	setShaderProgram ( local glprogram)
virtual void	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'. More...

virtual void	onEnterTransitionDidFinish ()
	Event callback that is invoked when the Node enters in the 'stage'. More...

virtual void	onExit ()
	Event callback that is invoked every time the Node leaves the 'stage'. More...

virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the Node leaves the 'stage'. More...

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 ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

local	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

virtual const ActionManager *	getActionManager () const
local	getActionManager ()
Action *	runAction (Action *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...

var	stopAllActions ()
	Stops and removes all actions from the running action list . More...

local	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...

Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...

ssize_t	getNumberOfRunningActions () const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

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...

CC_DEPRECATED_ATTRIBUTE ssize_t	numberOfRunningActions () const
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...

virtual Scheduler *	getScheduler ()
	Gets a Sheduler object. More...

virtual const Scheduler *	getScheduler () const
local	getScheduler ()
bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...

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...

void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame. More...

void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...

void	unscheduleAllSelectors (void)
	Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...

void	resume (void)
	Resumes all scheduled selectors, actions and event listeners. More...

var	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...

local	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...

void	pause (void)
	Pauses all scheduled selectors, actions and event listeners. More...

var	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...

local	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...

CC_DEPRECATED_ATTRIBUTE void	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors, actions and event listeners. More...

local	resumeSchedulerAndActions ()
	Resumes all scheduled selectors, actions and event listeners. More...

CC_DEPRECATED_ATTRIBUTE void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors, actions and event listeners. More...

local	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...

virtual void	update (float delta)
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 Mat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual AffineTransform	getNodeToParentAffineTransform () const
local	getNodeToParentAffineTransform ()
virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the Transformation matrix manually. More...

local	setNodeToParentTransform ( local transform)
	Sets the Transformation matrix manually. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const Mat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

virtual AffineTransform	getParentToNodeAffineTransform () const
local	getParentToNodeAffineTransform ()
virtual CC_DEPRECATED_ATTRIBUTE 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 CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...

virtual AffineTransform	getWorldToNodeAffineTransform () const
local	getWorldToNodeAffineTransform ()
virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...

Vec2	convertToWorldSpace (const Vec2 &nodePoint) const
	Converts a Vec2 to world space coordinates. More...

Vec2	convertToNodeSpaceAR (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...

Vec2	convertToWorldSpaceAR (const Vec2 &nodePoint) const
	Converts a local Vec2 to world space coordinates.The result is in Points. More...

Vec2	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Vec2 More...

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...

var	setAdditionalTransform ( var 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)
Component *	getComponent (const std::string &pName)
	gets a component by its name More...

local	getComponent ( local pName)
	gets a component by its name More...

virtual bool	addComponent (Component *pComponent)
	adds a component More...

local	addComponent ( local pComponent)
	adds a component More...

virtual bool	removeComponent (const std::string &pName)
	removes a component by its name More...

local	removeComponent ( local pName)
	removes a component by its name 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...

Ref *	autorelease ()
	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 ActionTweenDelegate
virtual	~ActionTweenDelegate ()

Static Public Member Functions
static ScrollView *	create (Size size, Node *container=NULL)
	Returns an autoreleased scroll view object. More...

static ScrollView *	create ()
	Returns an autoreleased scroll view object. More...

Static Public Member Functions inherited from Layer
static Layer *	create ()
	creates a fullscreen black layer More...

var	create ()
	creates a fullscreen black layer More...

local	create ()
	creates a fullscreen black layer More...

Static Public Member Functions inherited from Node
static Node *	create (void)
	Allocates and initializes a node. More...

var	create ()
	Allocates and initializes a node. More...

local	create ()
	Allocates and initializes a node. More...

Protected Member Functions
void	relocateContainer (bool animated)
	Relocates the container at the proper offset, in bounds of max/min offsets. More...

void	deaccelerateScrolling (float dt)
	implements auto-scrolling behavior. More...

void	performedAnimatedScroll (float dt)
	This method makes sure auto scrolling causes delegate to invoke its method. More...

void	stoppedAnimatedScroll (Node *node)
	Expire animated scroll delegate calls. More...

void	beforeDraw ()
	clip this view so that outside of the visible bounds can be hidden. More...

void	onBeforeDraw ()
void	afterDraw ()
	retract what's done in beforeDraw so that there's no side effect to other nodes. More...

void	onAfterDraw ()
void	handleZoom ()
	Zoom handling. More...

var	handleZoom ()
	Zoom handling. More...

local	handleZoom ()
	Zoom handling. More...

Rect	getViewRect ()
var	getViewRect ()
local	getViewRect ()
Protected Member Functions inherited from Layer
void	_addTouchListener ()
var	_addTouchListener ()
local	_addTouchListener ()
CC_DEPRECATED_ATTRIBUTE void	addTouchListener ()
local	addTouchListener ()
CC_DEPRECATED_ATTRIBUTE int	executeScriptTouchHandler (EventTouch::EventCode eventType, Touch touch, Event event)
local	executeScriptTouchHandler ( local eventType, local touch, local event)
CC_DEPRECATED_ATTRIBUTE int	executeScriptTouchesHandler (EventTouch::EventCode eventType, const std::vector< Touch * > &touches, Event *event)
var	executeScriptTouchesHandler ( var eventType, var touches, var event)
local	executeScriptTouchesHandler ( local eventType, local touches, local event)
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...

Vec2	convertToWindowSpace (const Vec2 &nodePoint) const
	Convert cocos2d coordinates to UI windows coordinate. More...

Mat4	transform (const Mat4 &parentTransform)
var	transform ( var parentTransform)
local	transform ( local parentTransform)
virtual void	updateCascadeOpacity ()
var	updateCascadeOpacity ()
local	updateCascadeOpacity ()
virtual void	disableCascadeOpacity ()
var	disableCascadeOpacity ()
local	disableCascadeOpacity ()
virtual void	updateCascadeColor ()
local	updateCascadeColor ()
virtual void	disableCascadeColor ()
local	disableCascadeColor ()
virtual void	updateColor ()
var	updateColor ()
local	updateColor ()
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes
float	_zoomScale
	current zoom scale More...

local	_zoomScale
	current zoom scale More...

float	_minZoomScale
	min zoom scale More...

float	_maxZoomScale
	max zoom scale More...

ScrollViewDelegate *	_delegate
	scroll view delegate More...

var	_delegate
	scroll view delegate More...

local	_delegate
	scroll view delegate More...

Direction	_direction
bool	_dragging
	If YES, the view is being dragged. More...

Vec2	_contentOffset
	Content offset. More...

Node *	_container
	Container holds scroll view contents, Sets the scrollable container object of the scroll view. More...

bool	_touchMoved
	Determiens whether user touch is moved after begin phase. More...

Vec2	_maxInset
	max inset point to limit scrolling by touch More...

Vec2	_minInset
	min inset point to limit scrolling by touch More...

bool	_bounceable
	Determines whether the scroll view is allowed to bounce or not. More...

bool	_clippingToBounds
Vec2	_scrollDistance
	scroll speed More...

Vec2	_touchPoint
	Touch point. More...

float	_touchLength
	length between two fingers More...

std::vector< Touch * >	_touches
	Touch objects to detect multitouch. More...

var	_touches
	Touch objects to detect multitouch. More...

local	_touches
	Touch objects to detect multitouch. More...

Size	_viewSize
	size to clip. More...

float	_minScale
	max and min scale More...

float	_maxScale
Rect	_parentScissorRect
	scissor rect for parent, just for restoring GL_SCISSOR_BOX More...

var	_parentScissorRect
	scissor rect for parent, just for restoring GL_SCISSOR_BOX More...

local	_parentScissorRect
	scissor rect for parent, just for restoring GL_SCISSOR_BOX More...

bool	_scissorRestored
EventListenerTouchOneByOne *	_touchListener
	Touch listener. More...

var	_touchListener
	Touch listener. More...

local	_touchListener
	Touch listener. More...

CustomCommand	_beforeDrawCommand
CustomCommand	_afterDrawCommand
Protected Attributes inherited from Layer
bool	_touchEnabled
var	_touchEnabled
local	_touchEnabled
bool	_accelerometerEnabled
var	_accelerometerEnabled
local	_accelerometerEnabled
bool	_keyboardEnabled
var	_keyboardEnabled
local	_keyboardEnabled
EventListener *	_touchListener
var	_touchListener
local	_touchListener
EventListenerKeyboard *	_keyboardListener
var	_keyboardListener
local	_keyboardListener
EventListenerAcceleration *	_accelerationListener
var	_accelerationListener
local	_accelerationListener
Touch::DispatchMode	_touchMode
local	_touchMode
bool	_swallowsTouches
var	_swallowsTouches
local	_swallowsTouches
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...

float	_scaleX
	scaling factor on x-axis More...

var	_scaleX
	scaling factor on x-axis More...

local	_scaleX
	scaling factor on x-axis More...

float	_scaleY
	scaling factor on y-axis More...

var	_scaleY
	scaling factor on y-axis More...

local	_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...

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...

var	_contentSize
	untransformed size of the node More...

local	_contentSize
	untransformed size of the node 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...

var	_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...

var	_transformUpdated
	Whether or not the Transform object was updated since the last frame. More...

local	_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...

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...

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...

Scheduler *	_scheduler
	scheduler used to schedule timers and updates More...

var	_scheduler
	scheduler used to schedule timers and updates More...

local	_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...

var	_reorderChildDirty
	children order dirty flag More...

local	_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...

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
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Additional Inherited Members
Public Attributes inherited from Layer
CC_CONSTRUCTOR_ACCESS	__pad0__: Layer()
var	__pad0__: Layer()
local	__pad0__: Layer()
Public Attributes inherited from Node
CC_CONSTRUCTOR_ACCESS	__pad0__: Node()
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 Node
static int	s_globalOrderOfArrival
var	s_globalOrderOfArrival
local	s_globalOrderOfArrival

Detailed Description

ScrollView support for cocos2d-x.

It provides scroll view functionalities to cocos2d projects natively.

Member Enumeration Documentation

enum Direction

strong

Enumerator
NONE
HORIZONTAL
VERTICAL
BOTH

Constructor & Destructor Documentation

ScrollView ( )

virtual ~ScrollView ( )

virtual

Member Function Documentation

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

child	A child node
zOrder	Z order for drawing priority. Please refer to `setLocalZOrder(int)`
tag	An integer to identify the node easily. Please refer to `setTag(int)`

Reimplemented from Node.

void afterDraw ( )

protected

retract what's done in beforeDraw so that there's no side effect to other nodes.

void beforeDraw ( )

protected

clip this view so that outside of the visible bounds can be hidden.

static ScrollView* create	(	Size	size,
		Node *	container = `NULL`
	)

static

Returns an autoreleased scroll view object.

Parameters

size	view size
container	parent object

Returns: autoreleased scroll view object

static ScrollView* create ( )

static

Returns an autoreleased scroll view object.

Returns: autoreleased scroll view object

void deaccelerateScrolling ( float dt )

protected

implements auto-scrolling behavior.

change SCROLL_DEACCEL_RATE as needed to choose deacceleration speed. it must be less than 1.0f.

Parameters

dt delta

Node* getContainer ( )

Vec2 getContentOffset ( )

virtual const Size& getContentSize ( ) const

overridevirtual

Returns the untransformed size of the node.

See also: setContentSize(const Size&)

Returns: The untransformed size of the node.

Reimplemented from Node.

ScrollViewDelegate* getDelegate ( )

inline

Direction getDirection ( ) const

inline

direction allowed to scroll.

ScrollViewDirectionBoth by default.

Rect getViewRect ( )

protected

Size getViewSize ( ) const

inline

size to clip.

Node boundingBox uses contentSize directly. It's semantically different what it actually means to common scroll views. Hence, this scroll view will use a separate size property.

float getZoomScale ( )

void handleZoom ( )

protected

Zoom handling.

bool init ( )

virtual

Reimplemented from Layer.

bool initWithViewSize	(	Size	size,
		Node *	container = `NULL`
	)

Returns a scroll view object.

Parameters

size	view size
container	parent object

Returns: scroll view object

bool isBounceable ( ) const

inline

bool isClippingToBounds ( )

inline

Determines whether it clips its children or not.

bool isDragging ( ) const

inline

bool isNodeVisible ( Node * node )

Determines if a given node's bounding box is in visible bounds.

Returns: true if it is in visible bounds

bool isTouchEnabled ( ) const

bool isTouchMoved ( ) const

inline

Vec2 maxContainerOffset ( )

Returns the current container's maximum offset.

You may want this while you animate scrolling by yourself

Vec2 minContainerOffset ( )

Returns the current container's minimum offset.

You may want this while you animate scrolling by yourself

void onAfterDraw ( )

protected

void onBeforeDraw ( )

protected

virtual bool onTouchBegan	(	Touch *	touch,
		Event *	event
	)

virtual

Reimplemented from Layer.

Reimplemented in TableView.

virtual void onTouchCancelled	(	Touch *	touch,
		Event *	event
	)

virtual

Reimplemented from Layer.

Reimplemented in TableView.

virtual void onTouchEnded	(	Touch *	touch,
		Event *	event
	)

virtual

Reimplemented from Layer.

Reimplemented in TableView.

virtual void onTouchMoved	(	Touch *	touch,
		Event *	event
	)

virtual

Reimplemented from Layer.

Reimplemented in TableView.

void pause ( Ref * sender )

Provided to make scroll view compatible with SWLayer's pause method.

void performedAnimatedScroll ( float dt )

protected

This method makes sure auto scrolling causes delegate to invoke its method.

void relocateContainer ( bool animated )

protected

Relocates the container at the proper offset, in bounds of max/min offsets.

Parameters

animated If true, relocation is animated

void resume ( Ref * sender )

Provided to make scroll view compatible with SWLayer's resume method.

void setBounceable ( bool bBounceable )

inline

void setClippingToBounds ( bool bClippingToBounds )

inline

void setContainer ( Node * pContainer )

void setContentOffset	(	Vec2	offset,
		bool	animated = `false`
	)

Sets a new content offset.

It ignores max/min offset. It just sets what's given. (just like UIKit's UIScrollView)

Parameters

offset	The new offset.
animated	If true, the view will scroll to the new offset.

void setContentOffsetInDuration	(	Vec2	offset,
		float	dt
	)

Sets a new content offset.

It ignores max/min offset. It just sets what's given. (just like UIKit's UIScrollView) You can override the animation duration with this method.

Parameters

offset	The new offset.
dt	The animation duration.

virtual void setContentSize ( const Size & contentSize )

overridevirtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters

contentSize The untransformed size of the node.

Reimplemented from Node.

void setDelegate ( ScrollViewDelegate * pDelegate )

inline

when this function bound to js or lua,the input param are changed
in js: var setDelegate(var jsObject)
in lua: local setDelegate()

virtual void setDirection ( Direction eDirection )

inlinevirtual

void setTouchEnabled ( bool enabled )

void setViewSize ( Size size )

void setZoomScale ( float s )

void setZoomScale	(	float	s,
		bool	animated
	)

Sets a new scale and does that for a predefined duration.

Parameters

s	The new scale vale
animated	If true, scaling is animated

void setZoomScaleInDuration	(	float	s,
		float	dt
	)

Sets a new scale for container in a given duration.

Parameters

s	The new scale value
dt	The animation duration

void stoppedAnimatedScroll ( Node * node )

protected

Expire animated scroll delegate calls.

void updateInset ( )

void updateTweenAction	(	float	value,
		const std::string &	key
	)

virtual

CCActionTweenDelegate.

Implements ActionTweenDelegate.

virtual void visit	(	Renderer *	renderer,
		const Mat4 &	parentTransform,
		bool	parentTransformUpdated
	)

overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from Node.

Member Data Documentation

CustomCommand _afterDrawCommand

protected

CustomCommand _beforeDrawCommand

protected

bool _bounceable

protected

Determines whether the scroll view is allowed to bounce or not.

bool _clippingToBounds

protected

Node* _container

protected

Container holds scroll view contents, Sets the scrollable container object of the scroll view.

Vec2 _contentOffset

protected

Content offset.

Note that left-bottom point is the origin

ScrollViewDelegate* _delegate

protected

scroll view delegate

Direction _direction

protected

bool _dragging

protected

If YES, the view is being dragged.

Vec2 _maxInset

protected

max inset point to limit scrolling by touch

float _maxScale

protected

float _maxZoomScale

protected

max zoom scale

Vec2 _minInset

protected

min inset point to limit scrolling by touch

float _minScale

protected

max and min scale

float _minZoomScale

protected

min zoom scale

Rect _parentScissorRect

protected

scissor rect for parent, just for restoring GL_SCISSOR_BOX

bool _scissorRestored

protected

Vec2 _scrollDistance

protected

scroll speed

std::vector<Touch*> _touches

protected

Touch objects to detect multitouch.

float _touchLength

protected

length between two fingers

EventListenerTouchOneByOne*
_touchListener

protected

Touch listener.

bool _touchMoved

protected

Determiens whether user touch is moved after begin phase.

Vec2 _touchPoint

protected

Touch point.

Size _viewSize

protected

size to clip.

Node boundingBox uses contentSize directly. It's semantically different what it actually means to common scroll views. Hence, this scroll view will use a separate size property.

float _zoomScale

protected

current zoom scale

The documentation for this class was generated from the following file:

/Users/guanghui/cocos2d-x/extensions/GUI/CCScrollView/CCScrollView.h

local initWithViewSize	(	local	size,
		local	container = `NULL`
	)

local setContentOffset	(	local	offset,
		local	animated = `false`
	)

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation