#include <CCScrollView.h>

Inheritance diagram for CCScrollView:

Public Types
enum	ScrollViewScriptEventType { kScrollViewScroll = 0, kScrollViewZoom }

Public Member Functions
	CCScrollView ()
virtual	~CCScrollView ()
bool	init ()
	Initializes the instance of CCNode. More...

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

bool	initWithViewSize (CCSize size, CCNode *container=NULL)
	Returns a scroll view object. More...

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

CCPoint	getContentOffset ()
void	setContentOffsetInDuration (CCPoint offset, float 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...

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

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

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

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

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

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

bool	isDragging ()
bool	isTouchMoved ()
bool	isBounceable ()
void	setBounceable (bool bBounceable)
CCSize	getViewSize ()
	size to clip. More...

void	setViewSize (CCSize size)
CCNode *	getContainer ()
void	setContainer (CCNode *pContainer)
CCScrollViewDirection	getDirection ()
	direction allowed to scroll. More...

virtual void	setDirection (CCScrollViewDirection eDirection)
CCScrollViewDelegate *	getDelegate ()
void	setDelegate (CCScrollViewDelegate *pDelegate)
virtual bool	ccTouchBegan (CCTouch pTouch, CCEvent pEvent)
	override functions More...

virtual void	ccTouchMoved (CCTouch pTouch, CCEvent pEvent)
virtual void	ccTouchEnded (CCTouch pTouch, CCEvent pEvent)
virtual void	ccTouchCancelled (CCTouch pTouch, CCEvent pEvent)
virtual void	setContentSize (const CCSize &size)
	Sets the untransformed size of the node. More...

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

void	updateInset ()
bool	isClippingToBounds ()
	Determines whether it clips its children or not. More...

void	setClippingToBounds (bool bClippingToBounds)
virtual void	visit ()
	Visits this node's children and draw them recursively. More...

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

virtual void	addChild (CCNode *child, int zOrder)
	Adds a child to the container with a z-order. More...

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

void	setTouchEnabled (bool e)
void	registerScriptHandler (int nFunID, int nScriptEventType)
void	unregisterScriptHandler (int nScriptEventType)
int	getScriptHandler (int nScriptEventType)
Public Member Functions inherited from CCLayer
	CCLayer ()
virtual	~CCLayer ()
virtual void	onEnter ()
	Event callback that is invoked every time when CCNode enters the 'stage'. More...

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

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

virtual void	ccTouchesBegan (CCSet pTouches, CCEvent pEvent)
virtual void	ccTouchesMoved (CCSet pTouches, CCEvent pEvent)
virtual void	ccTouchesEnded (CCSet pTouches, CCEvent pEvent)
virtual void	ccTouchesCancelled (CCSet pTouches, CCEvent pEvent)
var	ccTouchesCancelled ( var pTouches, var pEvent)
local	ccTouchesCancelled ( local pTouches, local pEvent)
virtual void	didAccelerate (CCAcceleration *pAccelerationValue)
void	registerScriptAccelerateHandler (int nHandler)
void	unregisterScriptAccelerateHandler (void)
virtual void	registerScriptTouchHandler (int nHandler, bool bIsMultiTouches=false, int nPriority=INT_MIN, bool bSwallowsTouches=false)
	Register script touch events handler. More...

local	registerScriptTouchHandler ( local nHandler, local false, local INT_MIN, local false)
	Register script touch events handler. More...

virtual void	unregisterScriptTouchHandler (void)
	Unregister script touch events handler. More...

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

virtual void	setTouchMode (ccTouchesMode mode)
local	setTouchMode ( local mode)
virtual int	getTouchMode ()
virtual void	setTouchPriority (int priority)
	priority of the touch events. More...

local	setTouchPriority ( local priority)
	priority of the touch events. More...

virtual int	getTouchPriority ()
virtual bool	isAccelerometerEnabled ()
	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 void	setAccelerometerEnabled (bool value)
var	setAccelerometerEnabled ( var value)
local	setAccelerometerEnabled ( local value)
virtual void	setAccelerometerInterval (double interval)
local	setAccelerometerInterval ( local interval)
virtual bool	isKeypadEnabled ()
	whether or not it will receive keypad events You can enable / disable accelerometer events with this property. More...

virtual void	setKeypadEnabled (bool value)
local	setKeypadEnabled ( local value)
void	registerScriptKeypadHandler (int nHandler)
	Register keypad events handler. More...

void	unregisterScriptKeypadHandler (void)
	Unregister keypad events handler. More...

virtual void	keyBackClicked (void)
virtual void	keyMenuClicked (void)
local	keyMenuClicked ()
CCTouchScriptHandlerEntry *	getScriptTouchHandlerEntry ()
local	getScriptTouchHandlerEntry ()
CCScriptHandlerEntry *	getScriptKeypadHandlerEntry ()
CCScriptHandlerEntry *	getScriptAccelerateHandlerEntry ()
Public Member Functions inherited from CCNode
virtual CCCamera *	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...

virtual bool	isRunning ()
	Returns whether or not the node accepts event callbacks. More...

virtual void	cleanup (void)
	Stops all running actions and schedulers. More...

virtual void	draw (void)
	Override this method to draw your own node. More...

virtual CCRect	boundingBox (void)
	Returns a "local" axis aligned bounding box of the node. More...

virtual void	setZOrder (int zOrder)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	_setZOrder (int z)
	Sets the z order which stands for the drawing order. More...

var	_setZOrder ( var z)
	Sets the z order which stands for the drawing order. More...

local	_setZOrder ( local z)
	Sets the z order which stands for the drawing order. More...

virtual int	getZOrder ()
	Gets the Z order of this node. More...

virtual void	setVertexZ (float vertexZ)
	Sets the real OpenGL Z vertex. More...

local	setVertexZ ( local vertexZ)
	Sets the real OpenGL Z vertex. More...

virtual float	getVertexZ ()
	Gets OpenGL Z vertex of this node. More...

var	getVertexZ ()
	Gets OpenGL Z vertex of this node. More...

local	getVertexZ ()
	Gets OpenGL Z vertex of this node. More...

virtual void	setScaleX (float fScaleX)
	Changes the scale factor on X axis of this node. More...

local	setScaleX ( local fScaleX)
	Changes the scale factor on X axis of this node. More...

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

var	getScaleX ()
	Returns the scale factor on X axis of this node. More...

local	getScaleX ()
	Returns the scale factor on X axis of this node. More...

virtual void	setScaleY (float fScaleY)
	Changes the scale factor on Y axis of this node. More...

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

virtual void	setScale (float scale)
	Changes both X and Y scale factor of the node. More...

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

virtual void	setScale (float fScaleX, float fScaleY)
	Changes both X and Y scale factor of the node. More...

local	setScale ( local fScaleX, local fScaleY)
	Changes both X and Y scale factor of the node. More...

virtual void	setPosition (const CCPoint &position)
	Changes the position (x,y) of the node in OpenGL coordinates. More...

local	setPosition ( local position)
	Changes the position (x,y) of the node in OpenGL coordinates. More...

virtual const CCPoint &	getPosition ()
	Gets the position (x,y) of the node in OpenGL coordinates. More...

local	getPosition ()
	Gets the position (x,y) of the node in OpenGL coordinates. More...

virtual void	setPosition (float x, float y)
	Sets position in a more efficient way. More...

local	setPosition ( local x, local y)
	Sets position in a more efficient way. More...

virtual void	getPosition (float x, float y)
	Gets position in a more efficient way, returns two number instead of a CCPoint object. More...

local	getPosition ( local x, local y)
	Gets position in a more efficient way, returns two number instead of a CCPoint 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)
virtual void	setPositionY (float y)
var	setPositionY ( var y)
local	setPositionY ( local y)
virtual float	getPositionY (void)
var	getPositionY ()
local	getPositionY ()
virtual void	setSkewX (float fSkewX)
	Changes the X skew angle of the node in degrees. More...

local	setSkewX ( local fSkewX)
	Changes the X skew angle of the node in degrees. More...

virtual float	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 fSkewY)
	Changes the Y skew angle of the node in degrees. More...

virtual float	getSkewY ()
	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 CCPoint &anchorPoint)
	Sets the anchor point in percent. More...

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

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

local	getAnchorPoint ()
	Returns the anchor point in percent. More...

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

local	getAnchorPointInPoints ()
	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 ()
	Determines if the node is visible. More...

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

local	setRotation ( local fRotation)
	Sets the rotation (angle) of the node in degrees. More...

virtual float	getRotation ()
	Returns the rotation of the node in degrees. More...

virtual void	setRotationX (float fRotaionX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

local	setRotationX ( local fRotaionX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

virtual float	getRotationX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

local	getRotationX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual void	setRotationY (float fRotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

local	setRotationY ( local fRotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual float	getRotationY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

var	getRotationY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

local	getRotationY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual void	setOrderOfArrival (unsigned int uOrderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

var	setOrderOfArrival ( var uOrderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

local	setOrderOfArrival ( local uOrderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

virtual unsigned int	getOrderOfArrival ()
	Returns the arrival order, indecates which children is added previously. More...

virtual void	setGLServerState (ccGLServerState glServerState)
	Sets the state of OpenGL server side. More...

local	setGLServerState ( local glServerState)
	Sets the state of OpenGL server side. More...

virtual ccGLServerState	getGLServerState ()
	Returns the state of OpenGL server side. More...

local	getGLServerState ()
	Returns the state of OpenGL server side. More...

virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

local	ignoreAnchorPointForPosition ( local ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual bool	isIgnoreAnchorPointForPosition ()
	Gets whether the anchor point will be (0,0) when you position this node. More...

virtual CCNode *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual CCArray *	getChildren ()
	Return an array of children. More...

local	getChildren ()
	Return an array of children. More...

virtual unsigned int	getChildrenCount (void) const
	Get the amount of children. More...

var	getChildrenCount ()
	Get the amount of children. More...

local	getChildrenCount ()
	Get the amount of children. More...

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

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

var	getParent ()
	Returns a pointer to the parent node. More...

local	getParent ()
	Returns a pointer to the parent node. More...

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	removeFromParentAndCleanup ( local cleanup)
	Removes this node itself from its parent node. More...

virtual void	removeChild (CCNode *child)
	Removes a child from the container with a cleanup. More...

virtual void	removeChild (CCNode *child, bool cleanup)
	Removes a child from the container. More...

virtual void	removeChildByTag (int tag)
	Removes a child from the container by tag value with a cleanup. More...

virtual void	removeChildByTag (int tag, bool cleanup)
	Removes a child from the container by tag value. More...

local	removeChildByTag ( local tag, local cleanup)
	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...

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	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	reorderChild (CCNode *child, int zOrder)
	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...

var	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

local	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

virtual CCGridBase *	getGrid ()
	Returns a grid object that is used when applying effects. More...

virtual void	setGrid (CCGridBase *pGrid)
	Changes a grid object that is used when applying effects. More...

virtual int	getTag () const
	Returns a tag that is used to identify the node easily. More...

var	getTag ()
	Returns a tag that is used to identify the node easily. More...

local	getTag ()
	Returns a tag that is used to identify the node easily. More...

virtual void	setTag (int nTag)
	Changes the tag that is used to identify the node easily. More...

local	setTag ( local nTag)
	Changes the tag that is used to identify the node easily. More...

virtual void *	getUserData ()
	Returns a custom user data pointer. More...

virtual void	setUserData (void *pUserData)
	Sets a custom user data pointer. More...

local	setUserData ( local pUserData)
	Sets a custom user data pointer. More...

virtual CCObject *	getUserObject ()
	Returns a user assigned CCObject. More...

local	getUserObject ()
	Returns a user assigned CCObject. More...

virtual void	setUserObject (CCObject *pUserObject)
	Returns a user assigned CCObject. More...

local	setUserObject ( local pUserObject)
	Returns a user assigned CCObject. More...

virtual CCGLProgram *	getShaderProgram ()
	Return the shader program currently used for this node. More...

virtual void	setShaderProgram (CCGLProgram *pShaderProgram)
	Sets the shader program for this node. More...

virtual void	registerScriptHandler (int handler)
	Registers a script function that will be called in onEnter() & onExit() seires functions. More...

local	registerScriptHandler ( local handler)
	Registers a script function that will be called in onEnter() & onExit() seires functions. More...

virtual void	unregisterScriptHandler (void)
	Unregisters a script function that will be called in onEnter() & onExit() series functions. More...

int	getScriptHandler ()
	Gets script handler for onEnter/onExit event. More...

void	scheduleUpdateWithPriorityLua (int nHandler, int priority)
	Schedules for lua script. More...

local	scheduleUpdateWithPriorityLua ( local nHandler, local priority)
	Schedules for lua script. More...

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

virtual void	setActionManager (CCActionManager *actionManager)
	Sets the CCActionManager object that is used by all actions. More...

virtual CCActionManager *	getActionManager ()
	Gets the CCActionManager object that is used by all actions. More...

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

CCAction *	runAction (CCAction *action)
	Executes an action, and returns the action that is executed. More...

void	stopAllActions (void)
	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 (CCAction *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...

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

unsigned int	numberOfRunningActions (void)
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

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

virtual void	setScheduler (CCScheduler *scheduler)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

virtual CCScheduler *	getScheduler ()
	Gets a CCSheduler object. More...

local	getScheduler ()
	Gets a CCSheduler object. More...

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

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

var	schedule ( var selector, var 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	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors and actions. More...

void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors and actions. More...

virtual void	update (float delta)
var	update ( var delta)
local	update ( local delta)
void	transform (void)
	Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...

void	transformAncestors (void)
	Performs OpenGL view-matrix transformation of it's ancestors. More...

virtual void	updateTransform (void)
	Calls children's updateTransform() method recursively. More...

virtual CCAffineTransform	nodeToParentTransform (void)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

local	nodeToParentTransform ()
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual CCAffineTransform	parentToNodeTransform (void)
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

local	parentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

virtual CCAffineTransform	nodeToWorldTransform (void)
	Returns the world affine transform matrix. More...

local	nodeToWorldTransform ()
	Returns the world affine transform matrix. More...

virtual CCAffineTransform	worldToNodeTransform (void)
	Returns the inverse world affine transform matrix. More...

local	worldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...

CCPoint	convertToNodeSpace (const CCPoint &worldPoint)
	Converts a Point to node (local) space coordinates. More...

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

var	convertToWorldSpace ( var nodePoint)
	Converts a Point to world space coordinates. More...

local	convertToWorldSpace ( local nodePoint)
	Converts a Point to world space coordinates. More...

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

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

CCPoint	convertTouchToNodeSpace (CCTouch *touch)
	convenience methods which take a CCTouch instead of CCPoint More...

var	convertTouchToNodeSpace ( var touch)
	convenience methods which take a CCTouch instead of CCPoint More...

local	convertTouchToNodeSpace ( local touch)
	convenience methods which take a CCTouch instead of CCPoint More...

CCPoint	convertTouchToNodeSpaceAR (CCTouch *touch)
	converts a CCTouch (world coordinates) into a local coordinate. More...

void	setAdditionalTransform (const CCAffineTransform &additionalTransform)
	Sets the additional transform. More...

var	setAdditionalTransform ( var additionalTransform)
	Sets the additional transform. More...

local	setAdditionalTransform ( local additionalTransform)
	Sets the additional transform. More...

CCComponent *	getComponent (const char *pName) const
	gets a component by its name More...

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

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

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

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

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

virtual bool	removeComponent (const char *pName)
	removes a component by its name More...

virtual bool	removeComponent (CCComponent *pComponent)
	removes a component by its pointer More...

var	removeComponent ( var pComponent)
	removes a component by its pointer More...

local	removeComponent ( local pComponent)
	removes a component by its pointer More...

virtual void	removeAllComponents ()
	removes all components More...

	CCNode (void)
	Default constructor. More...

virtual	~CCNode (void)
	Default destructor. More...

const char *	description (void)
	Gets the description string. More...

Public Member Functions inherited from CCObject
	CCObject (void)
virtual	~CCObject (void)
void	release (void)
void	retain (void)
CCObject *	autorelease (void)
CCObject *	copy (void)
bool	isSingleReference (void) const
unsigned int	retainCount (void) const
virtual bool	isEqual (const CCObject *pObject)
virtual void	acceptVisitor (CCDataVisitor &visitor)
Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)
Public Member Functions inherited from CCTouchDelegate
	CCTouchDelegate ()
virtual	~CCTouchDelegate ()

Static Public Member Functions
static CCScrollView *	create (CCSize size, CCNode *container=NULL)
	Returns an autoreleased scroll view object. More...

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

Static Public Member Functions inherited from CCLayer
static CCLayer *	create (void)
	create one layer More...

local	create ()
	create one layer More...

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

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

Protected Member Functions
CCRect	getViewRect ()

Protected Attributes
float	m_fZoomScale
	current zoom scale More...

float	m_fMinZoomScale
	min zoom scale More...

float	m_fMaxZoomScale
	max zoom scale More...

CCScrollViewDelegate *	m_pDelegate
	scroll view delegate More...

CCScrollViewDirection	m_eDirection
bool	m_bDragging
	If YES, the view is being dragged. More...

CCPoint	m_tContentOffset
	Content offset. More...

CCNode *	m_pContainer
	Container holds scroll view contents, Sets the scrollable container object of the scroll view. More...

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

CCPoint	m_fMaxInset
	max inset point to limit scrolling by touch More...

CCPoint	m_fMinInset
	min inset point to limit scrolling by touch More...

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

bool	m_bClippingToBounds
CCPoint	m_tScrollDistance
	scroll speed More...

CCPoint	m_tTouchPoint
	Touch point. More...

float	m_fTouchLength
	length between two fingers More...

CCArray *	m_pTouches
	UITouch objects to detect multitouch. More...

CCSize	m_tViewSize
	size to clip. More...

float	m_fMinScale
	max and min scale More...

float	m_fMaxScale
CCRect	m_tParentScissorRect
	scissor rect for parent, just for restoring GL_SCISSOR_BOX More...

bool	m_bScissorRestored
Protected Attributes inherited from CCLayer
bool	m_bTouchEnabled
bool	m_bAccelerometerEnabled
var	m_bAccelerometerEnabled
local	m_bAccelerometerEnabled
bool	m_bKeypadEnabled
Protected Attributes inherited from CCNode
float	m_fRotationX
	rotation angle on x-axis More...

float	m_fRotationY
	rotation angle on y-axis More...

var	m_fRotationY
	rotation angle on y-axis More...

local	m_fRotationY
	rotation angle on y-axis More...

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

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

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

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

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

local	m_fScaleY
	scaling factor on y-axis More...

float	m_fVertexZ
	OpenGL real Z vertex. More...

var	m_fVertexZ
	OpenGL real Z vertex. More...

local	m_fVertexZ
	OpenGL real Z vertex. More...

CCPoint	m_obPosition
	position of the node More...

var	m_obPosition
	position of the node More...

local	m_obPosition
	position of the node More...

float	m_fSkewX
	skew angle on x-axis More...

var	m_fSkewX
	skew angle on x-axis More...

local	m_fSkewX
	skew angle on x-axis More...

float	m_fSkewY
	skew angle on y-axis More...

var	m_fSkewY
	skew angle on y-axis More...

local	m_fSkewY
	skew angle on y-axis More...

CCPoint	m_obAnchorPointInPoints
	anchor point in points More...

var	m_obAnchorPointInPoints
	anchor point in points More...

local	m_obAnchorPointInPoints
	anchor point in points More...

CCPoint	m_obAnchorPoint
	anchor point normalized (NOT in points) More...

var	m_obAnchorPoint
	anchor point normalized (NOT in points) More...

local	m_obAnchorPoint
	anchor point normalized (NOT in points) More...

CCSize	m_obContentSize
	untransformed size of the node More...

CCAffineTransform	m_sAdditionalTransform
	transform More...

var	m_sAdditionalTransform
	transform More...

local	m_sAdditionalTransform
	transform More...

CCAffineTransform	m_sTransform
	transform More...

var	m_sTransform
	transform More...

local	m_sTransform
	transform More...

CCAffineTransform	m_sInverse
	transform More...

var	m_sInverse
	transform More...

local	m_sInverse
	transform More...

CCCamera *	m_pCamera
	a camera More...

var	m_pCamera
	a camera More...

local	m_pCamera
	a camera More...

CCGridBase *	m_pGrid
	a grid More...

var	m_pGrid
	a grid More...

local	m_pGrid
	a grid More...

int	m_nZOrder
	z-order value that affects the draw order More...

var	m_nZOrder
	z-order value that affects the draw order More...

local	m_nZOrder
	z-order value that affects the draw order More...

CCArray *	m_pChildren
	array of children nodes More...

var	m_pChildren
	array of children nodes More...

local	m_pChildren
	array of children nodes More...

CCNode *	m_pParent
	weak reference to parent node More...

var	m_pParent
	weak reference to parent node More...

local	m_pParent
	weak reference to parent node More...

int	m_nTag
	a tag. Can be any number you assigned just to identify this node More...

void *	m_pUserData
	A user assingned void pointer, Can be point to any cpp object. More...

var	m_pUserData
	A user assingned void pointer, Can be point to any cpp object. More...

local	m_pUserData
	A user assingned void pointer, Can be point to any cpp object. More...

CCObject *	m_pUserObject
	A user assigned CCObject. More...

var	m_pUserObject
	A user assigned CCObject. More...

local	m_pUserObject
	A user assigned CCObject. More...

CCGLProgram *	m_pShaderProgram
	OpenGL shader. More...

var	m_pShaderProgram
	OpenGL shader. More...

local	m_pShaderProgram
	OpenGL shader. More...

ccGLServerState	m_eGLServerState
	OpenGL servier side state. More...

var	m_eGLServerState
	OpenGL servier side state. More...

local	m_eGLServerState
	OpenGL servier side state. More...

unsigned int	m_uOrderOfArrival
	used to preserve sequence while sorting children with the same zOrder More...

CCScheduler *	m_pScheduler
	scheduler used to schedule timers and updates More...

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

local	m_pScheduler
	scheduler used to schedule timers and updates More...

CCActionManager *	m_pActionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

var	m_pActionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

local	m_pActionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

bool	m_bRunning
	is running More...

var	m_bRunning
	is running More...

local	m_bRunning
	is running More...

bool	m_bTransformDirty
	transform dirty flag More...

var	m_bTransformDirty
	transform dirty flag More...

local	m_bTransformDirty
	transform dirty flag More...

bool	m_bInverseDirty
	transform dirty flag More...

var	m_bInverseDirty
	transform dirty flag More...

local	m_bInverseDirty
	transform dirty flag More...

bool	m_bAdditionalTransformDirty
	The flag to check whether the additional transform is dirty. More...

bool	m_bVisible
	is this node visible More...

var	m_bVisible
	is this node visible More...

local	m_bVisible
	is this node visible More...

bool	m_bIgnoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...

var	m_bIgnoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...

local	m_bIgnoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...

bool	m_bReorderChildDirty
	children order dirty flag More...

var	m_bReorderChildDirty
	children order dirty flag More...

local	m_bReorderChildDirty
	children order dirty flag More...

int	m_nScriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...

var	m_nScriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...

local	m_nScriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...

int	m_nUpdateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

var	m_nUpdateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

local	m_nUpdateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

ccScriptType	m_eScriptType
	type of script binding, lua or javascript More...

var	m_eScriptType
	type of script binding, lua or javascript More...

local	m_eScriptType
	type of script binding, lua or javascript More...

CCComponentContainer *	m_pComponentContainer
	Dictionary of components. More...

var	m_pComponentContainer
	Dictionary of components. More...

local	m_pComponentContainer
	Dictionary of components. More...

Protected Attributes inherited from CCObject
unsigned int	m_uReference
unsigned int	m_uAutoReleaseCount

Additional Inherited Members
Public Attributes inherited from CCObject
unsigned int	m_uID
int	m_nLuaID

Constructor & Destructor Documentation

CCScrollView ( )

virtual ~CCScrollView ( )

virtual

Member Function Documentation

virtual void addChild	(	CCNode *	child,
		int	zOrder,
		int	tag
	)

virtual

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 setZOrder(int)
tag	A interger to identify the node easily. Please refer to setTag(int)

Reimplemented from CCNode.

virtual void addChild	(	CCNode *	child,
		int	zOrder
	)

virtual

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

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 setZOrder(int)

Reimplemented from CCNode.

virtual void addChild ( CCNode * child )

virtual

Adds a child to the container with z-order as 0.

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

Parameters

child A child node

Reimplemented from CCNode.

virtual bool ccTouchBegan	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

override functions

Reimplemented from CCLayer.

Reimplemented in CCTableView.

virtual void ccTouchCancelled	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

Reimplemented from CCLayer.

Reimplemented in CCTableView.

virtual void ccTouchEnded	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

Reimplemented from CCLayer.

Reimplemented in CCTableView.

virtual void ccTouchMoved	(	CCTouch *	pTouch,
		CCEvent *	pEvent
	)

virtual

Reimplemented from CCLayer.

Reimplemented in CCTableView.

static CCScrollView* create	(	CCSize	size,
		CCNode *	container = `NULL`
	)

static

Returns an autoreleased scroll view object.

Parameters

size	view size
container	parent object

Returns: autoreleased scroll view object

static CCScrollView* create ( )

static

Returns an autoreleased scroll view object.

Parameters

size	view size
container	parent object

Returns: autoreleased scroll view object

CCNode* getContainer ( )

CCPoint getContentOffset ( )

virtual const CCSize&
getContentSize ( ) const

virtual

Returns the untransformed size of the node.

See also: setContentSize(const CCSize&)

Returns: The untransformed size of the node.

Reimplemented from CCNode.

CCScrollViewDelegate* getDelegate ( )

inline

CCScrollViewDirection getDirection ( )

inline

direction allowed to scroll.

CCScrollViewDirectionBoth by default.

int getScriptHandler ( int nScriptEventType )

CCRect getViewRect ( )

protected

CCSize getViewSize ( )

inline

size to clip.

CCNode 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 ( )

bool init ( )

virtual

Initializes the instance of CCNode.

Returns: Whether the initialization was successful.

Reimplemented from CCLayer.

bool initWithViewSize	(	CCSize	size,
		CCNode *	container = `NULL`
	)

Returns a scroll view object.

Parameters

size	view size
container	parent object

Returns: scroll view object

bool isBounceable ( )

inline

bool isClippingToBounds ( )

inline

Determines whether it clips its children or not.

bool isDragging ( )

inline

bool isNodeVisible ( CCNode * node )

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

Returns: YES if it is in visible bounds

bool isTouchMoved ( )

inline

CCPoint maxContainerOffset ( )

Returns the current container's maximum offset.

You may want this while you animate scrolling by yourself

CCPoint minContainerOffset ( )

Returns the current container's minimum offset.

You may want this while you animate scrolling by yourself

void pause ( CCObject * sender )

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

void registerScriptHandler	(	int	nFunID,
		int	nScriptEventType
	)

virtual void
registerWithTouchDispatcher ( )

virtual

If isTouchEnabled, this method is called onEnter.

Override it to change the way CCLayer receives touch events. ( Default: CCTouchDispatcher::sharedDispatcher()->addStandardDelegate(this,0); ) Example: void CCLayer::registerWithTouchDispatcher() { CCTouchDispatcher::sharedDispatcher()->addTargetedDelegate(this,INT_MIN+1,true); }

Since: v0.8.0

Reimplemented from CCLayer.

void resume ( CCObject * sender )

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

void setBounceable ( bool bBounceable )

inline

void setClippingToBounds ( bool bClippingToBounds )

inline

void setContainer ( CCNode * pContainer )

void setContentOffset	(	CCPoint	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	new offset
If	YES, the view scrolls to the new offset

void setContentOffsetInDuration	(	CCPoint	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	new offset
animation	duration

virtual void setContentSize ( const CCSize & contentSize )

virtual

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

void setDelegate ( CCScrollViewDelegate * pDelegate )

inline

virtual void setDirection ( CCScrollViewDirection eDirection )

inlinevirtual

void setTouchEnabled ( bool e )

virtual

Reimplemented from CCLayer.

void setViewSize ( CCSize size )

void setZoomScale ( float s )

void setZoomScale	(	float	s,
		bool	animated
	)

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

Parameters

s	a new scale vale
animated	if YES, scaling is animated

void setZoomScaleInDuration	(	float	s,
		float	dt
	)

Sets a new scale for container in a given duration.

Parameters

s	a new scale value
animation	duration

void unregisterScriptHandler ( int nScriptEventType )

void updateInset ( )

virtual void visit ( )

virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

Member Data Documentation

bool m_bBounceable

protected

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

bool m_bClippingToBounds

protected

bool m_bDragging

protected

If YES, the view is being dragged.

bool m_bScissorRestored

protected

bool m_bTouchMoved

protected

Determiens whether user touch is moved after begin phase.

CCScrollViewDirection m_eDirection

protected

CCPoint m_fMaxInset

protected

max inset point to limit scrolling by touch

float m_fMaxScale

protected

float m_fMaxZoomScale

protected

max zoom scale

CCPoint m_fMinInset

protected

min inset point to limit scrolling by touch

float m_fMinScale

protected

max and min scale

float m_fMinZoomScale

protected

min zoom scale

float m_fTouchLength

protected

length between two fingers

float m_fZoomScale

protected

current zoom scale

CCNode* m_pContainer

protected

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

CCScrollViewDelegate* m_pDelegate

protected

scroll view delegate

CCArray* m_pTouches

protected

UITouch objects to detect multitouch.

CCPoint m_tContentOffset

protected

Content offset.

Note that left-bottom point is the origin

CCRect m_tParentScissorRect

protected

scissor rect for parent, just for restoring GL_SCISSOR_BOX

CCPoint m_tScrollDistance

protected

scroll speed

CCPoint m_tTouchPoint

protected

Touch point.

CCSize m_tViewSize

protected

size to clip.

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

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation