////  ScriptableAvatar.h//  assignment-client/src/avatars////  Created by Clement on 7/22/14.//  Copyright 2014 High Fidelity, Inc.//  Copyright 2023 Overte e.V.////  Distributed under the Apache License, Version 2.0.//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html//  SPDX-License-Identifier: Apache-2.0// #ifndef hifi_ScriptableAvatar_h#define hifi_ScriptableAvatar_h #include <AnimationCache.h>#include <AnimSkeleton.h>#include <AvatarData.h>#include <ScriptEngine.h>#include <EntityItem.h>#include "model-networking/ModelCache.h"#include "Rig.h"#include <HelperScriptEngine.h> /*@jsdoc * The <code>Avatar</code> API is used to manipulate scriptable avatars on the domain. This API is a subset of the  * {@link MyAvatar} API. To enable this API, set {@link Agent|Agent.isAvatar} to <code>true</code>. * * <p>For Interface, client entity, and avatar scripts, see {@link MyAvatar}.</p> * * @namespace Avatar * * @hifi-assignment-client * * @comment IMPORTANT: This group of properties is copied from AvatarData.h; they should NOT be edited here. * @property {Vec3} position - The position of the avatar. * @property {number} scale=1.0 - The scale of the avatar. The value can be set to anything between <code>0.005</code> and  *     <code>1000.0</code>. When the scale value is fetched, it may temporarily be further limited by the domain's settings. * @property {number} density - The density of the avatar in kg/m<sup>3</sup>. The density is used to work out its mass in *     the application of physics. <em>Read-only.</em> * @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} bodyYaw - The left or right rotation about an axis running from the head to the feet of the avatar. *     Yaw is sometimes called "heading". * @property {number} bodyPitch - The rotation about an axis running from shoulder to shoulder of the avatar. Pitch is *     sometimes called "elevation". * @property {number} bodyRoll - The rotation about an axis running from the chest to the back of the avatar. Roll is *     sometimes called "bank". * @property {Quat} orientation - The orientation of the avatar. * @property {Quat} headOrientation - The orientation of the avatar's head. * @property {number} headPitch - The rotation about an axis running from ear to ear of the avatar's head. Pitch is *     sometimes called "elevation". * @property {number} headYaw - The rotation left or right about an axis running from the base to the crown of the avatar's *     head. Yaw is sometimes called "heading". * @property {number} headRoll - The rotation about an axis running from the nose to the back of the avatar's head. Roll is *     sometimes called "bank". * @property {Vec3} velocity - The current velocity of the avatar. * @property {Vec3} angularVelocity - The current angular velocity of the avatar. * @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 {string} displayName - The avatar's display name. * @property {string} sessionDisplayName - <code>displayName's</code> sanitized and default version defined by the avatar mixer  *     rather than Interface clients. The result is unique among all avatars present in the domain at the time. * @property {boolean} lookAtSnappingEnabled=true - <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 {string[]} jointNames - The list of joints in the current avatar model. <em>Read-only.</em> * @property {Uuid} sessionUUID - Unique ID of the avatar in the domain. <em>Read-only.</em> * @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. <em>Read-only.</em> * @property {Mat4} controllerLeftHandMatrix - The rotation and translation of the left hand controller relative to the *     avatar. <em>Read-only.</em> * @property {Mat4} controllerRightHandMatrix - The rotation and translation of the right hand controller relative to the *     avatar. <em>Read-only.</em> * @property {number} sensorToWorldScale - The scale that transforms dimensions in the user's real world to the avatar's *     size in the virtual world. <em>Read-only.</em> * @property {boolean} hasPriority - <code>true</code> if the avatar is in a "hero" zone, <code>false</code> if it isn't. *     <em>Read-only.</em> * @property {boolean} hasScriptedBlendshapes=false - <code>true</code> if blend shapes are controlled by scripted actions,  *     otherwise <code>false</code>. Set this to <code>true</code> before using the {@link MyAvatar.setBlendshape} method,  *     and set back to <code>false</code> after you no longer want scripted control over the blend shapes. *     <p><strong>Note:</strong> This property will automatically be set to true if the Controller system has valid facial  *     blend shape actions.</p> * @property {boolean} hasProceduralBlinkFaceMovement=true - <code>true</code> if avatars blink automatically by animating  *     facial blend shapes, <code>false</code> if automatic blinking is disabled. Set to <code>false</code> to fully control  *     the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method. * @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blend shapes for an avatar's eyes  *     adjust automatically as the eyes move, <code>false</code> if this automatic movement is disabled. Set this property  *     to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set to <code>false</code> to  *     fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method. * @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blend shapes animate  *     automatically based on detected microphone input, <code>false</code> if this automatic movement is disabled. Set  *     this property to <code>false</code> to fully control the mouth facial blend shapes via the  *     {@link MyAvatar.setBlendshape} method. * * @example <caption>Create a scriptable avatar.</caption> * (function () { *     Agent.setIsAvatar(true); *     print("Position: " + JSON.stringify(Avatar.position));  // 0, 0, 0 * }()); */ class ScriptableAvatar : public AvatarData, public Dependency {    Q_OBJECT     using Clock = std::chrono::system_clock;    using TimePoint = Clock::time_point; public:     ScriptableAvatar();     /*@jsdoc     * Starts playing an animation on the avatar.     * @function Avatar.startAnimation     * @param {string} url - The animation file's URL. Animation files need to 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      *     respectively).     *     <p><strong>Warning:</strong> glTF animations currently do not always animate correctly.</p>     * @param {number} [fps=30] - The frames per second (FPS) rate for the animation playback. 30 FPS is normal speed.     * @param {number} [priority=1] - <em>Not used.</em>     * @param {boolean} [loop=false] - <code>true</code> if the animation should loop, <code>false</code> if it shouldn't.     * @param {boolean} [hold=false] - <em>Not used.</em>     * @param {number} [firstFrame=0] - The frame at which the animation starts.     * @param {number} [lastFrame=3.403e+38] - The frame at which the animation stops.     * @param {string[]} [maskedJoints=[]] - The names of joints that should not be animated.     */    /// Allows scripts to run animations.    Q_INVOKABLE void startAnimation(const QString& url, float fps = 30.0f, float priority = 1.0f, bool loop = false,                                    bool hold = false, float firstFrame = 0.0f, float lastFrame = FLT_MAX,                                     const QStringList& maskedJoints = QStringList());     /*@jsdoc     * Stops playing the current animation.     * @function Avatar.stopAnimation     */    Q_INVOKABLE void stopAnimation();     /*@jsdoc     * Gets the details of the current avatar animation that is being or was recently played.     * @function Avatar.getAnimationDetails     * @returns {Avatar.AnimationDetails} The current or recent avatar animation.     * @example <caption>Report the current animation details.</caption>     * var animationDetails = Avatar.getAnimationDetails();     * print("Animation details: " + JSON.stringify(animationDetails));     */    Q_INVOKABLE AnimationDetails getAnimationDetails();     /*@jsdoc     * @comment Uses the base class's JSDoc.     */    Q_INVOKABLE virtual QStringList getJointNames() const override;     /*@jsdoc     * @comment Uses the base class's JSDoc.     */    /// Returns the index of the joint with the specified name, or -1 if not found/unknown.    Q_INVOKABLE virtual int getJointIndex(const QString& name) const override;     /*@jsdoc     * @comment Uses the base class's JSDoc.     */    Q_INVOKABLE virtual void setSkeletonModelURL(const QUrl& skeletonModelURL) override;     /*@jsdoc     * @comment Uses the base class's JSDoc.     */    int sendAvatarDataPacket(bool sendAll = false) override;     virtual QByteArray toByteArrayStateful(AvatarDataDetail dataDetail, bool dropFaceTracking = false) override;     /*@jsdoc     * Gets details of all avatar entities.     * <p><strong>Warning:</strong> Potentially an expensive call. Do not use if possible.</p>     * @function Avatar.getAvatarEntityData     * @returns {AvatarEntityMap} Details of all avatar entities.     * @example <caption>Report the current avatar entities.</caption>     * var avatarEntityData = Avatar.getAvatarEntityData();     * print("Avatar entities: " + JSON.stringify(avatarEntityData));     */    Q_INVOKABLE AvatarEntityMap getAvatarEntityData() const override;     AvatarEntityMap getAvatarEntityDataNonDefault() const override;     AvatarEntityMap getAvatarEntityDataInternal(bool allProperties) const;     /*@jsdoc     * Sets all avatar entities from an object.     * <p><strong>Warning:</strong> Potentially an expensive call. Do not use if possible.</p>     * @function Avatar.setAvatarEntityData     * @param {AvatarEntityMap} avatarEntityData - Details of the avatar entities.     */    Q_INVOKABLE void setAvatarEntityData(const AvatarEntityMap& avatarEntityData) override;     /*@jsdoc     * @comment Uses the base class's JSDoc.     */    Q_INVOKABLE void updateAvatarEntity(const QUuid& entityID, const QByteArray& entityData) override; public slots:    /*@jsdoc     * @function Avatar.update     * @param {number} deltaTime - Delta time.     * @deprecated This function is deprecated and will be removed.     */    void update(float deltatime);     /*@jsdoc     * @function Avatar.setJointMappingsFromNetworkReply     * @deprecated This function is deprecated and will be removed.     */    void setJointMappingsFromNetworkReply(); private:    AnimationPointer _animation;    AnimationDetails _animationDetails;    QStringList _maskedJoints;    GeometryResource::Pointer _geometryResource;    Rig _rig;    bool _isRigValid{false};    Rig _animationRig;    bool _isAnimationRigValid{false};    std::shared_ptr<AnimSkeleton> _avatarAnimSkeleton;    QHash<QString, int> _fstJointIndices; ///< 1-based, since zero is returned for missing keys    QStringList _fstJointNames; ///< in order of depth-first traversal    QUrl _skeletonModelFilenameURL; // This contains URL from filename field in fst file    mutable HelperScriptEngine _helperScriptEngine;    std::map<QUuid, EntityItemPointer> _entities;     /// Loads the joint indices, names from the FST file (if any)    void updateJointMappings();     quint64 _lastSendAvatarDataTime { 0 };     TimePoint _nextTraitsSendWindow;}; #endif // hifi_ScriptableAvatar_h