summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Qt3DStudio/Palettes/TimelineGraphicsView/ui/Ruler.cpp
blob: 62c6de01610c8801d9ec64ab1ce841a32a6d834a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "Ruler.h"
#include "TimelineConstants.h"
#include "StudioPreferences.h"

#include <QtGui/qpainter.h>
#include <QtWidgets/qwidget.h>

Ruler::Ruler(TimelineItem *parent) : TimelineItem(parent)
{
    setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Fixed);
}

void Ruler::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
{
    Q_UNUSED(option)

    double xStep = TimelineConstants::RULER_SEC_W / TimelineConstants::RULER_SEC_DIV * m_timeScale;
    double activeSegmentsWidth = TimelineConstants::RULER_EDGE_OFFSET
            + m_duration / 1000.0 * xStep * TimelineConstants::RULER_SEC_DIV;
    double totalSegmentsWidth = TimelineConstants::RULER_EDGE_OFFSET
            + m_maxDuration / 1000.0 * xStep * TimelineConstants::RULER_SEC_DIV;

    // Ruler painted width to be at least widget width
    double minRulerWidth = widget->width();
    double rowXMax = std::max(minRulerWidth, totalSegmentsWidth);

    painter->save();
    painter->setPen(CStudioPreferences::timelineRulerColorDisabled());
    painter->drawLine(TimelineConstants::RULER_EDGE_OFFSET,
                      TimelineConstants::RULER_BASE_Y,
                      rowXMax + TimelineConstants::RULER_EDGE_OFFSET,
                      TimelineConstants::RULER_BASE_Y);
    painter->setPen(CStudioPreferences::timelineRulerColor());
    painter->drawLine(TimelineConstants::RULER_EDGE_OFFSET,
                      TimelineConstants::RULER_BASE_Y,
                      activeSegmentsWidth,
                      TimelineConstants::RULER_BASE_Y);

    QFont font = painter->font();
    font.setPointSize(8);
    painter->setFont(font);

    const int margin = 50;
    const int secDiv = TimelineConstants::RULER_SEC_DIV;
    double rowX = 0;
    bool useDisabledColor = false;
    for (int i = 0; rowX < rowXMax; i++) {
        rowX = TimelineConstants::RULER_EDGE_OFFSET + xStep * i;

        // Optimization to skip painting outside the visible area
        if (rowX < (m_viewportX - margin) || rowX > (m_viewportX + minRulerWidth + margin))
            continue;

        const int h = i % secDiv == 0 ? TimelineConstants::RULER_DIV_H1
         : i % secDiv == secDiv * 0.5 ? TimelineConstants::RULER_DIV_H2
                                      : TimelineConstants::RULER_DIV_H3;

        if (!useDisabledColor && rowX > activeSegmentsWidth) {
            painter->setPen(CStudioPreferences::timelineRulerColorDisabled());
            useDisabledColor = true;
        }
        painter->drawLine(QPointF(rowX, TimelineConstants::RULER_BASE_Y - h),
                          QPointF(rowX, TimelineConstants::RULER_BASE_Y - 1));

        // See if label should be shown at this tick at this zoom level
        bool drawTimestamp = false;
        if ((i % (secDiv * 4) == 0)
                || (i % (secDiv * 2) == 0 && m_timeScale >= TimelineConstants::RULER_TICK_SCALE1)
                || (i % secDiv == 0 && m_timeScale >= TimelineConstants::RULER_TICK_SCALE2)
                || (i % secDiv == secDiv * 0.5
                    && m_timeScale >= TimelineConstants::RULER_TICK_SCALE3)
                || (m_timeScale >= TimelineConstants::RULER_TICK_SCALE4)) {
            drawTimestamp = true;
        }

        if (drawTimestamp) {
            QRectF timestampPos = QRectF(TimelineConstants::RULER_EDGE_OFFSET
                                         + xStep * i - TimelineConstants::RULER_LABEL_W / 2,
                                         1, TimelineConstants::RULER_LABEL_W,
                                         TimelineConstants::RULER_LABEL_H);
            painter->drawText(timestampPos, Qt::AlignCenter,
                              timestampString(i * 1000 / TimelineConstants::RULER_SEC_DIV));
        }

    }

    painter->restore();
}

void Ruler::setTimelineScale(double scl)
{
    m_timeScale = scl;
    update();
}

// convert distance values to time (milliseconds)
long Ruler::distanceToTime(double distance) const
{
    return distance / (TimelineConstants::RULER_MILLI_W * m_timeScale);
}

// convert time (milliseconds) values to distance
double Ruler::timeToDistance(long time) const
{
    return time * TimelineConstants::RULER_MILLI_W * m_timeScale;
}

double Ruler::timelineScale() const
{
    return m_timeScale;
}

// Returns end of right-most layer/component row.
// Active color of ruler is used up to this point.
// Slide plays up to this point.
long Ruler::duration() const
{
    return m_duration;
}

// Returns end of right-most row.
// Ruler steps & labels are drawn up to this point.
// Timeline scrollbar allows scrolling up to this point.
long Ruler::maxDuration() const
{
    return m_maxDuration;
}

void Ruler::setDuration(long duration)
{
    if (m_duration != duration) {
        m_duration = duration;
        update();
        emit durationChanged(m_duration);
    }
}

void Ruler::setMaxDuration(long maxDuration)
{
    if (m_maxDuration != maxDuration) {
        m_maxDuration = maxDuration;
        update();
        emit maxDurationChanged(m_maxDuration);
    }
}

void Ruler::setViewportX(int viewportX)
{
    if (m_viewportX != viewportX) {
        m_viewportX = viewportX;
        emit viewportXChanged(m_viewportX);
        update();
    }
}

int Ruler::viewportX() const
{
    return m_viewportX;
}

// Returns timestamp in mm:ss.ttt or ss.ttt format
const QString Ruler::timestampString(int timeMs)
{
    static const QString zeroString = tr("0");
    static const QChar fillChar = tr("0").at(0);
    static const QString noMinutesTemplate = tr("%1.%2");
    static const QString minutesTemplate = tr("%1:%2.%3");

    int ms = timeMs % 1000;
    int s = timeMs % 60000 / 1000;
    int m = timeMs % 3600000 / 60000;
    const QString msString = QString::number(ms).rightJustified(3, fillChar);
    const QString sString = QString::number(s);

    if (timeMs == 0) {
        return zeroString;
    } else if (m == 0) {
        if (s < 10)
            return noMinutesTemplate.arg(sString).arg(msString);
        else
            return noMinutesTemplate.arg(sString.rightJustified(2, fillChar)).arg(msString);
    } else {
        return minutesTemplate.arg(m).arg(sString.rightJustified(2, fillChar)).arg(msString);
    }
}

int Ruler::type() const
{
    // Enable the use of qgraphicsitem_cast with this item.
    return TypeRuler;
}