using MyAvatar.getTargetAvatar or AvatarList.getAvatar.

ctrlaltdavid · ctrlaltdavid · commit 00bd81b8c3bb · 2019-12-24T09:52:19.000+13:00
diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h
@@ -1183,7 +1183,7 @@ class MyAvatar : public Avatar {
     /**jsdoc
      * Gets information on the avatar your avatar is currently looking at.
      * @function MyAvatar.getTargetAvatar
-     * @returns {AvatarData} Information on the avatar being looked at.
+     * @returns {ScriptAvatar} Information on the avatar being looked at, <code>null</code> if no avatar is being looked at.
      */
     // FIXME: The return type doesn't have a conversion to a script value so the function always returns undefined in 
     // JavaScript. Note: When fixed, JSDoc is needed for the return type.
diff --git a/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp b/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp
@@ -1920,6 +1920,13 @@ void Avatar::setParentJointIndex(quint16 parentJointIndex) {
     }
 }
 
+/**jsdoc
+ * Information about a joint in an avatar's skeleton hierarchy.
+ * @typedef {object} SkeletonJoint
+ * @property {string} name - Joint name.
+ * @property {number} index - Joint index.
+ * @property {number} parentIndex - Index of this joint's parent (-1 if no parent).
+ */
 QList<QVariant> Avatar::getSkeleton() {
     SkeletonModelPointer skeletonModel = _skeletonModel;
     if (skeletonModel) {
diff --git a/libraries/avatars-renderer/src/avatars-renderer/Avatar.h b/libraries/avatars-renderer/src/avatars-renderer/Avatar.h
@@ -480,14 +480,7 @@ class Avatar : public AvatarData, public scriptable::ModelProvider, public MetaM
     /**jsdoc
      * Gets information on all the joints in the avatar's skeleton.
      * @function MyAvatar.getSkeleton
-     * @returns {MyAvatar.SkeletonJoint[]} Information about each joint in the avatar's skeleton.
-     */
-    /**jsdoc
-     * Information about a single joint in an Avatar's skeleton hierarchy.
-     * @typedef {object} MyAvatar.SkeletonJoint
-     * @property {string} name - Joint name.
-     * @property {number} index - Joint index.
-     * @property {number} parentIndex - Index of this joint's parent (-1 if no parent).
+     * @returns {SkeletonJoint[]} Information about each joint in the avatar's skeleton.
      */
     Q_INVOKABLE QList<QVariant> getSkeleton();
 
diff --git a/libraries/avatars-renderer/src/avatars-renderer/ScriptAvatar.h b/libraries/avatars-renderer/src/avatars-renderer/ScriptAvatar.h
@@ -16,6 +16,64 @@
 
 #include "Avatar.h"
 
+/**jsdoc
+ * Information about an avatar.
+ *
+ * <p>Created using {@link MyAvatar.getTargetAvatar} or {@link AvatarList.getAvatar}.</p>
+ *
+ * @class ScriptAvatar
+ * @hideconstructor
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ * @hifi-assignment-client
+ * @hifi-server-entity
+ *
+ * @property {Vec3} position - The avatar's position.
+ * @property {number} scale - The target scale of the avatar without any restrictions on permissible values imposed by the
+ *     domain.
+ * @property {Vec3} handPosition - A user-defined hand position, in world coordinates. The position moves with the avatar but
+ *    is otherwise not used or changed by Interface.
+ * @property {number} bodyPitch - The pitch of the avatar's body, in degrees.
+ * @property {number} bodyYaw - The yaw of the avatar's body, in degrees.
+ * @property {number} bodyRoll - The roll of the avatar's body, in degrees.
+ * @property {Quat} orientation - The orientation of the avatar's body.
+ * @property {Quat} headOrientation - The orientation of the avatar's head.
+ * @property {number} headPitch - The pitch of the avatar's head relative to the body, in degrees.
+ * @property {number} headYaw - The yaw of the avatar's head relative to the body, in degrees.
+ * @property {number} headRoll - The roll of the avatar's head relative to the body, in degrees.
+ *
+ * @property {Vec3} velocity - The linear velocity of the avatar.
+ * @property {Vec3} angularVelocity - The angular velocity of the avatar.
+ *
+ * @property {Uuid} sessionUUID - The avatar's session ID.
+ * @property {string} displayName - The avatar's display name.
+ * @property {string} sessionDisplayName - The avatar's display name, sanitized and versioned, as defined by the avatar mixer.
+ *     It is unique among all avatars present in the domain at the time.
+ * @property {boolean} isReplicated - <span class="important">Deprecated: This property is deprecated and will be
+ *     removed.</span>
+ * @property {boolean} lookAtSnappingEnabled - <code>true</code> if the avatar's eyes snap to look at another avatar's eyes
+ *     when the other avatar is in the line of sight and also has <code>lookAtSnappingEnabled == true</code>.
+ *
+ * @property {string} skeletonModelURL - The avatar's FST file.
+ * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments.
+ *     <p class="important">Deprecated: This property is deprecated and will be removed. Use avatar entities instead.</p>
+ * @property {string[]} jointNames - The list of joints in the avatar model.
+ *
+ * @property {number} audioLoudness - The instantaneous loudness of the audio input that the avatar is injecting into the
+ *     domain.
+ * @property {number} audioAverageLoudness - The rolling average loudness of the audio input that the avatar is injecting into
+ *     the domain.
+ *
+ * @property {Mat4} sensorToWorldMatrix - The scale, rotation, and translation transform from the user's real world to the
+ *     avatar's size, orientation, and position in the virtual world.
+ * @property {Mat4} controllerLeftHandMatrix - The rotation and translation of the left hand controller relative to the avatar.
+ * @property {Mat4} controllerRightHandMatrix - The rotation and translation of the right hand controller relative to the
+ *     avatar.
+ *
+ * @property {Vec3} skeletonOffset - The rendering offset of the avatar.
+ */
 class ScriptAvatar : public ScriptAvatarData {
     Q_OBJECT
 
@@ -26,27 +84,138 @@ class ScriptAvatar : public ScriptAvatarData {
 
 public slots:
 
+    /**jsdoc
+     * Gets the default rotation of a joint in the avatar relative to its parent.
+     * <p>For information on the joint hierarchy used, see
+     * <a href="https://docs.highfidelity.com/create/avatars/avatar-standards.html">Avatar Standards</a>.</p>
+     * @function ScriptAvatar.getDefaultJointRotation
+     * @param {number} index - The joint index.
+     * @returns {Quat} The default rotation of the joint if avatar data are available and the joint index is valid, otherwise 
+     *     {@link Quat(0)|Quat.IDENTITY}.
+     */
     glm::quat getDefaultJointRotation(int index) const;
+
+    /**jsdoc
+     * Gets the default translation of a joint in the avatar relative to its parent, in model coordinates.
+     * <p><strong>Warning:</strong> These coordinates are not necessarily in meters.</p>
+     * <p>For information on the joint hierarchy used, see
+     * <a href="https://docs.highfidelity.com/create/avatars/avatar-standards.html">Avatar Standards</a>.</p>
+     * @function ScriptAvatar.getDefaultJointTranslation
+     * @param {number} index - The joint index.
+     * @returns {Vec3} The default translation of the joint (in model coordinates) if avatar data are available and the joint 
+     *     index is valid, otherwise {@link Vec3(0)|Vec3.ZERO}.
+     */
     glm::vec3 getDefaultJointTranslation(int index) const;
 
+
+    /**jsdoc
+     * Gets the offset applied to the avatar for rendering.
+     * @function ScriptAvatar.getSkeletonOffset
+     * @returns {Vec3} The skeleton offset if avatar data are available, otherwise {@link Vec3(0)|Vec3.ZERO}.
+     */
     glm::vec3 getSkeletonOffset() const;
 
+
+    /**jsdoc
+     * Gets the position of a joint in the avatar.
+     * @function ScriptAvatar.getJointPosition
+     * @param {number} index - The index of the joint.
+     * @returns {Vec3} The position of the joint in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't 
+     *     available.
+     */
     glm::vec3 getJointPosition(int index) const;
+
+    /**jsdoc
+     * Gets the position of a joint in the current avatar.
+     * @function ScriptAvatar.getJointPosition
+     * @param {string} name - The name of the joint.
+     * @returns {Vec3} The position of the joint in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't
+     *     available.
+     */
     glm::vec3 getJointPosition(const QString& name) const;
+
+    /**jsdoc
+     * Gets the position of the current avatar's neck in world coordinates.
+     * @function ScriptAvatar.getNeckPosition
+     * @returns {Vec3} The position of the neck in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't
+     *     available.
+     */
     glm::vec3 getNeckPosition() const;
 
+
+    /**jsdoc
+     * Gets the current acceleration of the avatar.
+     * @function ScriptAvatar.getAcceleration
+     * @returns {Vec3} The current acceleration of the avatar, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't available..
+     */
     glm::vec3 getAcceleration() const;
 
+
+    /**jsdoc
+     * Gets the ID of the entity of avatar that the avatar is parented to.
+     * @function ScriptAvatar.getParentID
+     * @returns {Uuid} The ID of the entity or avatar that the avatar is parented to. {@link Uuid(0)|Uuid.NULL} if not parented 
+     *     or avatar data aren't available.
+     */
     QUuid getParentID() const;
+
+    /**jsdoc
+     * Gets the joint of the entity or avatar that the avatar is parented to.
+     * @function ScriptAvatar.getParentJointIndex
+     * @returns {number} The joint of the entity or avatar that the avatar is parented to. <code>65535</code> or
+     *     <code>-1</code> if parented to the entity or avatar's position and orientation rather than a joint, or avatar data 
+     *     aren't available.
+     */
     quint16 getParentJointIndex() const;
 
+
+    /**jsdoc
+     * Gets information on all the joints in the avatar's skeleton.
+     * @function ScriptAvatar.getSkeleton
+     * @returns {SkeletonJoint[]} Information about each joint in the avatar's skeleton.
+     */
     QVariantList getSkeleton() const;
 
+
+    /**jsdoc
+     * @function ScriptAvatar.getSimulationRate
+     * @param {AvatarSimulationRate} [rateName=""] - Rate name.
+     * @returns {number} Simulation rate in Hz, or <code>0.0</code> if avatar data aren't available.
+     * @deprecated This function is deprecated and will be removed.
+     */
     float getSimulationRate(const QString& rateName = QString("")) const;
 
+
+    /**jsdoc
+     * Gets the position of the left palm in world coordinates.
+     * @function ScriptAvatar.getLeftPalmPosition
+     * @returns {Vec3} The position of the left palm in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't 
+     *     available.
+     */
     glm::vec3 getLeftPalmPosition() const;
+
+    /**jsdoc
+     * Gets the rotation of the left palm in world coordinates.
+     * @function ScriptAvatar.getLeftPalmRotation
+     * @returns {Quat} The rotation of the left palm in world coordinates, or {@link Quat(0)|Quat.IDENTITY} if the avatar data 
+     *     aren't available.
+     */
     glm::quat getLeftPalmRotation() const;
+
+    /**jsdoc
+     * Gets the position of the right palm in world coordinates.
+     * @function ScriptAvatar.getLeftPalmPosition
+     * @returns {Vec3} The position of the right palm in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't
+     *     available.
+     */
     glm::vec3 getRightPalmPosition() const;
+
+    /**jsdoc
+     * Gets the rotation of the right palm in world coordinates.
+     * @function ScriptAvatar.getLeftPalmRotation
+     * @returns {Quat} The rotation of the right palm in world coordinates, or {@link Quat(0)|Quat.IDENTITY} if the avatar data
+     *     aren't available.
+     */
     glm::quat getRightPalmRotation() const;
 
 private:
diff --git a/libraries/avatars/src/AvatarHashMap.h b/libraries/avatars/src/AvatarHashMap.h
@@ -111,7 +111,7 @@ class AvatarHashMap : public QObject, public Dependency {
      * Gets information about an avatar.
      * @function AvatarList.getAvatar
      * @param {Uuid} avatarID - The ID of the avatar.
-     * @returns {AvatarData} Information about the avatar.
+     * @returns {ScriptAvatar} Information about the avatar.
      */
     // Null/Default-constructed QUuids will return MyAvatar
     Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) { return new ScriptAvatarData(getAvatarBySessionID(avatarID)); }
diff --git a/libraries/avatars/src/ScriptAvatarData.h b/libraries/avatars/src/ScriptAvatarData.h

Original file line number	Diff line number	Diff line change
`@@ -1920,6 +1920,13 @@ void Avatar::setParentJointIndex(quint16 parentJointIndex) {`
`1920`	`1920`	`}`
`1921`	`1921`	`}`
`1922`	`1922`
	`1923`	`+/**jsdoc`
	`1924`	`+ * Information about a joint in an avatar's skeleton hierarchy.`
	`1925`	`+ * @typedef {object} SkeletonJoint`
	`1926`	`+ * @property {string} name - Joint name.`
	`1927`	`+ * @property {number} index - Joint index.`
	`1928`	`+ * @property {number} parentIndex - Index of this joint's parent (-1 if no parent).`
	`1929`	`+ */`
`1923`	`1930`	`QList<QVariant> Avatar::getSkeleton() {`
`1924`	`1931`	`SkeletonModelPointer skeletonModel = _skeletonModel;`
`1925`	`1932`	`if (skeletonModel) {`