1000.
+ * @function MyAvatar.increaseSize
+ * @example 0.25.
+ * @function MyAvatar.decreaseSize
+ * @example 1.0.
+ * @function MyAvatar.resetSize
+ */
void resetSize();
+
void animGraphLoaded();
void setGravity(float gravity);
float getGravity();
+ /**jsdoc
+ * Move the avatar to a new position and/or orientation in the domain.
+ * @function MyAvatar.goToLocation
+ * @param {Vec3} position - The new position for the avatar, in world coordinates.
+ * @param {boolean} [hasOrientation=false] - Set to true to set the orientation of the avatar.
+ * @param {Quat} [orientation=Quat.IDENTITY] - The new orientation for the avatar.
+ * @param {boolean} [shouldFaceLocation=false] - Set to true to position the avatar a short distance away from
+ * the new position and orientate the avatar to face the position.
+ */
void goToLocation(const glm::vec3& newPosition,
bool hasOrientation = false, const glm::quat& newOrientation = glm::quat(),
bool shouldFaceLocation = false);
+ /**jsdoc
+ * @function MyAvatar.goToLocation
+ * @param {object} properties
+ */
void goToLocation(const QVariant& properties);
void goToLocationAndEnableCollisions(const glm::vec3& newPosition);
bool safeLanding(const glm::vec3& position);
@@ -630,7 +812,23 @@ public slots:
void setEnableDebugDrawIKChains(bool isEnabled);
void setEnableDebugDrawDetailedCollision(bool isEnabled);
+ /**jsdoc
+ * Get whether or not your avatar mesh is visible.
+ * @function MyAvatar.getEnableMeshVisible
+ * @returns {boolean} true if your avatar's mesh is visible, otherwise false.
+ */
bool getEnableMeshVisible() const { return _skeletonModel->isVisible(); }
+
+ /**jsdoc
+ * Set whether or not your avatar mesh is visible.
+ * @function MyAvatar.setEnableMeshVisible
+ * @param {boolean} visible - true to set your avatar mesh visible; false to set it invisible.
+ * @example { x: 0, y: 0.1, z: 0 }, your avatar will appear to be raised off the ground slightly.
+ * @function MyAvatar.setSkeletonOffset
+ * @param {Vec3} offset - The skeleton offset to set.
+ * @example { x: 0, y: 0.1, z: 0 }, your avatar will appear to be raised off the ground slightly.
+ * @function MyAvatar.getSkeletonOffset
+ * @returns {Vec3} The current skeleton offset.
+ * @example Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
+ * @function MyAvatar.setJointData + * @param {number} index - The index of the joint. + * @param {Quat} rotation - The rotation of the joint relative to its parent. + * @param {Vec3} translation - The translation of the joint relative to its parent. + * @example+ *
+ * Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
+ * @function MyAvatar.setJointRotation + * @param {number} index - The index of the joint. + * @param {Quat} rotation - The rotation of the joint relative to its parent. + */ Q_INVOKABLE virtual void setJointRotation(int index, const glm::quat& rotation); + + /**jsdoc + * Set a specific joint's translation relative to its parent. + *Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
+ * @function MyAvatar.setJointTranslation + * @param {number} index - The index of the joint. + * @param {Vec3} translation - The translation of the joint relative to its parent. + */ Q_INVOKABLE virtual void setJointTranslation(int index, const glm::vec3& translation); + + /**jsdoc + * Clear joint translations and rotations set by script for a specific joint. This restores all motion from the default + * animation system including inverse kinematics for that joint. + *Note: This is slightly faster than the function variation that specifies the joint name.
+ * @function MyAvatar.clearJointData + * @param {number} index - The index of the joint. + */ Q_INVOKABLE virtual void clearJointData(int index); Q_INVOKABLE bool isJointDataValid(int index) const; + + /**jsdoc + * Get the rotation of a joint relative to its parent. For information on the joint hierarchy used, see + * avatar standards. + * @function MyAvatar.getJointRotation + * @param {number} index - The index of the joint. + * @returns {Quat} The rotation of the joint relative to its parent. + */ Q_INVOKABLE virtual glm::quat getJointRotation(int index) const; + + /**jsdoc + * Get the translation of a joint relative to its parent. For information on the joint hierarchy used, see + * avatar standards. + * @function MyAvatar.getJointTranslation + * @param {number} index - The index of the joint. + * @returns {Vec3} The translation of the joint relative to its parent. + */ Q_INVOKABLE virtual glm::vec3 getJointTranslation(int index) const; + /**jsdoc + * Set a specific joint's rotation and position relative to its parent. + *Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
+ * @function MyAvatar.setJointData + * @param {string} name - The name of the joint. + * @param {Quat} rotation - The rotation of the joint relative to its parent. + * @param {Vec3} translation - The translation of the joint relative to its parent. + */ Q_INVOKABLE virtual void setJointData(const QString& name, const glm::quat& rotation, const glm::vec3& translation); + + /**jsdoc + * Set a specific joint's rotation relative to its parent. + *Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
+ * @function MyAvatar.setJointRotation + * @param {string} name - The name of the joint. + * @param {Quat} rotation - The rotation of the joint relative to its parent. + * @example+ *
Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
+ * @function MyAvatar.setJointTranslation + * @param {string} name - The name of the joint. + * @param {Vec3} translation - The translation of the joint relative to its parent. + * @example+ *
Note: This is slightly slower than the function variation that specifies the joint index.
+ * @function MyAvatar.clearJointData + * @param {string} name - The name of the joint. + * @exampleSetting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
+ * @function MyAvatar.setJointRotations + * @param {Quat[]} jointRotations - The rotations for all joints in the avatar. The values are in the same order as the + * array returned by {@link MyAvatar.getJointNames}. + * @example+ *
+ * attachmentData to null.
+ * @function MyAvatar.setAttachmentData
+ * @param {MyAvatar.AttachmentData[]} attachmentData - The attachment data defining the models to have attached to your avatar. Use
+ * null to remove all attachments.
+ * @example Note: Attached models are models only; they are not entities and can not be manipulated using the {@link Entities} API. + * Nor can you use this function to attach an entity (such as a sphere or a box) to your avatar.
+ * @function MyAvatar.attach + * @param {string} modelURL - The URL of the model to attach. Models can be .FBX or .OBJ format. + * @param {string} [jointName=""] - The name of the avatar joint (see {@link MyAvatar.getJointNames}) to attach the model + * to. + * @param {Vec3} [translation=Vec3.ZERO] - The offset to apply to the model relative to the joint position. + * @param {Quat} [rotation=Quat.IDENTITY] - The rotation to apply to the model relative to the joint orientation. + * @param {number} [scale=1.0] - The scale to apply to the model. + * @param {boolean} [isSoft=false] - If the model has a skeleton, set this totrue so that the bones of the
+ * attached model's skeleton are be rotated to fit the avatar's current pose. isSoft is used, for example,
+ * to have clothing that moves with the avatar.+ * If
true, the translation, rotation, and scale parameters are
+ * ignored.
+ * @param {boolean} [allowDuplicates=false]
+ * @param {boolean} [useSaved=true]
+ * @example "", then the most
+ * recently attached model is removed from which ever joint it was attached to.
+ */
Q_INVOKABLE void detachOne(const QString& modelURL, const QString& jointName = QString());
+
+ /**jsdoc
+ * Detach all instances of a particular model from either a specific joint or all joints.
+ * @function MyAvatar.detachAll
+ * @param {string} modelURL - The URL of the model to detach.
+ * @param {string} [jointName=""] - The name of the joint to detach the model from. If "", then the model is
+ * detached from all joints.
+ */
Q_INVOKABLE void detachAll(const QString& modelURL, const QString& jointName = QString());
QString getSkeletonModelURLFromScript() const { return _skeletonModelURL.toString(); }
diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js
index 807e31f098..d49736d7e0 100644
--- a/tools/jsdoc/plugins/hifi.js
+++ b/tools/jsdoc/plugins/hifi.js
@@ -23,6 +23,7 @@ exports.handlers = {
'../../interface/src/raypick',
'../../libraries/animation/src',
'../../libraries/avatars/src',
+ '../../libraries/avatars-renderer/src/avatars-renderer',
'../../libraries/controllers/src/controllers/',
'../../libraries/controllers/src/controllers/impl/',
'../../libraries/display-plugins/src/display-plugins/',