1/****************************************************************************
2**
3** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "quick3dentity_p.h"
41
42#include <Qt3DCore/qcomponent.h>
43
44QT_BEGIN_NAMESPACE
45
46namespace Qt3DCore {
47namespace Quick {
48
49/*!
50 \qmltype Entity
51 \instantiates Qt3DCore::QEntity
52 \inherits Node
53 \inqmlmodule Qt3D.Core
54 \since 5.5
55
56 \brief Entity is a \l Node subclass that can aggregate several
57 \l Component3D instances that will specify its behavior.
58
59 By itself a Entity is an empty shell. The behavior of a Entity
60 object is defined by the \l Component3D objects it references. Each Qt3D
61 backend aspect will be able to interpret and process an Entity by
62 recognizing which components it is made up of. One aspect may decide to only
63 process entities composed of a single \l Transform component whilst
64 another may focus on \l MouseHandler.
65
66 \sa Qt3D.Core::Component3D, Qt3D.Core::Transform
67 */
68
69/*!
70 \qmlproperty list<Component3D> Entity::components
71 Holds the list of \l Component3D instances, which define the behavior
72 of the entity.
73 \readonly
74 */
75
76Quick3DEntity::Quick3DEntity(QObject *parent)
77 : QObject(parent)
78{
79}
80
81
82QQmlListProperty<QComponent> Quick3DEntity::componentList()
83{
84 return QQmlListProperty<Qt3DCore::QComponent>(this, 0,
85 Quick3DEntity::qmlAppendComponent,
86 Quick3DEntity::qmlComponentsCount,
87 Quick3DEntity::qmlComponentAt,
88 Quick3DEntity::qmlClearComponents);
89}
90
91void Quick3DEntity::qmlAppendComponent(QQmlListProperty<QComponent> *list, QComponent *comp)
92{
93 if (comp == nullptr)
94 return;
95 Quick3DEntity *self = static_cast<Quick3DEntity *>(list->object);
96 self->m_managedComponents.push_back(t: comp);
97 self->parentEntity()->addComponent(comp);
98}
99
100QComponent *Quick3DEntity::qmlComponentAt(QQmlListProperty<QComponent> *list, int index)
101{
102 Quick3DEntity *self = static_cast<Quick3DEntity *>(list->object);
103 return self->parentEntity()->components().at(i: index);
104}
105
106int Quick3DEntity::qmlComponentsCount(QQmlListProperty<QComponent> *list)
107{
108 Quick3DEntity *self = static_cast<Quick3DEntity *>(list->object);
109 return self->parentEntity()->components().count();
110}
111
112void Quick3DEntity::qmlClearComponents(QQmlListProperty<QComponent> *list)
113{
114 Quick3DEntity *self = static_cast<Quick3DEntity *>(list->object);
115 for (QComponent *comp : qAsConst(t&: self->m_managedComponents))
116 self->parentEntity()->removeComponent(comp);
117 self->m_managedComponents.clear();
118}
119
120} // namespace Quick
121} // namespace Qt3DCore
122
123QT_END_NAMESPACE
124

source code of qt3d/src/quick3d/quick3d/items/quick3dentity.cpp