summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Palettes/Timeline/Snapper.h
blob: ea230bc0f4b1af9d16ff18408c5b9bcf56d92a18 (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
/****************************************************************************
**
** Copyright (C) 2016 NVIDIA Corporation.
** Copyright (C) 2017 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$
**
****************************************************************************/

#ifndef INCLUDED_SNAPPER_H
#define INCLUDED_SNAPPER_H 1

#pragma once

#include <set>
#include <vector>

class CSnapper
{
    typedef std::set<long> TTimeList;
    typedef std::vector<long> TOffsetList;

public:
    CSnapper(double inTimeRatio = .1);
    virtual ~CSnapper();

    void AddTime(long inTime);
    void AddPixelLocation(long inPixelLoc);

    void SetSnappingKeyframes(bool inIsSnappingKeyframes);
    bool IsSnappingKeyframes();
    void SetSnappingSelectedKeyframes(bool inIsSnappingSelectedKeyframes);
    bool IsSnappingSelectedKeyframes();

    void Clear();

    void SetVisibleArea(long inStartHeight, long inEndHeight);
    void PushOffset(long inHeight);
    void PopOffset();
    bool IsVisible(long inPosition, long inHeight);

    void SetTimeRatio(double inTimeRatio);

    void SetPeriodicInterval(long inInterval);

    bool InterpretTimeEx(long &ioTime, long inFlags);
    long InterpretTime(long inTime, long inFlags);

    void SetSnappingDistance(long inSnapDistance);

    void BeginDrag(long inPosition, long inOffset = 0);
    long ProcessDrag(long inTime, long inPosition, long inFlags);

    void SetSource(void *inSource);
    void *GetSource();

    void SetTimeOffset(long inTimeOffset);
    void SetStartEndTime(long theStartTime, long theEndTime);
    void SetKeyFrameClicked(bool inKeyFrameClicked);

protected:
    bool GetSnapTime(long &inTime, bool inShiftKeyDown);
    long GetClosestPeriodicInterval(long inTime);

    long m_theStartTime;
    long m_theEndTime;

    TTimeList m_Times;
    TOffsetList m_Offsets;

    double m_TimeRatio;

    bool m_IsSnappingKeyframes;
    bool m_IsSnappingSelectedKeyframes;
    long m_Offset;
    long m_StartHeight;
    long m_EndHeight;
    long m_SnapDistance;

    long m_PeriodicInterval;

    long m_InitialOffset;
    long m_ObjectTimeOffset;
    long m_TimeOffset;
    bool m_KeyFrameClicked;
    void *m_Source;
};

// Interface that will provider the info for snapping logic in the timebars and keyframes
class ISnappingListProvider
{
public:
    virtual ~ISnappingListProvider() {}

    virtual void PopulateSnappingList(CSnapper *inSnappingList) = 0;
};

#endif // INCLUDED_SNAPPER_H