mirror of
https://github.com/geode-sdk/geode.git
synced 2024-11-27 01:45:35 -05:00
124 lines
3.7 KiB
C++
124 lines
3.7 KiB
C++
/*
|
|
* cocos2d for iPhone: http://www.cocos2d-iphone.org
|
|
* cocos2d-x: http://www.cocos2d-x.org
|
|
*
|
|
* Copyright (c) 2012 Pierre-David Bélanger
|
|
* Copyright (c) 2012 cocos2d-x.org
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
*/
|
|
|
|
#ifndef __MISCNODE_CCCLIPPING_NODE_H__
|
|
#define __MISCNODE_CCCLIPPING_NODE_H__
|
|
|
|
#include "../base_nodes/CCNode.h"
|
|
#include "../platform/CCGL.h"
|
|
|
|
NS_CC_BEGIN
|
|
|
|
/** 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).
|
|
*/
|
|
class CC_DLL CCClippingNode : public CCNode
|
|
{
|
|
GEODE_FRIEND_MODIFY
|
|
protected:
|
|
|
|
|
|
CCNode* m_pStencil;
|
|
GLfloat m_fAlphaThreshold;
|
|
bool m_bInverted;
|
|
|
|
public:
|
|
/** Creates and initializes a clipping node without a stencil.
|
|
*/
|
|
static CCClippingNode* create();
|
|
|
|
/** Creates and initializes a clipping node with an other node as its stencil.
|
|
The stencil node will be retained.
|
|
*/
|
|
static CCClippingNode* create(CCNode *pStencil);
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~CCClippingNode();
|
|
|
|
/** Initializes a clipping node without a stencil.
|
|
*/
|
|
virtual bool init();
|
|
|
|
/** 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.
|
|
*/
|
|
virtual bool init(CCNode *pStencil);
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onEnter();
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onEnterTransitionDidFinish();
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onExitTransitionDidStart();
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual void onExit();
|
|
virtual void visit();
|
|
|
|
/** The CCNode to use as a stencil to do the clipping.
|
|
The stencil node will be retained.
|
|
This default to nil.
|
|
*/
|
|
CCNode* getStencil() const;
|
|
void setStencil(CCNode *pStencil);
|
|
|
|
/** 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).
|
|
*/
|
|
GLfloat getAlphaThreshold() const;
|
|
void setAlphaThreshold(GLfloat fAlphaThreshold);
|
|
|
|
/** 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.
|
|
*/
|
|
bool isInverted() const;
|
|
void setInverted(bool bInverted);
|
|
|
|
protected:
|
|
CCClippingNode();
|
|
};
|
|
|
|
NS_CC_END
|
|
|
|
#endif // __MISCNODE_CCCLIPPING_NODE_H__
|