mirror of
https://github.com/overte-org/overte.git
synced 2025-08-10 11:42:55 +02:00
Fill in JSDoc for new flow functions
This commit is contained in:
parent
ea84847950
commit
277ef56f49
2 changed files with 41 additions and 7 deletions
|
@ -5443,6 +5443,39 @@ void MyAvatar::useFlow(bool isActive, bool isCollidable, const QVariantMap& phys
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**jsdoc
|
||||||
|
* Flow options currently used in flow simulation.
|
||||||
|
* @typedef {object} MyAvatar.FlowData
|
||||||
|
* @property {boolean} initialized - <code>true</code> if flow has been initialized for the current avatar, <code>false</code>
|
||||||
|
* if it hasn't.
|
||||||
|
* @property {boolean} active - <code>true</code> if flow is enabled, <code>false</code> if it isn't.
|
||||||
|
* @property {boolean} colliding - <code>true</code> if collisions are enabled, <code>false</code> if they aren't.
|
||||||
|
* @property {Object<GroupName, MyAvatar.FlowPhysicsData>} physicsData - The physics configuration for each group of joints
|
||||||
|
* that has been configured.
|
||||||
|
* @property {Object<JointName, MyAvatar.FlowCollisionsData>} collisions - The collisions configuration for each joint that
|
||||||
|
* has collisions configured.
|
||||||
|
* @property {Object<ThreadName, number[]>} threads - The threads hat have been configured, with the name of the first joint as
|
||||||
|
* the <code>ThreadName</code> and an array of the indexes of all the joints in the thread as the value.
|
||||||
|
*/
|
||||||
|
/**jsdoc
|
||||||
|
* A set of physics options currently used in flow simulation.
|
||||||
|
* @typedef {object} MyAvatar.FlowPhysicsData
|
||||||
|
* @property {boolean} active - <code>true</code> to enable flow on the joint, <code>false</code> if it isn't.,
|
||||||
|
* @property {number} radius - The thickness of segments and knots. (Needed for collisions.)
|
||||||
|
* @property {number} gravity - Y-value of the gravity vector.
|
||||||
|
* @property {number} inertia - Rotational inertia multiplier.
|
||||||
|
* @property {number} damping - The amount of damping on joint oscillation.
|
||||||
|
* @property {number} stiffness - How stiff each thread is.
|
||||||
|
* @property {number} delta - Delta time for every integration step.
|
||||||
|
* @property {number[]} jointIndices - The indexes of the joints the options are applied to.
|
||||||
|
*/
|
||||||
|
/**jsdoc
|
||||||
|
* A set of collision options currently used in flow simulation.
|
||||||
|
* @typedef {object} MyAvatar.FlowCollisionsData
|
||||||
|
* @property {number} radius - Collision sphere radius.
|
||||||
|
* @property {number} offset - Offset of the collision sphere from the joint.
|
||||||
|
* @property {number} jointIndex - The index of the joint the options are applied to.
|
||||||
|
*/
|
||||||
QVariantMap MyAvatar::getFlowData() {
|
QVariantMap MyAvatar::getFlowData() {
|
||||||
QVariantMap result;
|
QVariantMap result;
|
||||||
if (QThread::currentThread() != thread()) {
|
if (QThread::currentThread() != thread()) {
|
||||||
|
|
|
@ -1563,16 +1563,17 @@ public:
|
||||||
Q_INVOKABLE void useFlow(bool isActive, bool isCollidable, const QVariantMap& physicsConfig = QVariantMap(), const QVariantMap& collisionsConfig = QVariantMap());
|
Q_INVOKABLE void useFlow(bool isActive, bool isCollidable, const QVariantMap& physicsConfig = QVariantMap(), const QVariantMap& collisionsConfig = QVariantMap());
|
||||||
|
|
||||||
/**jsdoc
|
/**jsdoc
|
||||||
* @function MyAvatar.getFlowData
|
* Gets the current flow configuration.
|
||||||
* @returns {object}
|
* @function MyAvatar.getFlowData
|
||||||
*/
|
* @returns {MyAvatar.FlowData}
|
||||||
|
*/
|
||||||
Q_INVOKABLE QVariantMap getFlowData();
|
Q_INVOKABLE QVariantMap getFlowData();
|
||||||
|
|
||||||
/**jsdoc
|
/**jsdoc
|
||||||
* returns the indices of every colliding flow joint
|
* Gets the indexes of currently colliding flow joints.
|
||||||
* @function MyAvatar.getCollidingFlowJoints
|
* @function MyAvatar.getCollidingFlowJoints
|
||||||
* @returns {int[]}
|
* @returns {number[]} The indexes of currently colliding flow joints.
|
||||||
*/
|
*/
|
||||||
Q_INVOKABLE QVariantList getCollidingFlowJoints();
|
Q_INVOKABLE QVariantList getCollidingFlowJoints();
|
||||||
|
|
||||||
public slots:
|
public slots:
|
||||||
|
|
Loading…
Reference in a new issue