diff options
Diffstat (limited to 'src/quick3d/quick3d/items')
| -rw-r--r-- | src/quick3d/quick3d/items/quick3dconfiguration.cpp | 8 | ||||
| -rw-r--r-- | src/quick3d/quick3d/items/quick3dentity.cpp | 11 | ||||
| -rw-r--r-- | src/quick3d/quick3d/items/quick3dentityloader.cpp | 16 | ||||
| -rw-r--r-- | src/quick3d/quick3d/items/quick3dnode.cpp | 19 | ||||
| -rw-r--r-- | src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp | 40 | ||||
| -rw-r--r-- | src/quick3d/quick3d/items/quick3dtransform.cpp | 14 |
6 files changed, 91 insertions, 17 deletions
diff --git a/src/quick3d/quick3d/items/quick3dconfiguration.cpp b/src/quick3d/quick3d/items/quick3dconfiguration.cpp index 5e205cb6e..2ee792af7 100644 --- a/src/quick3d/quick3d/items/quick3dconfiguration.cpp +++ b/src/quick3d/quick3d/items/quick3dconfiguration.cpp @@ -50,6 +50,11 @@ namespace Qt3D { namespace Quick { +/*! + \qmltype Configuration + \inqmlmodule Qt3D + \since 5.5 +*/ Quick3DConfiguration::Quick3DConfiguration(QObject *parent) : QObject(parent) , m_camera(Q_NULLPTR) @@ -65,6 +70,9 @@ void Quick3DConfiguration::setControlledCamera(QCamera *camera) } } +/*! + \qmlproperty Camera Qt3D::Configuration::controlledCamera +*/ QCamera *Quick3DConfiguration::controlledCamera() const { return m_camera; diff --git a/src/quick3d/quick3d/items/quick3dentity.cpp b/src/quick3d/quick3d/items/quick3dentity.cpp index d98c7c826..c00eb0899 100644 --- a/src/quick3d/quick3d/items/quick3dentity.cpp +++ b/src/quick3d/quick3d/items/quick3dentity.cpp @@ -43,11 +43,22 @@ namespace Qt3D { namespace Quick { +/*! + \qmltype Entity + \inherits Node + \inqmlmodule Qt3D + \since 5.5 +*/ + Quick3DEntity::Quick3DEntity(QObject *parent) : QObject(parent) { } +/*! + \qmlproperty list<Component3D> Qt3D::Entity::components + \readonly +*/ QQmlListProperty<QComponent> Quick3DEntity::componentList() { return QQmlListProperty<Qt3D::QComponent>(this, 0, diff --git a/src/quick3d/quick3d/items/quick3dentityloader.cpp b/src/quick3d/quick3d/items/quick3dentityloader.cpp index f15ad8d18..66c892d4a 100644 --- a/src/quick3d/quick3d/items/quick3dentityloader.cpp +++ b/src/quick3d/quick3d/items/quick3dentityloader.cpp @@ -75,17 +75,29 @@ private: Quick3DEntityLoader *m_loader; }; +/*! + \qmltype EntityLoader + \inqmlmodule Qt3D + \since 5.5 +*/ Quick3DEntityLoader::Quick3DEntityLoader(QNode *parent) : QEntity(*new Quick3DEntityLoaderPrivate(this), parent) { } +/*! + \qmlproperty QtQml::QtObject Qt3D::EntityLoader::entity + \readonly +*/ QObject *Quick3DEntityLoader::entity() const { Q_D(const Quick3DEntityLoader); return d->m_entity; } +/*! + \qmlproperty url Qt3D::EntityLoader::source +*/ QUrl Quick3DEntityLoader::source() const { Q_D(const Quick3DEntityLoader); @@ -114,6 +126,10 @@ void Quick3DEntityLoader::copy(const QNode *ref) d_func()->m_entity->setParent(this); } +/*! + \class Qt3D::Quick::Quick3DEntityLoaderPrivate + \internal +*/ Quick3DEntityLoaderPrivate::Quick3DEntityLoaderPrivate(Quick3DEntityLoader *qq) : QEntityPrivate(qq), m_incubator(Q_NULLPTR), diff --git a/src/quick3d/quick3d/items/quick3dnode.cpp b/src/quick3d/quick3d/items/quick3dnode.cpp index 44e41c2f7..3a93e0211 100644 --- a/src/quick3d/quick3d/items/quick3dnode.cpp +++ b/src/quick3d/quick3d/items/quick3dnode.cpp @@ -43,11 +43,25 @@ namespace Qt3D { namespace Quick { +/*! + \qmltype Node + \inqmlmodule Qt3D + \since 5.5 + + \brief A base QML type that other types inherit. It cannot be directly + created. +*/ + Quick3DNode::Quick3DNode(QObject *parent) : QObject(parent) { } +/*! + \qmlproperty list<QtQml::QtObject> Qt3D::Node::data + \default +*/ + QQmlListProperty<QObject> Quick3DNode::data() { return QQmlListProperty<QObject>(this, 0, @@ -57,6 +71,11 @@ QQmlListProperty<QObject> Quick3DNode::data() Quick3DNode::clearData); } +/*! + \qmlproperty list<Node> Qt3D::Node::childNodes + \readonly +*/ + QQmlListProperty<QNode> Quick3DNode::childNodes() { return QQmlListProperty<QNode>(this, 0, diff --git a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp index 4684bd212..0d34159d4 100644 --- a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp +++ b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp @@ -50,6 +50,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { namespace Quick { +/*! + \class Qt3D::Quick::Quick3DNodeInstantiatorPrivate + \internal +*/ Quick3DNodeInstantiatorPrivate::Quick3DNodeInstantiatorPrivate(QNode *qq) : QNodePrivate(qq) , m_componentComplete(true) @@ -192,12 +196,12 @@ void Quick3DNodeInstantiatorPrivate::makeModel() /*! \qmltype NodeInstantiator \instantiates Quick3DNodeInstantiator - \inqmlmodule Quick3D - \brief Dynamically creates nodes + \inqmlmodule Qt3D + \brief Dynamically creates nodes. \since 5.5 - A NodeInstantiator can be used to control the dynamic creation of nodes, or to dynamically - create multiple objects from a template. + A NodeInstantiator can be used to control the dynamic creation of nodes, + or to dynamically create multiple objects from a template. The NodeInstantiator element will manage the objects it creates. Those objects are parented to the Instantiator and can also be deleted by the @@ -217,7 +221,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator() } /*! - \qmlsignal Quick3D::NodeInstantiator::objectAdded(int index, QtObject node) + \qmlsignal Qt3D::NodeInstantiator::objectAdded(int index, QtObject node) This signal is emitted when a node is added to the NodeInstantiator. The \a index parameter holds the index which the node has been given, and the \a node @@ -227,7 +231,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator() */ /*! - \qmlsignal Quick3D::NodeInstantiator::objectRemoved(int index, QtObject object) + \qmlsignal Qt3D::NodeInstantiator::objectRemoved(int index, QtObject object) This signal is emitted when an object is removed from the Instantiator. The \a index parameter holds the index which the object had been given, and the \a object @@ -239,13 +243,13 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator() The corresponding handler is \c onObjectRemoved. */ /*! - \qmlproperty bool Quick3D::NodeInstantiator::active + \qmlproperty bool Qt3D::NodeInstantiator::active - When active is true, and the delegate component is ready, the Instantiator will - create objects according to the model. When active is false, no objects + When active is \c true, and the delegate component is ready, the Instantiator will + create objects according to the model. When active is \c false, no objects will be created and any previously created objects will be destroyed. - Default is true. + Default is \c true. */ bool Quick3DNodeInstantiator::isActive() const { @@ -264,7 +268,7 @@ void Quick3DNodeInstantiator::setActive(bool newVal) } /*! - \qmlproperty bool Quick3D::NodeInstantiator::asynchronous + \qmlproperty bool Qt3D::NodeInstantiator::asynchronous When asynchronous is true the Instantiator will attempt to create objects asynchronously. This means that objects may not be available immediately, @@ -291,7 +295,8 @@ void Quick3DNodeInstantiator::setAsync(bool newVal) /*! - \qmlproperty int Quick3D::NodeInstantiator::count + \qmlproperty int Qt3D::NodeInstantiator::count + \readonly The number of objects the Instantiator is currently managing. */ @@ -303,7 +308,7 @@ int Quick3DNodeInstantiator::count() const } /*! - \qmlproperty QtQml::Component Quick3D::NodeInstantiator::delegate + \qmlproperty QtQml::Component Qt3D::NodeInstantiator::delegate \default The component used to create all objects. @@ -340,13 +345,13 @@ void Quick3DNodeInstantiator::setDelegate(QQmlComponent *c) } /*! - \qmlproperty variant Quick3D::NodeInstantiator::model + \qmlproperty variant Qt3D::NodeInstantiator::model This property can be set to any of the supported \l {qml-data-models}{data models}: \list \li A number that indicates the number of delegates to be created by the repeater - \li A model (e.g. a ListModel item, or a QAbstractItemModel subclass) + \li A model (for example, a ListModel item or a QAbstractItemModel subclass) \li A string list \li An object list \endlist @@ -415,7 +420,8 @@ void Quick3DNodeInstantiator::setModel(const QVariant &v) } /*! - \qmlproperty QtQml::QtObject Quick3D::NodeInstantiator::object + \qmlproperty QtQml::QtObject Qt3D::NodeInstantiator::object + \readonly This is a reference to the first created object, intended as a convenience for the case where only one object has been created. @@ -429,7 +435,7 @@ QObject *Quick3DNodeInstantiator::object() const } /*! - \qmlmethod QtQml::QtObject Quick3D::NodeInstantiator::objectAt + \qmlmethod QtQml::QtObject Qt3D::NodeInstantiator::objectAt(int index) Returns a reference to the object with the given \a index. */ diff --git a/src/quick3d/quick3d/items/quick3dtransform.cpp b/src/quick3d/quick3d/items/quick3dtransform.cpp index b236b1dd7..56556d491 100644 --- a/src/quick3d/quick3d/items/quick3dtransform.cpp +++ b/src/quick3d/quick3d/items/quick3dtransform.cpp @@ -43,6 +43,11 @@ namespace Qt3D { namespace Quick { +/*! + \qmltype Transform + \inqmlmodule Qt3D + \since 5.5 +*/ Quick3DTransform::Quick3DTransform(QObject *parent) : QObject(parent) { @@ -50,6 +55,15 @@ Quick3DTransform::Quick3DTransform(QObject *parent) QObject::connect(parent, SIGNAL(transformsChanged()), this, SIGNAL(transformsChanged())); } +/*! + \qmlproperty matrix4x4 Qt3D::Transform::matrix + \readonly +*/ + +/*! + \qmlproperty list<QAbstractTransform> Qt3D::Transform::transforms + \default +*/ QQmlListProperty<QAbstractTransform> Quick3DTransform::transformList() { return QQmlListProperty<QAbstractTransform>(this, 0, |