Krita

TransparencyMask.h
1 /*
2  * SPDX-FileCopyrightText: 2017 Wolthera van Hövell tot Westerflier <[email protected]>
3  *
4  * SPDX-License-Identifier: LGPL-2.0-or-later
5  */
6 #ifndef LIBKIS_TRANSPARENCYMASK_H
7 #define LIBKIS_TRANSPARENCYMASK_H
8 
9 #include <QObject>
10 #include "Node.h"
11 
12 #include <kis_types.h>
13 
14 #include "kritalibkis_export.h"
15 #include "libkis.h"
16 
17 /**
18  * @brief The TransparencyMask class
19  * A transparency mask is a mask type node that can be used
20  * to show and hide parts of a layer.
21  *
22  */
23 class KRITALIBKIS_EXPORT TransparencyMask : public Node
24 {
25  Q_OBJECT
27 
28 public:
29  explicit TransparencyMask(KisImageSP image, QString name, QObject *parent = 0);
30  explicit TransparencyMask(KisImageSP image, KisTransparencyMaskSP mask, QObject *parent = 0);
31  ~TransparencyMask() override;
32 public Q_SLOTS:
33 
34  /**
35  * @brief type Krita has several types of nodes, split in layers and masks. Group
36  * layers can contain other layers, any layer can contain masks.
37  *
38  * @return transparencymask
39  *
40  * If the Node object isn't wrapping a valid Krita layer or mask object, and
41  * empty string is returned.
42  */
43  virtual QString type() const override;
44 
45  Selection *selection() const;
46 
47  void setSelection(Selection *selection);
48 };
49 
50 #endif // LIBKIS_TRANSPARENCYMASK_H
51 
virtual QString type() const
type Krita has several types of nodes, split in layers and masks.
Definition: Node.cpp:456
Q_SLOTSQ_SLOTS
Selection represents a selection on Krita.
Definition: Selection.h:30
The TransparencyMask class A transparency mask is a mask type node that can be used to show and hide ...
Node represents a layer or mask in a Krita image's Node hierarchy.
Definition: Node.h:21
Q_DISABLE_COPY(Class)
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Fri Sep 22 2023 04:09:51 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.