CCLayerGradient Class Reference

CCLayerGradient is a subclass of CCLayerColor that draws gradients across the background. More...

#include <CCLayer.h>

Inheritance diagram for CCLayerGradient:

Public Member Functions
virtual bool	init ()
	Initializes the instance of CCNode. More...
virtual bool	initWithColor (const ccColor4B &start, const ccColor4B &end)
	Initializes the CCLayer with a gradient between start and end. More...
virtual bool	initWithColor (const ccColor4B &start, const ccColor4B &end, const CCPoint &v)
	Initializes the CCLayer with a gradient between start and end in the direction of v. More...
virtual const ccColor3B &	getStartColor (void)
	getStartColor More...
virtual void	setStartColor (const ccColor3B &var)
	setStartColor More...
virtual const ccColor3B &	getEndColor (void)
	getEndColor More...
virtual void	setEndColor (const ccColor3B &var)
	setEndColor More...
virtual GLubyte	getStartOpacity (void)
	getStartOpacity More...
virtual void	setStartOpacity (GLubyte var)
	setStartOpacity More...
virtual GLubyte	getEndOpacity (void)
	getEndOpacity More...
virtual void	setEndOpacity (GLubyte var)
	setEndOpacity More...
virtual const CCPoint &	getVector (void)
	getVector More...
virtual void	setVector (const CCPoint &var)
	setVector More...
virtual void	setCompressedInterpolation (bool bCompressedInterpolation)
virtual bool	isCompressedInterpolation ()
Public Member Functions inherited from CCLayerColor
	CCLayerColor ()
virtual	~CCLayerColor ()
virtual void	draw ()
	Override this method to draw your own node. More...
virtual void	setContentSize (const CCSize &var)
	Sets the untransformed size of the node. More...
virtual bool	initWithColor (const ccColor4B &color, GLfloat width, GLfloat height)
	initializes a CCLayer with color, width and height in Points More...
virtual bool	initWithColor (const ccColor4B &color)
	initializes a CCLayer with color. More...
void	changeWidth (GLfloat w)
	change width in Points More...
void	changeHeight (GLfloat h)
	change height in Points More...
void	changeWidthAndHeight (GLfloat w, GLfloat h)
	change width and height in Points More...
virtual ccBlendFunc	getBlendFunc (void)
	getBlendFunc More...
virtual void	setBlendFunc (ccBlendFunc var)
	setBlendFunc More...
virtual void	setColor (const ccColor3B &color)
	@ More...
virtual void	setOpacity (GLubyte opacity)
	Changes the opacity. More...
Public Member Functions inherited from CCLayerRGBA
	CREATE_FUNC (CCLayerRGBA)
	CCLayerRGBA ()
virtual	~CCLayerRGBA ()
virtual GLubyte	getOpacity ()
	Returns the opacity. More...
virtual GLubyte	getDisplayedOpacity ()
	Returns the displayed opacity. More...
virtual void	updateDisplayedOpacity (GLubyte parentOpacity)
	recursive method that updates the displayed opacity. More...
virtual bool	isCascadeOpacityEnabled ()
	whether or not opacity should be propagated to its children. More...
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const ccColor3B &	getColor ()
	Returns color that is currently used. More...
virtual const ccColor3B &	getDisplayedColor ()
	Returns the displayed color. More...
virtual void	updateDisplayedColor (const ccColor3B &parentColor)
	recursive method that updates display color More...
virtual bool	isCascadeColorEnabled ()
	whether or not color should be propagated to its children. More...
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
virtual void	setOpacityModifyRGB (bool bValue)
	Changes the OpacityModifyRGB property. More...
virtual bool	isOpacityModifyRGB ()
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
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 bool	ccTouchBegan (CCTouch *pTouch, CCEvent *pEvent)
virtual void	ccTouchMoved (CCTouch *pTouch, CCEvent *pEvent)
virtual void	ccTouchEnded (CCTouch *pTouch, CCEvent *pEvent)
local	ccTouchEnded ( local pTouch, local pEvent)
virtual void	ccTouchCancelled (CCTouch *pTouch, CCEvent *pEvent)
local	ccTouchCancelled ( local pTouch, local pEvent)
virtual void	ccTouchesBegan (CCSet *pTouches, CCEvent *pEvent)
virtual void	ccTouchesMoved (CCSet *pTouches, CCEvent *pEvent)
local	ccTouchesMoved ( local pTouches, local pEvent)
virtual void	ccTouchesEnded (CCSet *pTouches, CCEvent *pEvent)
local	ccTouchesEnded ( local pTouches, local pEvent)
virtual void	ccTouchesCancelled (CCSet *pTouches, CCEvent *pEvent)
local	ccTouchesCancelled ( local pTouches, local pEvent)
virtual void	didAccelerate (CCAcceleration *pAccelerationValue)
void	registerScriptAccelerateHandler (int nHandler)
void	unregisterScriptAccelerateHandler (void)
virtual void	registerWithTouchDispatcher (void)
	If isTouchEnabled, this method is called onEnter. More...
local	registerWithTouchDispatcher ()
	If isTouchEnabled, this method is called onEnter. More...
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	setTouchEnabled (bool value)
local	setTouchEnabled ( local value)
virtual void	setTouchMode (ccTouchesMode mode)
local	setTouchMode ( local mode)
virtual int	getTouchMode ()
virtual void	setTouchPriority (int 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...
virtual void	setAccelerometerEnabled (bool value)
virtual void	setAccelerometerInterval (double 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)
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 ()
var	getScriptAccelerateHandlerEntry ()
local	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	visit (void)
	Visits this node's children and draw them recursively. More...
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...
virtual int	getZOrder ()
	Gets the Z order of this node. More...
virtual void	setVertexZ (float vertexZ)
	Sets the real OpenGL Z vertex. More...
virtual float	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...
virtual float	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...
virtual void	setPosition (const CCPoint &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...
virtual void	setPosition (float x, float 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...
virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...
virtual float	getPositionX (void)
virtual void	setPositionY (float y)
virtual float	getPositionY (void)
virtual void	setSkewX (float 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...
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...
virtual void	setAnchorPoint (const CCPoint &anchorPoint)
	Sets the anchor point in percent. More...
virtual const CCPoint &	getAnchorPoint ()
	Returns the anchor point in percent. More...
virtual const CCPoint &	getAnchorPointInPoints ()
	Returns the anchorPoint in absolute pixels. More...
virtual const CCSize &	getContentSize () const
	Returns the untransformed size of the node. More...
virtual void	setVisible (bool 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...
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...
virtual float	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...
virtual float	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...
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...
virtual ccGLServerState	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...
virtual bool	isIgnoreAnchorPointForPosition ()
	Gets whether the anchor point will be (0,0) when you position this node. More...
virtual void	addChild (CCNode *child)
	Adds a child to the container with z-order as 0. More...
virtual void	addChild (CCNode *child, int zOrder)
	Adds a child to the container with a z-order. More...
virtual void	addChild (CCNode *child, int zOrder, int tag)
	Adds a child to the container with z order and tag. More...
CCNode *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...
virtual CCArray *	getChildren ()
	Return an array of children. More...
unsigned int	getChildrenCount (void) const
	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...
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...
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...
virtual void	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 (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...
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...
virtual void	setTag (int 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...
virtual CCObject *	getUserObject ()
	Returns a user assigned CCObject. More...
virtual void	setUserObject (CCObject *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...
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...
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...
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...
void	stopAction (CCAction *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...
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...
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...
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)
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	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors and actions. More...
void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors and actions. More...
virtual void	update (float 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...
virtual CCAffineTransform	parentToNodeTransform (void)
	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...
virtual CCAffineTransform	worldToNodeTransform (void)
	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...
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...
CCPoint	convertTouchToNodeSpaceAR (CCTouch *touch)
	converts a CCTouch (world coordinates) into a local coordinate. More...
void	setAdditionalTransform (const CCAffineTransform &additionalTransform)
	Sets the additional transform. More...
CCComponent *	getComponent (const char *pName) const
	gets a component by its name More...
virtual bool	addComponent (CCComponent *pComponent)
	adds a component More...
virtual bool	removeComponent (const char *pName)
	removes a component by its name 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 CCLayerGradient *	create (const ccColor4B &start, const ccColor4B &end)
	Creates a full-screen CCLayer with a gradient between start and end. More...
static CCLayerGradient *	create (const ccColor4B &start, const ccColor4B &end, const CCPoint &v)
	Creates a full-screen CCLayer with a gradient between start and end in the direction of v. More...
static CCLayerGradient *	create ()
Static Public Member Functions inherited from CCLayerColor
static CCLayerColor *	create ()
static CCLayerColor *	create (const ccColor4B &color, GLfloat width, GLfloat height)
	creates a CCLayer with color, width and height in Points More...
static CCLayerColor *	create (const ccColor4B &color)
	creates a CCLayer with color. More...

Protected Member Functions
virtual void	updateColor ()

Protected Attributes
ccColor3B	m_startColor
ccColor3B	m_endColor
GLubyte	m_cStartOpacity
GLubyte	m_cEndOpacity
CCPoint	m_AlongVector
bool	m_bCompressedInterpolation
	Whether or not the interpolation will be compressed in order to display all the colors of the gradient both in canonical and non canonical vectors Default: YES More...
Protected Attributes inherited from CCLayerColor
ccVertex2F	m_pSquareVertices [4]
ccColor4F	m_pSquareColors [4]
ccBlendFunc	m_tBlendFunc
	BlendFunction. More...
Protected Attributes inherited from CCLayerRGBA
GLubyte	_displayedOpacity
GLubyte	_realOpacity
ccColor3B	_displayedColor
ccColor3B	_realColor
bool	_cascadeOpacityEnabled
bool	_cascadeColorEnabled
Protected Attributes inherited from CCLayer
bool	m_bTouchEnabled
bool	m_bAccelerometerEnabled
var	m_bAccelerometerEnabled
local	m_bAccelerometerEnabled
bool	m_bKeypadEnabled
var	m_bKeypadEnabled
local	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...
float	m_fScaleX
	scaling factor on x-axis More...
float	m_fScaleY
	scaling factor on y-axis More...
float	m_fVertexZ
	OpenGL real Z vertex. More...
CCPoint	m_obPosition
	position of the node More...
float	m_fSkewX
	skew angle on x-axis More...
float	m_fSkewY
	skew angle on y-axis More...
CCPoint	m_obAnchorPointInPoints
	anchor point in points More...
CCPoint	m_obAnchorPoint
	anchor point normalized (NOT in points) More...
CCSize	m_obContentSize
	untransformed size of the node More...
CCAffineTransform	m_sAdditionalTransform
	transform More...
CCAffineTransform	m_sTransform
	transform More...
CCAffineTransform	m_sInverse
	transform More...
CCCamera *	m_pCamera
	a camera More...
CCGridBase *	m_pGrid
	a grid More...
int	m_nZOrder
	z-order value that affects the draw order More...
CCArray *	m_pChildren
	array of children nodes More...
CCNode *	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...
CCObject *	m_pUserObject
	A user assigned CCObject. More...
CCGLProgram *	m_pShaderProgram
	OpenGL shader. More...
ccGLServerState	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...
CCActionManager *	m_pActionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...
bool	m_bRunning
	is running More...
bool	m_bTransformDirty
	transform dirty flag More...
bool	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...
bool	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...
int	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...
ccScriptType	m_eScriptType
	type of script binding, lua or javascript More...
CCComponentContainer *	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

Detailed Description

CCLayerGradient is a subclass of CCLayerColor that draws gradients across the background.

All features from CCLayerColor are valid, plus the following new features:

• direction
• final color
• interpolation mode

Color is interpolated between the startColor and endColor along the given vector (starting at the origin, ending at the terminus). If no vector is supplied, it defaults to (0, -1) – a fade from top to bottom.

If 'compressedInterpolation' is disabled, you will not see either the start or end color for non-cardinal vectors; a smooth gradient implying both end points will be still be drawn, however.

If ' compressedInterpolation' is enabled (default mode) you will see both the start and end colors of the gradient.

Since

v0.99.5

Member Function Documentation

static CCLayerGradient* create ( const ccColor4B &  start, const ccColor4B &  end  )

static

Creates a full-screen CCLayer with a gradient between start and end.

static CCLayerGradient* create ( const ccColor4B &  start, const ccColor4B &  end, const CCPoint &  v  )

static

Creates a full-screen CCLayer with a gradient between start and end in the direction of v.

static CCLayerGradient* create ( )

static

virtual const ccColor3B& getEndColor ( void  )

virtual

getEndColor

virtual GLubyte getEndOpacity ( void  )

virtual

getEndOpacity

virtual const ccColor3B& getStartColor ( void  )

virtual

getStartColor

virtual GLubyte getStartOpacity ( void  )

virtual

getStartOpacity

virtual const CCPoint& getVector ( void  )

virtual

getVector

virtual bool init ( )

virtual

Initializes the instance of CCNode.

Returns

Whether the initialization was successful.

Reimplemented from CCLayerColor.

virtual bool initWithColor ( const ccColor4B &  start, const ccColor4B &  end  )

virtual

Initializes the CCLayer with a gradient between start and end.

virtual bool initWithColor ( const ccColor4B &  start, const ccColor4B &  end, const CCPoint &  v  )

virtual

Initializes the CCLayer with a gradient between start and end in the direction of v.

virtual bool isCompressedInterpolation ( )

virtual

virtual void setCompressedInterpolation ( bool  bCompressedInterpolation)

virtual

virtual void setEndColor ( const ccColor3B &  var)

virtual

setEndColor

virtual void setEndOpacity ( GLubyte  var)

virtual

setEndOpacity

virtual void setStartColor ( const ccColor3B &  var)

virtual

setStartColor

virtual void setStartOpacity ( GLubyte  var)

virtual

setStartOpacity

virtual void setVector ( const CCPoint &  var)

virtual

setVector

virtual void updateColor ( )

protectedvirtual

Reimplemented from CCLayerColor.

Member Data Documentation

CCPoint m_AlongVector

protected

bool m_bCompressedInterpolation

protected

Whether or not the interpolation will be compressed in order to display all the colors of the gradient both in canonical and non canonical vectors

Default: YES

GLubyte m_cEndOpacity

protected

GLubyte m_cStartOpacity

protected

ccColor3B m_endColor

protected

ccColor3B m_startColor

protected

---

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

• /Users/cocos2d/MyWork/cocos2d-x/cocos2dx/layers_scenes_transitions_nodes/CCLayer.h