2019-11-23 20:27:39 +08:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2012 Pierre-David Bélanger
|
|
|
|
* Copyright (c) 2012 cocos2d-x.org
|
|
|
|
* Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
* Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
*
|
2022-07-09 22:23:34 +08:00
|
|
|
* https://axis-project.github.io/
|
2019-11-23 20:27:39 +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.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "2d/CCNode.h"
|
|
|
|
#include "renderer/CCGroupCommand.h"
|
|
|
|
#include "renderer/CCCustomCommand.h"
|
|
|
|
#include "renderer/CCCallbackCommand.h"
|
|
|
|
#include <unordered_map>
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
class StencilStateManager;
|
|
|
|
/**
|
|
|
|
* @addtogroup _2d
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
/** ClippingNode is a subclass of Node.
|
|
|
|
* It draws its content (children) clipped using a stencil.
|
|
|
|
* The stencil is an other Node that will not be drawn.
|
|
|
|
* The clipping is done using the alpha part of the stencil (adjusted with an alphaThreshold).
|
|
|
|
*/
|
2022-07-15 19:44:31 +08:00
|
|
|
class CC_DLL ClippingNode : public Node
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/** Creates and initializes a clipping node without a stencil.
|
|
|
|
*
|
|
|
|
* @return An autorelease ClippingNode.
|
|
|
|
*/
|
|
|
|
static ClippingNode* create();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Creates and initializes a clipping node with an other node as its stencil.
|
|
|
|
* The stencil node will be retained.
|
|
|
|
* @param stencil The stencil node.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
static ClippingNode* create(Node* stencil);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** The Node to use as a stencil to do the clipping.
|
|
|
|
* The stencil node will be retained.
|
|
|
|
* This default to nil.
|
|
|
|
*
|
|
|
|
* @return The stencil node.
|
|
|
|
*/
|
|
|
|
Node* getStencil() const;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Set the Node to use as a stencil to do the clipping.
|
|
|
|
*
|
|
|
|
* @param stencil The Node to use as a stencil to do the clipping.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void setStencil(Node* stencil);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/** If stencil has no children it will not be drawn.
|
|
|
|
* If you have custom stencil-based node with stencil drawing mechanics other then children-based,
|
|
|
|
* then this method should return true every time you wish stencil to be visited.
|
|
|
|
* By default returns true if has any children attached.
|
|
|
|
*
|
|
|
|
* @return If you have custom stencil-based node with stencil drawing mechanics other then children-based,
|
|
|
|
* then this method should return true every time you wish stencil to be visited.
|
|
|
|
* By default returns true if has any children attached.
|
|
|
|
* @js NA
|
|
|
|
*/
|
|
|
|
virtual bool hasContent() 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).
|
|
|
|
*
|
|
|
|
* @return The alpha threshold value,Should be a float between 0 and 1.
|
|
|
|
*/
|
|
|
|
float getAlphaThreshold() const;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
/** Set the alpha threshold.
|
|
|
|
*
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param alphaThreshold The alpha threshold.
|
|
|
|
*/
|
|
|
|
void setAlphaThreshold(float alphaThreshold);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Inverted. If this is set to true,
|
|
|
|
* the stencil is inverted, so the content is drawn where the stencil is NOT drawn.
|
|
|
|
* This default to false.
|
|
|
|
*
|
|
|
|
* @return If the clippingNode is Inverted, it will be return true.
|
|
|
|
*/
|
|
|
|
bool isInverted() const;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Set the ClippingNode whether or not invert.
|
|
|
|
*
|
|
|
|
* @param inverted A bool Type,to set the ClippingNode whether or not invert.
|
|
|
|
*/
|
|
|
|
void setInverted(bool inverted);
|
|
|
|
|
|
|
|
// Overrides
|
|
|
|
/**
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual void onEnter() override;
|
|
|
|
/**
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual void onEnterTransitionDidFinish() override;
|
|
|
|
/**
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual void onExitTransitionDidStart() override;
|
|
|
|
/**
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual void onExit() override;
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual void visit(Renderer* renderer, const Mat4& parentTransform, uint32_t parentFlags) override;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
virtual void setCameraMask(unsigned short mask, bool applyChildren = true) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2022-03-18 21:46:07 +08:00
|
|
|
ClippingNode();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual ~ClippingNode();
|
|
|
|
|
|
|
|
/** Initializes a clipping node without a stencil.
|
|
|
|
*/
|
|
|
|
virtual bool init() override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** 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.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual bool init(Node* stencil);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
protected:
|
|
|
|
void setProgramStateRecursively(Node* node, backend::ProgramState* programState);
|
|
|
|
void restoreAllProgramStates();
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
Node* _stencil = nullptr;
|
|
|
|
StencilStateManager* _stencilStateManager = nullptr;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
GroupCommand _groupCommandStencil;
|
|
|
|
GroupCommand _groupCommandChildren;
|
2022-06-24 14:18:48 +08:00
|
|
|
//CallbackCommand _afterDrawStencilCmd;
|
|
|
|
//CallbackCommand _afterVisitCmd;
|
2019-11-23 20:27:39 +08:00
|
|
|
std::unordered_map<Node*, backend::ProgramState*> _originalStencilProgramState;
|
|
|
|
|
|
|
|
private:
|
2022-07-15 19:44:31 +08:00
|
|
|
CC_DISALLOW_COPY_AND_ASSIGN(ClippingNode);
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
/** @} */
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|