axmol/cocos/2d/CCClippingNode.cpp

367 lines
9.7 KiB
C++
Raw Normal View History

2012-11-08 17:55:25 +08:00
/*
* Copyright (c) 2012 Pierre-David Bélanger
* Copyright (c) 2012 cocos2d-x.org
2016-08-05 09:42:15 +08:00
* Copyright (c) 2013-2016 Chukong Technologies Inc.
2012-11-08 17:55:25 +08:00
*
* cocos2d-x: http://www.cocos2d-x.org
2012-11-08 17:55:25 +08:00
*
* 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.
*
*/
Squashed commit of the following: commit c16dcfaaea0922039aad05bce1f4efed18e04871 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 19:05:18 2014 -0700 more linux fixes commit 1553795976c9090a1b46deb53d12910fe0676008 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 19:04:04 2014 -0700 more linux fixes commit 1e43a8cabff33cbf25aa5eb5412f53a878222d83 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 19:02:07 2014 -0700 fixes linux isuses commit 723a445dd6411f91846da2b801248ad8298174f1 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:58:50 2014 -0700 more linux fixes commit 533c8025e794fc76cef02f396b3a93b3d7f4cfc8 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:57:33 2014 -0700 more linux fixes commit 4ba1e84959670bcbf044f18d1c0d4b3cb3be4090 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:53:43 2014 -0700 more linux fixes commit 1f8e011f306a47ed4134224e5e349929201f0539 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:49:28 2014 -0700 more linux fixes commit 3e2033100822ff6d532a1b4f012337491dc11920 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:47:43 2014 -0700 more linux fixes commit 2e708863c75fd032f1b2396dfdf1d31f7a62b713 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:46:00 2014 -0700 more linux fixes commit 861b5b92a6efd4de7b926c20d636ce9d749b293f Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:43:15 2014 -0700 more linux fixes commit 2a43365a0c1755e9b9cada53301be1a20adb31cf Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:36:06 2014 -0700 more fixes for linux commit 7d332bf911892f87c7824d2a5da7bf73ce7ec411 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:35:29 2014 -0700 more fixes for linux commit f1becc17d3316dfe3678c23c9dcedb7a447d9235 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:34:44 2014 -0700 more fixes for linux commit d2e5959bb0dde921dd5e73be1d8acc3b3f50e51d Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:33:45 2014 -0700 fixes for linux commit ad9b633c352107cf0e8b060a0e23d6e6a3f5e80f Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:16:48 2014 -0700 compiles on Windows commit 4425ee8e5de8f42a2d6050e4470109600dce8b5d Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed Apr 30 18:07:20 2014 -0700 fix builder
2014-05-01 10:09:13 +08:00
#include "2d/CCClippingNode.h"
#include "2d/CCDrawingPrimitives.h"
2014-08-28 17:03:29 +08:00
#include "renderer/CCGLProgramCache.h"
#include "renderer/ccGLStateCache.h"
2014-08-28 17:03:29 +08:00
#include "renderer/CCRenderer.h"
#include "renderer/CCRenderState.h"
2014-04-30 08:37:36 +08:00
#include "base/CCDirector.h"
#include "base/CCStencilStateManager.hpp"
#if (CC_TARGET_PLATFORM == CC_PLATFORM_MAC || CC_TARGET_PLATFORM == CC_PLATFORM_WIN32 || CC_TARGET_PLATFORM == CC_PLATFORM_LINUX)
#define CC_CLIPPING_NODE_OPENGLES 0
#else
#define CC_CLIPPING_NODE_OPENGLES 1
#endif
2012-11-08 17:55:25 +08:00
NS_CC_BEGIN
#if CC_CLIPPING_NODE_OPENGLES
static void setProgram(Node *n, GLProgram *p)
2012-11-08 17:55:25 +08:00
{
2014-05-09 07:42:36 +08:00
n->setGLProgram(p);
2012-11-08 17:55:25 +08:00
auto& children = n->getChildren();
for(const auto &child : children) {
setProgram(child, p);
}
2012-11-08 17:55:25 +08:00
}
#endif
2012-11-08 17:55:25 +08:00
ClippingNode::ClippingNode()
: _stencil(nullptr)
, _stencilStateManager(new StencilStateManager())
, _originStencilProgram(nullptr)
{
}
2012-11-08 17:55:25 +08:00
ClippingNode::~ClippingNode()
2012-11-08 17:55:25 +08:00
{
2014-04-12 12:56:36 +08:00
if (_stencil)
{
_stencil->stopAllActions();
_stencil->release();
}
CC_SAFE_DELETE(_stencilStateManager);
2012-11-08 17:55:25 +08:00
}
ClippingNode* ClippingNode::create()
2012-11-08 17:55:25 +08:00
{
ClippingNode *ret = new (std::nothrow) ClippingNode();
if (ret && ret->init())
2012-11-08 17:55:25 +08:00
{
ret->autorelease();
2012-11-08 17:55:25 +08:00
}
else
{
CC_SAFE_DELETE(ret);
2012-11-08 17:55:25 +08:00
}
return ret;
2012-11-08 17:55:25 +08:00
}
ClippingNode* ClippingNode::create(Node *pStencil)
2012-11-08 17:55:25 +08:00
{
ClippingNode *ret = new (std::nothrow) ClippingNode();
if (ret && ret->init(pStencil))
2012-11-08 17:55:25 +08:00
{
ret->autorelease();
2012-11-08 17:55:25 +08:00
}
else
{
CC_SAFE_DELETE(ret);
2012-11-08 17:55:25 +08:00
}
return ret;
2012-11-08 17:55:25 +08:00
}
bool ClippingNode::init()
2012-11-08 17:55:25 +08:00
{
return init(nullptr);
2012-11-08 17:55:25 +08:00
}
bool ClippingNode::init(Node *stencil)
2012-11-08 17:55:25 +08:00
{
2015-12-17 21:55:47 +08:00
setStencil(stencil);
2012-11-08 17:55:25 +08:00
return true;
}
void ClippingNode::onEnter()
2012-11-08 17:55:25 +08:00
{
#if CC_ENABLE_SCRIPT_BINDING
if (_scriptType == kScriptTypeJavascript)
{
if (ScriptEngineManager::sendNodeEventToJSExtended(this, kNodeOnEnter))
return;
}
#endif
Node::onEnter();
if (_stencil != nullptr)
{
_stencil->onEnter();
}
else
{
CCLOG("ClippingNode warning: _stencil is nil.");
}
2012-11-08 17:55:25 +08:00
}
void ClippingNode::onEnterTransitionDidFinish()
2012-11-08 17:55:25 +08:00
{
#if CC_ENABLE_SCRIPT_BINDING
if (_scriptType == kScriptTypeJavascript)
{
if (ScriptEngineManager::sendNodeEventToJSExtended(this, kNodeOnEnterTransitionDidFinish))
return;
}
#endif
Node::onEnterTransitionDidFinish();
if (_stencil != nullptr)
{
_stencil->onEnterTransitionDidFinish();
}
2012-11-08 17:55:25 +08:00
}
void ClippingNode::onExitTransitionDidStart()
2012-11-08 17:55:25 +08:00
{
#if CC_ENABLE_SCRIPT_BINDING
if (_scriptType == kScriptTypeJavascript)
{
if (ScriptEngineManager::sendNodeEventToJSExtended(this, kNodeOnExitTransitionDidStart))
return;
}
#endif
if (_stencil != nullptr)
{
_stencil->onExitTransitionDidStart();
}
Node::onExitTransitionDidStart();
2012-11-08 17:55:25 +08:00
}
void ClippingNode::onExit()
2012-11-08 17:55:25 +08:00
{
#if CC_ENABLE_SCRIPT_BINDING
if (_scriptType == kScriptTypeJavascript)
{
if (ScriptEngineManager::sendNodeEventToJSExtended(this, kNodeOnExit))
return;
}
#endif
if (_stencil != nullptr)
{
_stencil->onExit();
}
Node::onExit();
2012-11-08 17:55:25 +08:00
}
void ClippingNode::visit(Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
2012-11-08 17:55:25 +08:00
{
if (!_visible || !hasContent())
2013-12-24 17:16:28 +08:00
return;
uint32_t flags = processParentFlags(parentTransform, parentFlags);
// IMPORTANT:
Squashed commit of the following: commit a9572b8913f3a38b59adbd7b4017ab9848a6b2b5 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed May 14 10:03:44 2014 -0700 math renames `Vector2` -> `Vec2` `Vector3` -> `Vec3` `Vector4` -> `Vec4` `Matrix` -> `Mat4` commit 4e107f4bd854c26bfceb52b063d6bd9cea02d6a3 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 09:24:28 2014 -0700 raw version of rename Vector3 commit 1d115573ebe96a5fc815fa44fbe6417ea7dba841 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 09:07:14 2014 -0700 rename Vector2 after merge commit ab2ed58c129dbc30a4c0970ed94568c5d271657b Merge: 1978d2d 86fb75a Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 09:05:30 2014 -0700 Merge branch 'v3' into v3_renameMathClassName Conflicts: tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UIButtonTest/UIButtonTest_Editor.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UICheckBoxTest/UICheckBoxTest_Editor.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UISliderTest/UISliderTest_Editor.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UITextFieldTest/UITextFieldTest.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UITextFieldTest/UITextFieldTest_Editor.cpp commit 1978d2d174877172ccddc083020a1bbf43ad3b39 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 08:51:45 2014 -0700 rename vector2 in tests/cpp-empty-test folder commit d4e0ff13dcce62724d2fece656543f26aa28e467 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:58:23 2014 -0700 rename vector2 in tests/cpp-tests cpp files commit be50ca2ec75e0fd32a6fcdaa15fe1ebb4cafe79f Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:52:57 2014 -0700 rename vector2 in tests/cpp-tests head files commit 6daef564400d4e28c4ce20859a68e0f583fed125 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:49:48 2014 -0700 rename vector2 in extension folder commit 8f3f0f65ceea92c9e7a0d87ab54e62220c5572e2 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:47:22 2014 -0700 rename vector2 in cocos/2d cpp files commit e1f3105aae06d595661a3030f519f7cc13aefbed Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:44:39 2014 -0700 rename vector2 in cocos/2d head files commit 6708d890bfe486109120c3cd4b9fe5c078b7108f Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:40:59 2014 -0700 rename vector2 in cocos/base folder commit d3978fa5447c31ea2f3ece5469b7e746dfba4248 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:40:43 2014 -0700 rename vector2 in cocos/deprecated folder commit 4bff45139363d6b9706edbbcf9f322d48b4fd019 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:40:26 2014 -0700 rename vector2 in cocos/editor-support folder commit 353d244c995f8b5d14f635c52aed8bc5e5fc1a6f Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:36:48 2014 -0700 rename vector2 in cocos/ui folder commit 758b8f4d513084b9922d7242e9b8f2c7f316de6c Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:32:39 2014 -0700 rename vector2 in cocos/renderer folder commit 0bd2710dd8714cecb993880bc37affd9ecb05c27 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:32:15 2014 -0700 rename vector2 in cocos/physics folder commit b7f0581c4587348bdbc1478d5374c2325735f21d Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:25:01 2014 -0700 rename vector2 in cocos/math folder commit a8631a8e1a4e2740807ccd9be9d70de6ecaad7dd Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:16:55 2014 -0700 rename Vector2 to Vec2 deprecate typedef Vector2
2014-05-15 01:07:09 +08:00
// To ease the migration to v3.0, we still support the Mat4 stack,
// but it is deprecated and your code should not rely on it
2014-04-02 22:48:22 +08:00
Director* director = Director::getInstance();
CCASSERT(nullptr != director, "Director is null when setting matrix stack");
2014-04-02 22:48:22 +08:00
director->pushMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
director->loadMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW, _modelViewTransform);
//Add group command
_groupCommand.init(_globalZOrder);
renderer->addCommand(&_groupCommand);
renderer->pushGroup(_groupCommand.getRenderQueueID());
_beforeVisitCmd.init(_globalZOrder);
2015-11-25 14:14:17 +08:00
_beforeVisitCmd.func = CC_CALLBACK_0(StencilStateManager::onBeforeVisit, _stencilStateManager);
renderer->addCommand(&_beforeVisitCmd);
2015-11-25 14:14:17 +08:00
2015-11-25 18:27:38 +08:00
auto alphaThreshold = this->getAlphaThreshold();
if (alphaThreshold < 1)
2014-01-02 16:19:23 +08:00
{
#if CC_CLIPPING_NODE_OPENGLES
2014-01-02 16:19:23 +08:00
// since glAlphaTest do not exists in OES, use a shader that writes
// pixel only if greater than an alpha threshold
2014-05-10 12:29:24 +08:00
GLProgram *program = GLProgramCache::getInstance()->getGLProgram(GLProgram::SHADER_NAME_POSITION_TEXTURE_ALPHA_TEST_NO_MV);
2014-01-02 16:19:23 +08:00
GLint alphaValueLocation = glGetUniformLocation(program->getProgram(), GLProgram::UNIFORM_NAME_ALPHA_TEST_VALUE);
// set our alphaThreshold
program->use();
2015-11-25 18:27:38 +08:00
program->setUniformLocationWith1f(alphaValueLocation, alphaThreshold);
2014-01-02 16:19:23 +08:00
// we need to recursively apply this shader to all the nodes in the stencil node
// FIXME: we should have a way to apply shader to all nodes without having to do this
2014-01-02 16:19:23 +08:00
setProgram(_stencil, program);
#endif
2014-01-02 16:19:23 +08:00
}
_stencil->visit(renderer, _modelViewTransform, flags);
_afterDrawStencilCmd.init(_globalZOrder);
2015-11-25 14:14:17 +08:00
_afterDrawStencilCmd.func = CC_CALLBACK_0(StencilStateManager::onAfterDrawStencil, _stencilStateManager);
renderer->addCommand(&_afterDrawStencilCmd);
2013-12-24 17:16:28 +08:00
int i = 0;
bool visibleByCamera = isVisitableByVisitingCamera();
2013-12-24 17:16:28 +08:00
if(!_children.empty())
{
sortAllChildren();
// draw children zOrder < 0
for(auto size = _children.size(); i < size; ++i)
2013-12-24 17:16:28 +08:00
{
auto node = _children.at(i);
if ( node && node->getLocalZOrder() < 0 )
node->visit(renderer, _modelViewTransform, flags);
2013-12-24 17:16:28 +08:00
else
break;
}
// self draw
2014-08-13 12:06:51 +08:00
if (visibleByCamera)
this->draw(renderer, _modelViewTransform, flags);
for(auto it=_children.cbegin()+i, itCend = _children.cend(); it != itCend; ++it)
(*it)->visit(renderer, _modelViewTransform, flags);
2013-12-24 17:16:28 +08:00
}
2014-08-13 12:06:51 +08:00
else if (visibleByCamera)
2013-12-24 17:16:28 +08:00
{
this->draw(renderer, _modelViewTransform, flags);
2013-12-24 17:16:28 +08:00
}
_afterVisitCmd.init(_globalZOrder);
2015-11-25 14:14:17 +08:00
_afterVisitCmd.func = CC_CALLBACK_0(StencilStateManager::onAfterVisit, _stencilStateManager);
renderer->addCommand(&_afterVisitCmd);
renderer->popGroup();
2013-12-24 17:16:28 +08:00
2014-04-02 22:48:22 +08:00
director->popMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
}
2015-03-16 17:11:17 +08:00
void ClippingNode::setCameraMask(unsigned short mask, bool applyChildren)
{
Node::setCameraMask(mask, applyChildren);
if (_stencil)
_stencil->setCameraMask(mask, applyChildren);
}
Node* ClippingNode::getStencil() const
{
return _stencil;
}
void ClippingNode::setStencil(Node *stencil)
{
//early out if the stencil is already set
2016-05-03 11:22:47 +08:00
if (_stencil == stencil)
return;
2015-12-17 21:55:47 +08:00
#if CC_ENABLE_GC_FOR_NATIVE_OBJECTS
auto sEngine = ScriptEngineManager::getInstance()->getScriptEngine();
if (sEngine)
{
if (_stencil)
sEngine->releaseScriptObject(this, _stencil);
if (stencil)
sEngine->retainScriptObject(this, stencil);
}
#endif // CC_ENABLE_GC_FOR_NATIVE_OBJECTS
//cleanup current stencil
if(_stencil != nullptr && _stencil->isRunning())
{
_stencil->onExitTransitionDidStart();
_stencil->onExit();
}
CC_SAFE_RELEASE_NULL(_stencil);
//initialise new stencil
_stencil = stencil;
CC_SAFE_RETAIN(_stencil);
if(_stencil != nullptr && this->isRunning())
{
_stencil->onEnter();
if(this->_isTransitionFinished)
{
_stencil->onEnterTransitionDidFinish();
}
}
if (_stencil != nullptr)
_originStencilProgram = _stencil->getGLProgram();
}
bool ClippingNode::hasContent() const
{
return _children.size() > 0;
}
GLfloat ClippingNode::getAlphaThreshold() const
{
2015-11-25 14:14:17 +08:00
return _stencilStateManager->getAlphaThreshold();
}
void ClippingNode::setAlphaThreshold(GLfloat alphaThreshold)
{
#if CC_CLIPPING_NODE_OPENGLES
if (alphaThreshold == 1 && alphaThreshold != _stencilStateManager->getAlphaThreshold())
{
// should reset program used by _stencil
setProgram(_stencil, _originStencilProgram);
}
#endif
2015-11-25 14:14:17 +08:00
_stencilStateManager->setAlphaThreshold(alphaThreshold);
}
bool ClippingNode::isInverted() const
{
2015-11-25 14:14:17 +08:00
return _stencilStateManager->isInverted();
}
void ClippingNode::setInverted(bool inverted)
{
2015-11-25 14:14:17 +08:00
_stencilStateManager->setInverted(inverted);
}
2012-11-08 17:55:25 +08:00
NS_CC_END