summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Qt3DStudio/Application/ProjectFile.h
blob: b53f559cb2a616f5aba2235504a74d93041783e6 (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
/****************************************************************************
**
** 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$
**
****************************************************************************/

#ifndef PROJECTFILE_H
#define PROJECTFILE_H

#include "Qt3DSFileTools.h"
#include <QtXml/qdom.h>

namespace Q3DStudio {
class CFilePath;
class CString;
}
struct SubPresentationRecord;
class CDataInputDialogItem;

class ProjectFile : public QObject
{
    Q_OBJECT

public:
    ProjectFile();

    struct VariantGroup {
        QString m_color;
        QStringList m_tags;
    };

    void create(const QString &uiaPath);
    void ensureProjectFile();
    void initProjectFile(const QString &presPath);
    static void parseDataInputElem(const QDomElement &elem,
                                   QMap<QString, CDataInputDialogItem *> &dataInputs);
    static void loadDataInputs(const QString &projFile,
                               QMap<QString, CDataInputDialogItem *> &dataInputs);
    void loadSubpresentationsAndDatainputs(
            QVector<SubPresentationRecord> &subpresentations,
            QMap<QString, CDataInputDialogItem *> &datainputs);
    void writePresentationId(const QString &id, const QString &src = {});
    void updateDocPresentationId();
    void addPresentationNode(const QString &uip, const QString &pId = {});
    void addPresentationNodes(const QHash<QString, QString> &nodeList);
    bool isUniquePresentationId(const QString &id, const QString &src = {}) const;
    QString getUniquePresentationName(const QString &presSrc) const;
    QString getProjectPath() const;
    QString getProjectFilePath() const;
    QString getProjectName() const;
    QString getPresentationId(const QString &src) const;
    QString getAbsoluteFilePathTo(const QString &relFilePath) const;
    QString getRelativeFilePathTo(const QString &absFilePath) const;
    QString createPreview();
    QMultiMap<QString, QPair<QString, QString>> getDiBindingtypesFromSubpresentations() const;

    static QString getInitialPresentationSrc(const QString &uiaPath);
    static void getPresentations(const QString &inUiaPath,
                                 QVector<SubPresentationRecord> &outSubpresentations,
                                 const QString &excludePresentationSrc = {});
    QString initialPresentation() const { return m_initialPresentation; }
    void setInitialPresentation(const QString &initialId);
    bool renamePresentationFile(const QString &oldName, const QString &newName);
    void deletePresentationFile(const QString &filePath);
    void renameMaterial(const QString &oldName, const QString &newName);
    bool duplicatePresentation(const QString &oldPres, const QString &newPres);
    void loadVariants(const QString &filePath = {});
    void addVariantTag(const QString &group, const QString &newTag);
    void renameVariantTag(const QString &group, const QString &oldTag, const QString &newTag);
    void deleteVariantTag(const QString &group, const QString &tag);
    void addVariantGroup(const QString &newGroup);
    void renameVariantGroup(const QString &oldGroup, const QString &newGroup);
    void deleteVariantGroup(const QString &group);
    void changeVariantGroupColor(const QString &group, const QString &newColor);
    bool isVariantGroupUnique(const QString &group) const;
    bool isVariantTagUnique(const QString &group, const QString &tag) const;

    QHash<QString, VariantGroup> variantsDef() const { return m_variantsDef; }
    QStringList variantsDefKeys() const { return m_variantsDefKeys; }

Q_SIGNALS:
    void presentationIdChanged(const QString &path, const QString &id);
    void assetNameChanged();

private:
    enum class VariantsUpdateMode { Rename, Delete };

    QString ensureUniquePresentationId(const QString &id) const;
    bool tagExistsInUip(const QString &src, const QString &group, const QString &tag = {}) const;
    void updateVariantsInUip(const QString &src, const VariantsUpdateMode &updateType,
                             const QString &group, const QString &tag = {},
                             const QString &newName = {});

    QFileInfo m_fileInfo; // uia file info
    QString m_initialPresentation;
    QHash<QString, VariantGroup> m_variantsDef; // definition of variants
    QStringList m_variantsDefKeys; // maintains insertion order
    int m_variantColorsIter = -1; // tracks the next default color to assign to newly created group
};

#endif // PROJECTFILE_H