axmol/core/2d/CCClippingRectangleNode.h

106 lines
3.4 KiB
C
Raw Normal View History

2014-09-29 15:07:05 +08:00
/*
* cocos2d for iPhone: http://www.cocos2d-iphone.org
2022-08-08 18:02:17 +08:00
* cocos2d-x: https://axys1.github.io/
2014-09-29 15:07:05 +08:00
*
* Copyright (c) 2012 Pierre-David Bélanger
* Copyright (c) 2012 cocos2d-x.org
* Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
2014-09-29 15:07:05 +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.
*
*/
2019-03-13 14:27:47 +08:00
#pragma once
2014-09-29 15:07:05 +08:00
#include "2d/CCNode.h"
2019-03-13 14:27:47 +08:00
#include "renderer/CCCallbackCommand.h"
2014-09-29 15:07:05 +08:00
NS_AX_BEGIN
2014-09-29 15:07:05 +08:00
/**
* @addtogroup _2d
* @{
*/
2015-03-19 13:41:21 +08:00
/**
@brief Clipping Rectangle Node.
@details A node that clipped with specified rectangle.
2015-09-18 13:39:22 +08:00
The region of ClippingRectangleNode doesn't support any transform except scale.
@js NA
2015-03-19 13:41:21 +08:00
*/
2022-07-15 19:17:01 +08:00
class AX_DLL ClippingRectangleNode : public Node
2021-12-25 10:04:45 +08:00
{
2014-09-29 15:07:05 +08:00
public:
2015-03-19 13:41:21 +08:00
/**
@brief Create node with specified clipping region.
@param clippingRegion Specify the clipping rectangle.
@return If the creation success, return a pointer of ClippingRectangleNode; otherwise return nil.
*/
static ClippingRectangleNode* create(const Rect& clippingRegion);
2015-03-19 13:41:21 +08:00
/**
@brief Create a clipping rectangle node.
@return If the creation success, return a pointer of ClippingRectangleNode; otherwise return nil.
*/
static ClippingRectangleNode* create();
2021-12-25 10:04:45 +08:00
2015-03-19 13:41:21 +08:00
/**
@brief Get the clipping rectangle.
@return The clipping rectangle.
*/
2021-12-25 10:04:45 +08:00
const Rect& getClippingRegion() const { return _clippingRegion; }
2015-03-19 13:41:21 +08:00
/**
@brief Set the clipping rectangle.
@param clippingRegion Specify the clipping rectangle.
2015-03-19 13:41:21 +08:00
*/
2014-09-29 15:07:05 +08:00
void setClippingRegion(const Rect& clippingRegion);
2021-12-25 10:04:45 +08:00
2015-03-19 13:41:21 +08:00
/**
@brief Get whether the clipping is enabled or not.
@return Whether the clipping is enabled or not. Default is true.
*/
2021-12-25 10:04:45 +08:00
bool isClippingEnabled() const { return _clippingEnabled; }
2015-03-19 13:41:21 +08:00
/**
@brief Enable/Disable the clipping.
@param enabled Pass true to enable clipping. Pass false to disable clipping.
2015-03-19 13:41:21 +08:00
*/
2021-12-25 10:04:45 +08:00
void setClippingEnabled(bool enabled) { _clippingEnabled = enabled; }
2014-09-29 15:07:05 +08:00
2021-12-25 10:04:45 +08:00
// virtual void draw(Renderer* renderer, const Mat4 &transform, uint32_t flags) override;
virtual void visit(Renderer* renderer, const Mat4& parentTransform, uint32_t parentFlags) override;
2014-09-29 15:07:05 +08:00
protected:
2019-03-13 14:27:47 +08:00
ClippingRectangleNode() = default;
2021-12-25 10:04:45 +08:00
2014-09-29 15:07:05 +08:00
void onBeforeVisitScissor();
void onAfterVisitScissor();
2021-12-25 10:04:45 +08:00
2014-09-29 15:07:05 +08:00
Rect _clippingRegion;
2019-03-13 14:27:47 +08:00
bool _clippingEnabled = true;
bool _oldScissorTest = false;
2021-12-25 10:04:45 +08:00
2022-06-24 14:18:48 +08:00
CallbackCommand* _beforeVisitCmdScissor;
CallbackCommand* _afterVisitCmdScissor;
2014-09-29 15:07:05 +08:00
};
// end of _2d group
/// @}
NS_AX_END