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

CCClippingNode is a subclass of CCNode. More...

#include <CCClippingNode.h>

Inheritance diagram for CCClippingNode:
CCNode CCObject CCCopying RectClippingNode

Public Member Functions

virtual ~CCClippingNode ()
virtual bool init ()
 Initializes a clipping node without a stencil. More...
 
virtual bool init (CCNode *pStencil)
 Initializes a clipping node with an other node as its stencil. More...
 
var init ( var pStencil)
 Initializes a clipping node with an other node as its stencil. More...
 
local init ( local pStencil)
 Initializes a clipping node with an other node as its stencil. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when CCNode enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the CCNode enters in the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the CCNode leaves the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the CCNode leaves the 'stage'. More...
 
virtual void visit ()
 Visits this node's children and draw them recursively. More...
 
var visit ()
 Visits this node's children and draw them recursively. More...
 
local visit ()
 Visits this node's children and draw them recursively. More...
 
CCNodegetStencil () const
 The CCNode to use as a stencil to do the clipping. More...
 
local getStencil ()
 The CCNode to use as a stencil to do the clipping. More...
 
void setStencil (CCNode *pStencil)
GLfloat getAlphaThreshold () const
 The alpha threshold. More...
 
local getAlphaThreshold ()
 The alpha threshold. More...
 
void setAlphaThreshold (GLfloat fAlphaThreshold)
bool isInverted () const
 Inverted. More...
 
void setInverted (bool bInverted)
- Public Member Functions inherited from CCNode
virtual CCCameragetCamera ()
 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...
 
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 CCPointgetPosition ()
 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 CCPointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const CCPointgetAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual void setContentSize (const CCSize &contentSize)
 Sets the untransformed size of the node. More...
 
virtual const CCSizegetContentSize () 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...
 
CCNodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual CCArraygetChildren ()
 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 CCNodegetParent ()
 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 CCGridBasegetGrid ()
 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 CCObjectgetUserObject ()
 Returns a user assigned CCObject. More...
 
virtual void setUserObject (CCObject *pUserObject)
 Returns a user assigned CCObject. More...
 
virtual CCGLProgramgetShaderProgram ()
 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 setActionManager (CCActionManager *actionManager)
 Sets the CCActionManager object that is used by all actions. More...
 
virtual CCActionManagergetActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
CCActionrunAction (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...
 
CCActiongetActionByTag (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 CCSchedulergetScheduler ()
 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...
 
CCComponentgetComponent (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)
CCObjectautorelease (void)
CCObjectcopy (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 CCObjectcopyWithZone (CCZone *pZone)

Static Public Member Functions

static CCClippingNodecreate ()
 Creates and initializes a clipping node without a stencil. More...
 
local create ()
 Creates and initializes a clipping node without a stencil. More...
 
static CCClippingNodecreate (CCNode *pStencil)
 Creates and initializes a clipping node with an other node as its stencil. More...
 
- Static Public Member Functions inherited from CCNode
static CCNodecreate (void)
 Allocates and initializes a node. More...
 

Protected Member Functions

 CCClippingNode ()

Protected Attributes

CCNodem_pStencil
GLfloat m_fAlphaThreshold
var m_fAlphaThreshold
local m_fAlphaThreshold
bool m_bInverted
- 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...
 
CCCameram_pCamera
 a camera More...
 
CCGridBasem_pGrid
 a grid More...
 
int m_nZOrder
 z-order value that affects the draw order More...
 
CCArraym_pChildren
 array of children nodes More...
 
CCNodem_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...
 
CCObjectm_pUserObject
 A user assigned CCObject. More...
 
CCGLProgramm_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...
 
CCSchedulerm_pScheduler
 scheduler used to schedule timers and updates More...
 
CCActionManagerm_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...
 
CCComponentContainerm_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

CCClippingNode is a subclass of CCNode.

It draws its content (childs) clipped using a stencil. The stencil is an other CCNode that will not be drawn. The clipping is done using the alpha part of the stencil (adjusted with an alphaThreshold).

Constructor & Destructor Documentation

virtual ~CCClippingNode ( )
virtual
CCClippingNode ( )
protected
var CCClippingNode ( )
protected
local CCClippingNode ( )
protected

Member Function Documentation

static CCClippingNode* create ( )
static

Creates and initializes a clipping node without a stencil.

var create ( )
static

Creates and initializes a clipping node without a stencil.

local create ( )
static

Creates and initializes a clipping node without a stencil.

static CCClippingNode* create ( CCNode pStencil)
static

Creates and initializes a clipping node with an other node as its stencil.

The stencil node will be retained.

var create ( var  pStencil)
static

Creates and initializes a clipping node with an other node as its stencil.

The stencil node will be retained.

local create ( local  pStencil)
static

Creates and initializes a clipping node with an other node as its stencil.

The stencil node will be retained.

GLfloat getAlphaThreshold ( ) const

The alpha threshold.

The content is drawn only where the stencil have pixel with alpha greater than the alphaThreshold. Should be a float between 0 and 1. This default to 1 (so alpha test is disabled).

var getAlphaThreshold ( )

The alpha threshold.

The content is drawn only where the stencil have pixel with alpha greater than the alphaThreshold. Should be a float between 0 and 1. This default to 1 (so alpha test is disabled).

local getAlphaThreshold ( )

The alpha threshold.

The content is drawn only where the stencil have pixel with alpha greater than the alphaThreshold. Should be a float between 0 and 1. This default to 1 (so alpha test is disabled).

CCNode* getStencil ( ) const

The CCNode to use as a stencil to do the clipping.

The stencil node will be retained. This default to nil.

var getStencil ( )

The CCNode to use as a stencil to do the clipping.

The stencil node will be retained. This default to nil.

local getStencil ( )

The CCNode to use as a stencil to do the clipping.

The stencil node will be retained. This default to nil.

virtual bool init ( )
virtual

Initializes a clipping node without a stencil.

Reimplemented from CCNode.

Reimplemented in RectClippingNode.

var init ( )
virtual

Initializes a clipping node without a stencil.

Reimplemented from CCNode.

Reimplemented in RectClippingNode.

local init ( )
virtual

Initializes a clipping node without a stencil.

Reimplemented from CCNode.

Reimplemented in RectClippingNode.

virtual bool init ( CCNode pStencil)
virtual

Initializes a clipping node with an other node as its stencil.

The stencil node will be retained, and its parent will be set to this clipping node.

var init ( var  pStencil)
virtual

Initializes a clipping node with an other node as its stencil.

The stencil node will be retained, and its parent will be set to this clipping node.

local init ( local  pStencil)
virtual

Initializes a clipping node with an other node as its stencil.

The stencil node will be retained, and its parent will be set to this clipping node.

bool isInverted ( ) const

Inverted.

If this is set to YES, the stencil is inverted, so the content is drawn where the stencil is NOT drawn. This default to NO.

var isInverted ( )

Inverted.

If this is set to YES, the stencil is inverted, so the content is drawn where the stencil is NOT drawn. This default to NO.

local isInverted ( )

Inverted.

If this is set to YES, the stencil is inverted, so the content is drawn where the stencil is NOT drawn. This default to NO.

virtual void onEnter ( )
virtual

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

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

Reimplemented from CCNode.

virtual void
onEnterTransitionDidFinish
( )
virtual

Event callback that is invoked when the CCNode enters in the 'stage'.

If the CCNode enters the 'stage' with a transition, this event is called when the transition finishes. If you override onEnterTransitionDidFinish, you shall call its parent's one, e.g. CCNode::onEnterTransitionDidFinish()

Reimplemented from CCNode.

virtual void onExit ( )
virtual

Event callback that is invoked every time the CCNode leaves the 'stage'.

If the CCNode leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., CCNode::onExit().

Reimplemented from CCNode.

virtual void
onExitTransitionDidStart
( )
virtual

Event callback that is called every time the CCNode leaves the 'stage'.

If the CCNode leaves the 'stage' with a transition, this callback is called when the transition starts.

Reimplemented from CCNode.

void setAlphaThreshold ( GLfloat  fAlphaThreshold)
var setAlphaThreshold ( var  fAlphaThreshold)
local setAlphaThreshold ( local  fAlphaThreshold)
void setInverted ( bool  bInverted)
var setInverted ( var  bInverted)
local setInverted ( local  bInverted)
void setStencil ( CCNode pStencil)
var setStencil ( var  pStencil)
local setStencil ( local  pStencil)
virtual void visit ( )
virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

Reimplemented in RectClippingNode.

var visit ( )
virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

Reimplemented in RectClippingNode.

local visit ( )
virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

Reimplemented in RectClippingNode.

Member Data Documentation

bool m_bInverted
protected
var m_bInverted
protected
local m_bInverted
protected
GLfloat m_fAlphaThreshold
protected
var m_fAlphaThreshold
protected
local m_fAlphaThreshold
protected
CCNode* m_pStencil
protected
var m_pStencil
protected
local m_pStencil
protected

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