summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Client/Code/Core/Commands/CmdDataModelBase.h
blob: deec6a58ce7c6e3d42f01351f7632201dd8511ba (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
/****************************************************************************
**
** 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_CMD_DATAMODEL_BASE_H
#define INCLUDED_CMD_DATAMODEL_BASE_H 1

#pragma once

//==============================================================================
//	Include
//==============================================================================
#include "Cmd.h"
#include "CmdDataModel.h"
#include "Doc.h"
#include "Qt3DSDMHandles.h"

//==============================================================================
/**
 * Base class that provide basic Update/Finalize functionality, when changing DataModel data.
 */
template <class TDataType>
class CCmdDataModelBase : public CCmd, public qt3dsdm::CmdDataModel
{
protected: // Members
    CDoc *m_Doc;
    TDataType m_Value;

public: // Construction
    CCmdDataModelBase(CDoc *inDoc, TDataType inValue)
        : CmdDataModel(*inDoc)
        , m_Doc(inDoc)
        , m_Value(inValue)
    {
    }

    virtual void DoOperation() = 0;

    //======================================================================
    //	Do/Redo
    //======================================================================
    unsigned long Do() override
    {
        if (!ConsumerExists()) {
            SetConsumer();
            DoOperation();
        } else {
            DataModelRedo();
        }

        return 0;
    }

    virtual void Update(const TDataType &inValue)
    {
        if (!ConsumerExists())
            SetConsumer();
        m_Value = inValue;
        DoOperation();
    }

    void Finalize(const TDataType &inValue)
    {
        if (ConsumerExists()) {
            m_Value = inValue;
            DoOperation();
        }
        ReleaseConsumer();
    }

    //======================================================================
    //	Undo
    //======================================================================
    unsigned long Undo() override
    {
        if (ConsumerExists()) {
            DataModelUndo();
        }

        return 0;
    }

    //======================================================================
    //	ToString
    //======================================================================
    QString ToString() override = 0;

    TDataType GetValue() const { return m_Value; }
};

#endif