overte-JulianGro/libraries/entities/src/ModelEntityItem.h

//
//  ModelEntityItem.h
//  libraries/entities/src
//
//  Created by Brad Hefta-Gaub on 12/4/13.
//  Copyright 2013 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//

#ifndef hifi_ModelEntityItem_h
#define hifi_ModelEntityItem_h

#include "EntityItem.h"
#include <JointData.h>
#include <ThreadSafeValueCache.h>
#include "AnimationPropertyGroup.h"


class ModelEntityItem : public EntityItem {
public:
    static EntityItemPointer factory(const EntityItemID& entityID, const EntityItemProperties& properties);

    ModelEntityItem(const EntityItemID& entityItemID);

    ALLOW_INSTANTIATION // This class can be instantiated

    // methods for getting/setting all properties of an entity
    virtual EntityItemProperties getProperties(EntityPropertyFlags desiredProperties = EntityPropertyFlags()) const override;
    virtual bool setProperties(const EntityItemProperties& properties) override;

    // TODO: eventually only include properties changed since the params.nodeData->getLastTimeBagEmpty() time
    virtual EntityPropertyFlags getEntityProperties(EncodeBitstreamParams& params) const override;

    virtual void appendSubclassData(OctreePacketData* packetData, EncodeBitstreamParams& params,
                                    EntityTreeElementExtraEncodeDataPointer entityTreeElementExtraEncodeData,
                                    EntityPropertyFlags& requestedProperties,
                                    EntityPropertyFlags& propertyFlags,
                                    EntityPropertyFlags& propertiesDidntFit,
                                    int& propertyCount,
                                    OctreeElement::AppendState& appendState) const override;


    virtual int readEntitySubclassDataFromBuffer(const unsigned char* data, int bytesLeftToRead,
                                                ReadBitstreamToTreeParams& args,
                                                EntityPropertyFlags& propertyFlags, bool overwriteLocalData,
                                                bool& somethingChanged) override;

    // update() and needstocallupdate() added back for the entity property fix
    virtual void update(const quint64& now) override;
    virtual bool needsToCallUpdate() const override;
    void updateFrameCount();

    virtual void debugDump() const override;

    void setShapeType(ShapeType type) override;
    virtual ShapeType getShapeType() const override;


    // TODO: Move these to subclasses, or other appropriate abstraction
    // getters/setters applicable to models and particles

    const rgbColor& getColor() const { return _color; }
    xColor getXColor() const;
    bool hasModel() const;
    virtual bool hasCompoundShapeURL() const;

    static const QString DEFAULT_MODEL_URL;
    QString getModelURL() const;

    static const QString DEFAULT_COMPOUND_SHAPE_URL;
    QString getCompoundShapeURL() const;

    void setColor(const rgbColor& value);
    void setColor(const xColor& value);

    // model related properties
    virtual void setModelURL(const QString& url);
    virtual void setCompoundShapeURL(const QString& url);

    // Animation related items...
    AnimationPropertyGroup getAnimationProperties() const;

    bool hasAnimation() const;
    QString getAnimationURL() const;
    void setAnimationURL(const QString& url);

    void setAnimationCurrentFrame(float value);
    void setAnimationIsPlaying(bool value);
    void setAnimationFPS(float value); 

    void setAnimationAllowTranslation(bool value) { _animationProperties.setAllowTranslation(value); };
    bool getAnimationAllowTranslation() const { return _animationProperties.getAllowTranslation(); };

    void setAnimationLoop(bool loop);
    bool getAnimationLoop() const;

    void setAnimationHold(bool hold);
    bool getAnimationHold() const;

    void setAnimationFirstFrame(float firstFrame);
    float getAnimationFirstFrame() const;

    void setAnimationLastFrame(float lastFrame);
    float getAnimationLastFrame() const;

    bool getAnimationIsPlaying() const;
    float getAnimationCurrentFrame() const;
    float getAnimationFPS() const;
    bool isAnimatingSomething() const;

    static const QString DEFAULT_TEXTURES;
    const QString getTextures() const;
    void setTextures(const QString& textures);

    virtual bool shouldBePhysical() const override;

    virtual void setJointRotations(const QVector<glm::quat>& rotations);
    virtual void setJointRotationsSet(const QVector<bool>& rotationsSet);
    virtual void setJointTranslations(const QVector<glm::vec3>& translations);
    virtual void setJointTranslationsSet(const QVector<bool>& translationsSet);

    virtual void setAnimationJointsData(const QVector<JointData>& jointsData);

    QVector<glm::quat> getJointRotations() const;
    QVector<bool> getJointRotationsSet() const;
    QVector<glm::vec3> getJointTranslations() const;
    QVector<bool> getJointTranslationsSet() const;

private:
    void setAnimationSettings(const QString& value); // only called for old bitstream format
    ShapeType computeTrueShapeType() const;

protected:
    void resizeJointArrays(int newSize);

    // these are used:
    // - to bounce joint data from an animation into the model/rig.
    // - to relay changes from scripts to model/rig.
    // - to relay between network and model/rig
    // they aren't currently updated from data in the model/rig, and they don't have a direct effect
    // on what's rendered.
    ReadWriteLockable _jointDataLock;

    bool _jointRotationsExplicitlySet { false }; // were the joints set as a property or just side effect of animations
    bool _jointTranslationsExplicitlySet{ false }; // were the joints set as a property or just side effect of animations

    struct ModelJointData {
        JointData joint;
        bool rotationDirty { false };
        bool translationDirty { false };
    };

    QVector<ModelJointData> _localJointData;
    int _lastKnownCurrentFrame{-1};

    rgbColor _color;
    QString _modelURL;

    ThreadSafeValueCache<QString> _compoundShapeURL;

    AnimationPropertyGroup _animationProperties;

    mutable QReadWriteLock _texturesLock;
    QString _textures;

    ShapeType _shapeType = SHAPE_TYPE_NONE;

private:
    uint64_t _lastAnimated{ 0 };
    AnimationPropertyGroup _previousAnimationProperties;
    float _currentFrame{ -1.0f };
};

#endif // hifi_ModelEntityItem_h