1/****************************************************************************
2**
3** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qpolygonoffset.h"
41#include "qpolygonoffset_p.h"
42#include <Qt3DRender/private/qrenderstatecreatedchange_p.h>
43
44QT_BEGIN_NAMESPACE
45
46namespace Qt3DRender {
47
48/*!
49 \class Qt3DRender::QPolygonOffset
50 \brief The QPolygonOffset class sets the scale and steps to calculate depth
51 values for polygon offsets.
52 \since 5.7
53 \inmodule Qt3DRender
54 \ingroup renderstates
55
56 A QPolygonOffset class adds an offset to the fragment depth value prior to
57 depth test and depth write. The offset can be used to avoid z-fighting when
58 rendering polygons with very close depth values such as decals.
59 */
60
61/*!
62 \qmltype PolygonOffset
63 \brief The PolygonOffset type sets the scale and steps to calculate depth
64 values for polygon offsets.
65 \since 5.7
66 \inqmlmodule Qt3D.Render
67 \ingroup renderstates
68 \inherits RenderState
69 \instantiates Qt3DRender::QPolygonOffset
70
71 A PolygonOffset type adds an offset to the fragment depth value prior to
72 depth test and depth write. The offset can be used to avoid z-fighting when
73 rendering polygons with very close depth values such as decals.
74 */
75
76/*!
77 \qmlproperty real PolygonOffset::scaleFactor
78 Holds the scale factor used to create a variable depth offset for
79 each polygon. Default value is 0.
80*/
81
82/*!
83 \qmlproperty real PolygonOffset::depthSteps
84 Holds the units that create constant depth offsets. Default value is 0.
85*/
86
87/*!
88 \property QPolygonOffset::scaleFactor
89 Holds the scale factor used to create a variable depth offset for
90 each polygon. Default value is 0.
91*/
92
93/*!
94 \property QPolygonOffset::depthSteps
95 Holds the units that create constant depth offsets. Default value is 0.
96*/
97
98/*!
99 The constructor creates a new QPolygonOffset::QPolygonOffset instance
100 with the specified \a parent
101 */
102QPolygonOffset::QPolygonOffset(QNode *parent)
103 : QRenderState(*new QPolygonOffsetPrivate, parent)
104{
105}
106
107/*! \internal */
108QPolygonOffset::~QPolygonOffset()
109{
110}
111
112float QPolygonOffset::scaleFactor() const
113{
114 Q_D(const QPolygonOffset);
115 return d->m_scaleFactor;
116}
117
118void QPolygonOffset::setScaleFactor(float scaleFactor)
119{
120 Q_D(QPolygonOffset);
121 if (d->m_scaleFactor != scaleFactor) {
122 d->m_scaleFactor = scaleFactor;
123 emit scaleFactorChanged(scaleFactor: d->m_scaleFactor);
124 }
125}
126
127float QPolygonOffset::depthSteps() const
128{
129 Q_D(const QPolygonOffset);
130 return d->m_depthSteps;
131}
132
133void QPolygonOffset::setDepthSteps(float depthSteps)
134{
135 Q_D(QPolygonOffset);
136 if (d->m_depthSteps != depthSteps) {
137 d->m_depthSteps = depthSteps;
138 emit depthStepsChanged(depthSteps: d->m_depthSteps);
139 }
140}
141
142Qt3DCore::QNodeCreatedChangeBasePtr QPolygonOffset::createNodeCreationChange() const
143{
144 auto creationChange = QRenderStateCreatedChangePtr<QPolygonOffsetData>::create(arguments: this);
145 auto &data = creationChange->data;
146 Q_D(const QPolygonOffset);
147 data.scaleFactor = d->m_scaleFactor;
148 data.depthSteps = d->m_depthSteps;
149 return creationChange;
150}
151
152} // namespace Qt3DRender
153
154QT_END_NAMESPACE
155

source code of qt3d/src/render/renderstates/qpolygonoffset.cpp