summaryrefslogtreecommitdiffstats
path: root/src/core/nodes
diff options
context:
space:
mode:
authorQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2018-11-03 03:02:21 +0100
committerQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2018-11-03 03:02:22 +0100
commita3761a118f07dd3d4bebc3b28fff01b5f91a0016 (patch)
tree31d1eb9c7828f078ae0ef92d72e7cea53aa5d4ec /src/core/nodes
parent07bb9b2cd65b22027fe5105d692a4ee265f59842 (diff)
parent7b401dcd3345d42108eb162ea354f64152c9d0a4 (diff)
Merge remote-tracking branch 'origin/5.12' into dev
Diffstat (limited to 'src/core/nodes')
-rw-r--r--src/core/nodes/qbackendnode.cpp8
-rw-r--r--src/core/nodes/qcomponent.cpp11
-rw-r--r--src/core/nodes/qnode.cpp74
3 files changed, 90 insertions, 3 deletions
diff --git a/src/core/nodes/qbackendnode.cpp b/src/core/nodes/qbackendnode.cpp
index 62ca14b4b..f10bf5769 100644
--- a/src/core/nodes/qbackendnode.cpp
+++ b/src/core/nodes/qbackendnode.cpp
@@ -207,6 +207,11 @@ void QBackendNode::notifyObservers(const QSceneChangePtr &e)
d->notifyObservers(e);
}
+/*!
+ Send the command named \a name with contents \a data,
+ and specify \a replyTo as the command id to which the
+ reply needs to be sent.
+*/
QNodeCommand::CommandId QBackendNode::sendCommand(const QString &name,
const QVariant &data,
QNodeCommand::CommandId replyTo)
@@ -220,6 +225,9 @@ QNodeCommand::CommandId QBackendNode::sendCommand(const QString &name,
return e->commandId();
}
+/*!
+ Send the reply to \a command.
+*/
void QBackendNode::sendReply(const QNodeCommandPtr &command)
{
command->setDeliveryFlags(QSceneChange::Nodes);
diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp
index f4e59e058..e678880e8 100644
--- a/src/core/nodes/qcomponent.cpp
+++ b/src/core/nodes/qcomponent.cpp
@@ -112,6 +112,17 @@ void QComponentPrivate::removeEntity(QEntity *entity)
*/
/*!
+ \fn Qt3DCore::QComponent::addedToEntity(Qt3DCore::QEntity *entity)'
+
+ Indicates that a reference has been added to \a entity.
+*/
+/*!
+ \fn Qt3DCore::QComponent::removedFromEntity(Qt3DCore::QEntity *entity)
+
+ Indicates that a reference has been removed from \a entity.
+
+*/
+/*!
Constructs a new QComponent instance with \a parent as the parent.
\note a QComponent should never be instanced directly,
instance one of the subclasses instead.
diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp
index 9c069f936..83ac49471 100644
--- a/src/core/nodes/qnode.cpp
+++ b/src/core/nodes/qnode.cpp
@@ -713,6 +713,36 @@ void QNodePrivate::nodePtrDeleter(QNode *q)
*/
/*!
+ \fn void Qt3DCore::QNodeCommand::setReplyToCommandId(CommandId id)
+
+ Sets the command \a id to which the message is a reply.
+
+*/
+/*!
+ \fn Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::defaultPropertyTrackingMode() const
+
+ Returns the default property tracking mode which determines whether a
+ QNode should be listening for property updates.
+
+*/
+/*!
+ \fn Qt3DCore::QNode::clearPropertyTracking(const QString &propertyName)
+
+ Clears the tracking property called \a propertyName.
+*/
+/*!
+ \fn Qt3DCore::QNode::PropertyTrackingMode Qt3DCore::QNode::propertyTracking(const QString &propertyName) const
+
+ Returns the tracking mode of \a propertyName.
+*/
+
+/*!
+ \fn Qt3DCore::QNode::setPropertyTracking(const QString &propertyName, Qt3DCore::QNode::PropertyTrackingMode trackMode)
+
+ Sets the property tracking for \a propertyName and \a trackMode.
+*/
+
+/*!
Creates a new QNode instance with parent \a parent.
\note The backend aspects will be notified that a QNode instance is
@@ -955,11 +985,49 @@ QNodeCreatedChangeBasePtr QNode::createNodeCreationChange() const
}
/*!
- * \brief Sends a command messages to the backend node
+ \fn Qt3DCore::QNodeCommand::CommandId Qt3DCore::QNodeCommand::inReplyTo() const
+
+ Returns the id of the original QNodeCommand message that
+ was sent to the backend.
+
+*/
+/*!
+ \fn void Qt3DCore::QNodeCommand::setData(const QVariant &data)
+
+ Sets the data (\a data) in the backend node to perform
+ the operations requested.
+*/
+/*!
+ \fn void Qt3DCore::QNodeCommand::setName(const QString &name)
+
+
+ Sets the data (\a name) in the backend node to perform
+ the operations requested.
+*/
+
+/*!
+ \enum Qt3DCore::QNode::PropertyTrackingMode
+
+ Indicates how a QNode listens for property updates.
+
+ \value TrackFinalValues
+ Tracks final values
+ \value DontTrackValues
+ Does not track values
+ \value TrackAllValues
+ Tracks all values
+*/
+/*!
+ \fn Qt3DCore::QNode::clearPropertyTrackings()
+
+ Erases all values that have been saved by the property tracking.
+*/
+/*!
+ * \brief Sends a command message to the backend node
*
* Creates a QNodeCommand message and dispatches it to the backend node. The
* command is given and a \a name and some \a data which can be used in the
- * backend node to performe various operations.
+ * backend node to perform various operations.
* This returns a CommandId which can be used to identify the initial command
* when receiving a message in reply. If the command message is to be sent in
* reply to another command, \a replyTo contains the id of that command.
@@ -972,7 +1040,7 @@ QNodeCommand::CommandId QNode::sendCommand(const QString &name,
{
Q_D(QNode);
- // Bail out early if we can to avoid operator new
+ // Bail out early, if we can, to avoid operator new
if (d->m_blockNotifications)
return QNodeCommand::CommandId(0);