CCRGBAProtocol Class Reference

RGBA protocol that affects CCNode's color and opacity NA. More...

#include <CCProtocols.h>

Inheritance diagram for CCRGBAProtocol:

Public Member Functions
virtual void	setColor (const ccColor3B &color)=0
	Changes the color with R,G,B bytes. More...
virtual const ccColor3B &	getColor (void)=0
	Returns color that is currently used. More...
virtual const ccColor3B &	getDisplayedColor (void)=0
	Returns the displayed color. More...
virtual GLubyte	getDisplayedOpacity (void)=0
	Returns the displayed opacity. More...
virtual GLubyte	getOpacity (void)=0
	Returns the opacity. More...
virtual void	setOpacity (GLubyte opacity)=0
	Changes the opacity. More...
virtual void	setOpacityModifyRGB (bool bValue)=0
	Changes the OpacityModifyRGB property. More...
virtual bool	isOpacityModifyRGB (void)=0
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
virtual bool	isCascadeColorEnabled (void)=0
	whether or not color should be propagated to its children. More...
virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)=0
virtual void	updateDisplayedColor (const ccColor3B &color)=0
	recursive method that updates display color More...
virtual bool	isCascadeOpacityEnabled (void)=0
	whether or not opacity should be propagated to its children. More...
virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)=0
virtual void	updateDisplayedOpacity (GLubyte opacity)=0
	recursive method that updates the displayed opacity. More...

Detailed Description

RGBA protocol that affects CCNode's color and opacity NA.

Member Function Documentation

getColor()

virtual const ccColor3B & getColor ( void  )

pure virtual

Returns color that is currently used.

Returns

The ccColor3B contains R,G,B bytes.

Implemented in CCLayerRGBA, CCScale9Sprite, CCAtlasNode, CCNodeRGBA, CCLabelBMFont, and CCControlButton.

getDisplayedColor()

virtual const ccColor3B & getDisplayedColor ( void  )

pure virtual

Returns the displayed color.

Returns

The ccColor3B contains R,G,B bytes.

Implemented in CCNodeRGBA, CCLabelBMFont, and CCLayerRGBA.

getDisplayedOpacity()

virtual GLubyte getDisplayedOpacity ( void  )

pure virtual

Returns the displayed opacity.

Returns

The opacity of sprite, from 0 ~ 255

Implemented in CCNodeRGBA, CCLabelBMFont, and CCLayerRGBA.

getOpacity()

virtual GLubyte getOpacity ( void  )

pure virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns

The opacity of sprite, from 0 ~ 255

Implemented in CCNodeRGBA, CCLabelBMFont, CCLayerRGBA, CCScale9Sprite, CCMotionStreak, and CCControlButton.

isCascadeColorEnabled()

virtual bool isCascadeColorEnabled ( void  )

pure virtual

whether or not color should be propagated to its children.

Implemented in CCNodeRGBA, CCLabelBMFont, and CCLayerRGBA.

isCascadeOpacityEnabled()

virtual bool isCascadeOpacityEnabled ( void  )

pure virtual

whether or not opacity should be propagated to its children.

Implemented in CCNodeRGBA, CCLabelBMFont, and CCLayerRGBA.

isOpacityModifyRGB()

virtual bool isOpacityModifyRGB ( void  )

pure virtual

Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity)

Returns

Returns opacity modify flag.

Implemented in CCAtlasNode, CCNodeRGBA, CCLabelBMFont, CCLayerRGBA, CCControl, CCMenu, CCMotionStreak, CCSprite, and CCScale9Sprite.

setCascadeColorEnabled()

virtual void setCascadeColorEnabled ( bool  cascadeColorEnabled )

pure virtual

Implemented in CCNodeRGBA, CCLabelBMFont, and CCLayerRGBA.

setCascadeOpacityEnabled()

virtual void setCascadeOpacityEnabled ( bool  cascadeOpacityEnabled )

pure virtual

Implemented in CCNodeRGBA, CCLabelBMFont, and CCLayerRGBA.

setColor()

virtual void setColor ( const ccColor3B &  color )

pure virtual

Changes the color with R,G,B bytes.

Parameters

color

Example: ccc3(255,100,0) means R=255, G=100, B=0

Implemented in CCControlButton, CCAtlasNode, CCNodeRGBA, CCLabelBMFont, CCLayerRGBA, CCLayerColor, CCProgressTimer, CCScale9Sprite, CCSprite, and CCControlColourPicker.

setOpacity()

virtual void setOpacity ( GLubyte  opacity )

pure virtual

Changes the opacity.

Parameters

value

Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Implemented in CCAtlasNode, CCNodeRGBA, CCLabelBMFont, CCLayerRGBA, CCLayerColor, CCMotionStreak, CCProgressTimer, CCSprite, CCScale9Sprite, and CCControlButton.

setOpacityModifyRGB()

virtual void setOpacityModifyRGB ( bool  bValue )

pure virtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters

bValue

true then the opacity will be applied as: glColor(R,G,B,opacity); false then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Implemented in CCControl, CCNodeRGBA, CCLayerRGBA, CCMenu, CCMotionStreak, CCScale9Sprite, CCAtlasNode, CCLabelBMFont, and CCSprite.

updateDisplayedColor()

virtual void updateDisplayedColor ( const ccColor3B &  color )

pure virtual

recursive method that updates display color

Implemented in CCNodeRGBA, CCLabelBMFont, CCLayerRGBA, and CCSprite.

updateDisplayedOpacity()

virtual void updateDisplayedOpacity ( GLubyte  opacity )

pure virtual

recursive method that updates the displayed opacity.

Implemented in CCNodeRGBA, CCLabelBMFont, CCLayerRGBA, CCSprite, and CCScale9Sprite.

---

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

• /home/runner/work/cocos-headers/cocos-headers/cocos2dx/include/CCProtocols.h