Note: This property will automatically be set to true if the Controller system has valid facial * blend shape actions.
* @property {boolean} hasProceduralBlinkFaceMovement=true -true if avatars blink automatically by animating
- * facial blend shapes, false if automatic blinking is disabled. Set this property to false if
- * you wish to fully control the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
+ * the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
* adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
- * to true to prevent the iris from being obscured by the upper or lower lids. Set this property to
- * false if you wish to fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
+ * fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
* automatically based on detected microphone input, false if this automatic movement is disabled. Set
- * this property to false if you wish to fully control the mouth facial blend shapes via the
+ * this property to false to fully control the mouth facial blend shapes via the
* {@link MyAvatar.setBlendshape} method.
*
* @example Note: This property will automatically be set to true if the controller system has
* valid facial blend shape actions.
true if avatars blink automatically by animating
- * facial blend shapes, false if automatic blinking is disabled. Set this property to false
- * to fully control the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
+ * the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
* adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
- * to true to prevent the iris from being obscured by the upper or lower lids. Set this property to
- * false to fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
+ * fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
* automatically based on detected microphone input, false if this automatic movement is disabled. Set
* this property to false to fully control the mouth facial blend shapes via the
@@ -654,7 +654,7 @@ public:
* Note: When using pre-built animation data, it's critical that the joint orientation of the source animation and target * rig are equivalent, since the animation data applies absolute values onto the joints. If the orientations are different, * the avatar will move in unpredictable ways. For more information about avatar joint orientation standards, see - * Avatar Standards.
+ * Avatar Standards. * @function MyAvatar.overrideAnimation * @param {string} url - The URL to the animation file. Animation files may be in glTF or FBX format, but only need to * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs @@ -665,7 +665,7 @@ public: * @param {number} firstFrame - The frame to start the animation at. * @param {number} lastFrame - The frame to end the animation at. * @exampletrue to set the orientation of the avatar.
@@ -2076,14 +2077,14 @@ public slots:
bool hasOrientation = false, const glm::quat& newOrientation = glm::quat(),
bool shouldFaceLocation = false, bool withSafeLanding = true);
/**jsdoc
- * Moves the avatar to a new position and (optional) orientation in the domain.
+ * Moves the avatar to a new position and (optional) orientation in the domain, with safe landing.
* @function MyAvatar.goToLocation
* @param {MyAvatar.GoToProperties} target - The goto target.
*/
void goToLocation(const QVariant& properties);
/**jsdoc
- * Moves the avatar to a new position and then enables collisions.
+ * Moves the avatar to a new position, with safe landing, and enables collisions.
* @function MyAvatar.goToLocationAndEnableCollisions
* @param {Vec3} position - The new position for the avatar, in world coordinates.
*/
diff --git a/interface/src/ui/InteractiveWindow.cpp b/interface/src/ui/InteractiveWindow.cpp
index 2acac2c529..0ac1f05737 100644
--- a/interface/src/ui/InteractiveWindow.cpp
+++ b/interface/src/ui/InteractiveWindow.cpp
@@ -145,7 +145,7 @@ void InteractiveWindow::emitMainWindowResizeEvent() {
* @property {InteractiveWindow.Flags} [additionalFlags=0] - Customizes window behavior.
* @property {InteractiveWindow.OverrideFlags} [overrideFlags=0] - Customizes window controls.
- * @property {InteractiveWindow.RelativePositionAnchor} [relativePositionAnchor] - he anchor for the
+ * @property {InteractiveWindow.RelativePositionAnchor} [relativePositionAnchor] - The anchor for the
* relativePosition, if used.
* @property {Vec2} [relativePosition] - The position of the window, relative to the relativePositionAnchor, in
* pixels. Excludes the window frame.
diff --git a/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp b/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp
index a9e16e9ff1..3792057052 100644
--- a/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp
+++ b/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp
@@ -1925,7 +1925,7 @@ void Avatar::setParentJointIndex(quint16 parentJointIndex) {
* @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).
+ * @property {number} parentIndex - Index of this joint's parent (-1 if no parent).
*/
QListCreated using {@link MyAvatar.getTargetAvatar} or {@link AvatarList.getAvatar}.
+ *Create using {@link MyAvatar.getTargetAvatar} or {@link AvatarList.getAvatar}.
* * @class ScriptAvatar * @hideconstructor @@ -87,7 +87,7 @@ public slots: /**jsdoc * Gets the default rotation of a joint in the avatar relative to its parent. *For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @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 @@ -99,7 +99,7 @@ public slots: * Gets the default translation of a joint in the avatar relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @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 @@ -152,7 +152,7 @@ public slots: /**jsdoc - * Gets the ID of the entity of avatar that the avatar is parented to. + * Gets the ID of the entity or 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. diff --git a/libraries/avatars/src/AvatarData.h b/libraries/avatars/src/AvatarData.h index f5e72b2dfe..d6a4497ee7 100755 --- a/libraries/avatars/src/AvatarData.h +++ b/libraries/avatars/src/AvatarData.h @@ -538,12 +538,12 @@ class AvatarData : public QObject, public SpatiallyNestable { *Note: This property will automatically be set to true if the controller system has
* valid facial blend shape actions.
true if avatars blink automatically by animating
- * facial blend shapes, false if automatic blinking is disabled. Set this property to false
- * to fully control the blink facial blend shapes via the {@link Avatar.setBlendshape} method.
+ * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
+ * the blink facial blend shapes via the {@link Avatar.setBlendshape} method.
* @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
* adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
- * to true to prevent the iris from being obscured by the upper or lower lids. Set this property to
- * false to fully control the eye blend shapes via the {@link Avatar.setBlendshape} method.
+ * to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
+ * fully control the eye blend shapes via the {@link Avatar.setBlendshape} method.
* @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
* automatically based on detected microphone input, false if this automatic movement is disabled. Set
* this property to false to fully control the mouth facial blend shapes via the
@@ -1274,7 +1274,7 @@ public:
* null to remove all attachments.
* @deprecated This function is deprecated and will be removed. Use avatar entities instead.
* @example skeletonModelURL property value) is changed.
+ * Triggered when the avatar's model (i.e., skeletonModelURL property value) changes.
* @function Avatar.skeletonModelURLChanged
* @returns {Signal}
* @example Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function ScriptAvatar.getJointTranslation * @param {number} index - The index of the joint. * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates, or {@link Vec3(0)|Vec3.ZERO} @@ -139,7 +139,7 @@ public: /**jsdoc * Gets the rotation of a joint relative to its parent. For information on the joint hierarchy used, see - * Avatar Standards. + * Avatar Standards. * @function ScriptAvatar.getJointRotation * @param {string} name - The name of the joint. * @returns {Quat} The rotation of the joint relative to its parent, or {@link Quat(0)|Quat.IDENTITY} if the avatar data @@ -151,7 +151,7 @@ public: * Gets the translation of a joint relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function ScriptAvatar.getJointTranslation * @param {number} name - The name of the joint. * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates, or {@link Vec3(0)|Vec3.ZERO} @@ -248,7 +248,7 @@ signals: void sessionDisplayNameChanged(); /**jsdoc - * Triggered when the avatar's model (i.e.,skeletonModelURL property value) is changed.
+ * Triggered when the avatar's model (i.e., skeletonModelURL property value) changes.
* @function ScriptAvatar.skeletonModelURLChanged
* @returns {Signal}
*/
diff --git a/libraries/entities/src/EntityItemProperties.cpp b/libraries/entities/src/EntityItemProperties.cpp
index 09a8021a43..c81cd2a70a 100644
--- a/libraries/entities/src/EntityItemProperties.cpp
+++ b/libraries/entities/src/EntityItemProperties.cpp
@@ -1036,8 +1036,8 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* type: "Model",
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0.75, z: -2 })),
* rotation: MyAvatar.orientation,
- * modelURL: "http://content.highfidelity.com/seefo/production/puck-attach/vive_tracker_puck.obj",
- * dimensions: { x: 0.0945, y: 0.0921, z: 0.0423 },
+ * modelURL: "https://apidocs.vircadia.dev/models/cowboy-hat.fbx",
+ * dimensions: { x: 0.8569, y: 0.3960, z: 1.0744 },
* lifetime: 300 // Delete after 5 minutes.
* });
*/
diff --git a/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.cpp b/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.cpp
index 9d36cfd91a..a27eff9cbe 100644
--- a/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.cpp
+++ b/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.cpp
@@ -434,7 +434,7 @@ namespace scriptable {
* @property {string} [glossMap] - The URL of the gloss texture image.
* Only use one of roughnessMap and glossMap.
* "hifi_pbr" model only.
- * @property {string} [normalMa]p - The URL of the normal texture image.
+ * @property {string} [normalMap] - The URL of the normal texture image.
* If "fallthrough" then it and bumpMap fall through to the material below.
* Only use one of normalMap and bumpMap.
* "hifi_pbr" model only.
diff --git a/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.h b/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.h
index 9b56433bf6..0f24ae8461 100644
--- a/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.h
+++ b/libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.h
@@ -87,8 +87,8 @@ public slots:
* type: "Model",
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(Camera.orientation, { x: -0.5, y: 0, z: -3 })),
* rotation: MyAvatar.orientation,
- * modelURL: "http://content.highfidelity.com/seefo/production/puck-attach/vive_tracker_puck.obj",
- * dimensions: { x: 0.945, y: 0.921, z: 0.423 },
+ * modelURL: "https://apidocs.vircadia.dev/models/cowboy-hat.fbx",
+ * dimensions: { x: 0.8569, y: 0.3960, z: 1.0744 },
* lifetime: 300 // Delete after 5 minutes.
* });
* var shapeEntityID = Entities.addEntity({
diff --git a/libraries/graphics-scripting/src/graphics-scripting/ScriptableMesh.h b/libraries/graphics-scripting/src/graphics-scripting/ScriptableMesh.h
index 8d70eda9e4..0e7eecc03b 100644
--- a/libraries/graphics-scripting/src/graphics-scripting/ScriptableMesh.h
+++ b/libraries/graphics-scripting/src/graphics-scripting/ScriptableMesh.h
@@ -31,7 +31,7 @@ namespace scriptable {
/**jsdoc
* A handle to in-memory mesh data in a {@link GraphicsModel}.
*
- * Created using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, or {@link GraphicsMesh.cloneMesh}.
+ *Create using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, or {@link GraphicsMesh.cloneMesh}.
* * @class GraphicsMesh * @hideconstructor @@ -133,7 +133,7 @@ namespace scriptable { QVectorCreated using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, {@link GraphicsMesh.cloneMesh}, or + *
Create using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, {@link GraphicsMesh.cloneMesh}, or * {@link GraphicsMeshPart.cloneMeshPart}.
* * @class GraphicsMeshPart diff --git a/libraries/graphics-scripting/src/graphics-scripting/ScriptableModel.h b/libraries/graphics-scripting/src/graphics-scripting/ScriptableModel.h index 6dc2a06747..a6f135c321 100644 --- a/libraries/graphics-scripting/src/graphics-scripting/ScriptableModel.h +++ b/libraries/graphics-scripting/src/graphics-scripting/ScriptableModel.h @@ -22,7 +22,7 @@ namespace scriptable { *Note: The model may be used for more than one instance of an item displayed in the scene. Modifying the model updates * all instances displayed.
* - *Created using the {@link Graphics} API or {@link GraphicsModel.cloneModel}.
+ *Create using the {@link Graphics} API or {@link GraphicsModel.cloneModel}.
* * @class GraphicsModel * @hideconstructor @@ -34,7 +34,7 @@ namespace scriptable { * @property {Uuid} objectID - The ID of the entity or avatar that the model is associated with, if any;null
* if the model is not associated with an entity or avatar.
* Read-only.
- * @property {number} numMeshes - The number of meshes contained in the model.
+ * @property {number} numMeshes - The number of meshes in the model.
* Read-only.
* @property {GraphicsMesh[]} meshes - The meshes in the model. Each mesh may have more than one mesh part.
* Read-only.
diff --git a/libraries/graphics/src/graphics/BufferViewHelpers.cpp b/libraries/graphics/src/graphics/BufferViewHelpers.cpp
index 076cb92dcf..87d19ec6a2 100644
--- a/libraries/graphics/src/graphics/BufferViewHelpers.cpp
+++ b/libraries/graphics/src/graphics/BufferViewHelpers.cpp
@@ -76,7 +76,7 @@ const std::array"texcoord4"