summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/engine/q3dobject.cpp
blob: c9e417ddc28a33638ad82eaaa8149b4ee32e3e50 (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#include "q3dobject_p.h"
#include "q3dscene_p.h"

QT_BEGIN_NAMESPACE

/*!
   \class Q3DObject
   \inmodule QtDataVisualization
   \brief The Q3DObject class is a simple base class for all the objects in a
   3D scene.
   \since QtDataVisualization 1.0

    Contains position information for an object in a 3D scene.
    The object is considered to be a single point in the coordinate space without dimensions.
*/

/*!
   \qmltype Object3D
   \inqmlmodule QtDataVisualization
   \since QtDataVisualization 1.0
   \ingroup datavisualization_qml
   \instantiates Q3DObject
   \brief A base type for all the objects in a 3D scene.

    An uncreatable base type that contains position information for an object in
    a 3D scene. The object is considered to be a single point in the coordinate space without
    dimensions.
*/

/*!
 * \qmlproperty vector3d Object3D::position
 *
 * The 3D position of the object.
 *
 * \note Currently setting this property has no effect for Camera3D, as the position is handled
 * internally.
 */

/*!
 * Constructs a new 3D object with the position set to origin by default. An
 * optional \a parent parameter can be given and is then passed to the QObject
 * constructor.
 */
Q3DObject::Q3DObject(QObject *parent) :
    QObject(parent),
    d_ptr(new Q3DObjectPrivate(this))
{
}

/*!
 *  Destroys the 3D object.
 */
Q3DObject::~Q3DObject()
{
}

/*!
 * Copies the 3D object position from the given \a source 3D object to this 3D object instance.
 */
void Q3DObject::copyValuesFrom(const Q3DObject &source)
{
    d_ptr->m_position = source.d_ptr->m_position;
    setDirty(true);
}

/*!
 * \property Q3DObject::parentScene
 *
 * \brief The parent scene as a read only value.
 *
 * If the object has no parent scene, the value is 0.
 */
Q3DScene *Q3DObject::parentScene()
{
    return qobject_cast<Q3DScene *>(parent());
}

/*!
 * \property Q3DObject::position
 *
 * \brief The 3D position of the object.
 *
 * \note Currently setting this property has no effect for Q3DCamera, as the position is handled
 * internally.
 */
QVector3D Q3DObject::position() const
{
    return d_ptr->m_position;
}

void Q3DObject::setPosition(const QVector3D &position)
{
    if (d_ptr->m_position != position) {
        d_ptr->m_position = position;
        setDirty(true);
        emit positionChanged(d_ptr->m_position);
    }
}

/*!
 * Sets \a dirty to \c true if the 3D object has changed since the last update.
 */
void Q3DObject::setDirty(bool dirty)
{
    d_ptr->m_isDirty = dirty;
    if (parentScene())
        parentScene()->d_ptr->markDirty();
}

/*!
 * Returns whether the 3D object has changed.
 */
bool Q3DObject::isDirty() const
{
    return d_ptr->m_isDirty;
}

Q3DObjectPrivate::Q3DObjectPrivate(Q3DObject *q) :
    q_ptr(q),
    m_isDirty(true)
{
}

Q3DObjectPrivate::~Q3DObjectPrivate()
{

}

QT_END_NAMESPACE