//
//  ModelEntityItem.cpp
//  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
//

#include "ModelEntityItem.h"

#include <QtCore/QJsonDocument>

#include <glm/gtx/transform.hpp>

#include <ByteCountCoding.h>
#include <GLMHelpers.h>

#include "EntitiesLogging.h"
#include "EntityItemProperties.h"
#include "EntityTree.h"
#include "EntityTreeElement.h"
#include "ResourceCache.h"

const QString ModelEntityItem::DEFAULT_MODEL_URL = QString("");
const QString ModelEntityItem::DEFAULT_COMPOUND_SHAPE_URL = QString("");

EntityItemPointer ModelEntityItem::factory(const EntityItemID& entityID, const EntityItemProperties& properties) {
    EntityItemPointer entity(new ModelEntityItem(entityID), [](EntityItem* ptr) { ptr->deleteLater(); });
    entity->setProperties(properties);
    return entity;
}

ModelEntityItem::ModelEntityItem(const EntityItemID& entityItemID) : EntityItem(entityItemID)
{
    _lastAnimated = usecTimestampNow();
    // set the last animated when interface (re)starts
    _type = EntityTypes::Model;
    _lastKnownCurrentFrame = -1;
    _visuallyReady = false;
}

const QString ModelEntityItem::getTextures() const {
    return resultWithReadLock<QString>([&] {
        return _textures;
    });
}

void ModelEntityItem::setTextures(const QString& textures) {
    withWriteLock([&] {
        _textures = textures;
    });
}

EntityItemProperties ModelEntityItem::getProperties(const EntityPropertyFlags& desiredProperties, bool allowEmptyDesiredProperties) const {
    EntityItemProperties properties = EntityItem::getProperties(desiredProperties, allowEmptyDesiredProperties); // get the properties from our base class

    COPY_ENTITY_PROPERTY_TO_PROPERTIES(shapeType, getShapeType);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(compoundShapeURL, getCompoundShapeURL);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(color, getColor);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(textures, getTextures);

    COPY_ENTITY_PROPERTY_TO_PROPERTIES(modelURL, getModelURL);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(modelScale, getModelScale);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(jointRotationsSet, getJointRotationsSet);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(jointRotations, getJointRotations);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(jointTranslationsSet, getJointTranslationsSet);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(jointTranslations, getJointTranslations);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(relayParentJoints, getRelayParentJoints);
    COPY_ENTITY_PROPERTY_TO_PROPERTIES(groupCulled, getGroupCulled);
    withReadLock([&] {
        _animationProperties.getProperties(properties);
    });
    return properties;
}

bool ModelEntityItem::setProperties(const EntityItemProperties& properties) {
    bool somethingChanged = false;
    somethingChanged = EntityItem::setProperties(properties); // set the properties in our base class

    SET_ENTITY_PROPERTY_FROM_PROPERTIES(shapeType, setShapeType);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(compoundShapeURL, setCompoundShapeURL);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(color, setColor);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(textures, setTextures);

    SET_ENTITY_PROPERTY_FROM_PROPERTIES(modelURL, setModelURL);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(modelScale, setModelScale);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(jointRotationsSet, setJointRotationsSet);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(jointRotations, setJointRotations);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(jointTranslationsSet, setJointTranslationsSet);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(jointTranslations, setJointTranslations);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(relayParentJoints, setRelayParentJoints);
    SET_ENTITY_PROPERTY_FROM_PROPERTIES(groupCulled, setGroupCulled);

    withWriteLock([&] {
        AnimationPropertyGroup animationProperties = _animationProperties;
        animationProperties.setProperties(properties);
        bool somethingChangedInAnimations = applyNewAnimationProperties(animationProperties);
        somethingChanged = somethingChanged || somethingChangedInAnimations;
    });

    if (somethingChanged) {
        bool wantDebug = false;
        if (wantDebug) {
            uint64_t now = usecTimestampNow();
            int elapsed = now - getLastEdited();
            qCDebug(entities) << "ModelEntityItem::setProperties() AFTER update... edited AGO=" << elapsed <<
                    "now=" << now << " getLastEdited()=" << getLastEdited();
        }
        setLastEdited(properties._lastEdited);
    }

    return somethingChanged;
}

int ModelEntityItem::readEntitySubclassDataFromBuffer(const unsigned char* data, int bytesLeftToRead,
                                                ReadBitstreamToTreeParams& args,
                                                EntityPropertyFlags& propertyFlags, bool overwriteLocalData,
                                                bool& somethingChanged) {

    int bytesRead = 0;
    const unsigned char* dataAt = data;
    bool animationPropertiesChanged = false;

    READ_ENTITY_PROPERTY(PROP_SHAPE_TYPE, ShapeType, setShapeType);
    READ_ENTITY_PROPERTY(PROP_COMPOUND_SHAPE_URL, QString, setCompoundShapeURL);
    READ_ENTITY_PROPERTY(PROP_COLOR, glm::u8vec3, setColor);
    READ_ENTITY_PROPERTY(PROP_TEXTURES, QString, setTextures);

    READ_ENTITY_PROPERTY(PROP_MODEL_URL, QString, setModelURL);
    READ_ENTITY_PROPERTY(PROP_MODEL_SCALE, glm::vec3, setModelScale);
    READ_ENTITY_PROPERTY(PROP_JOINT_ROTATIONS_SET, QVector<bool>, setJointRotationsSet);
    READ_ENTITY_PROPERTY(PROP_JOINT_ROTATIONS, QVector<glm::quat>, setJointRotations);
    READ_ENTITY_PROPERTY(PROP_JOINT_TRANSLATIONS_SET, QVector<bool>, setJointTranslationsSet);
    READ_ENTITY_PROPERTY(PROP_JOINT_TRANSLATIONS, QVector<glm::vec3>, setJointTranslations);
    READ_ENTITY_PROPERTY(PROP_RELAY_PARENT_JOINTS, bool, setRelayParentJoints);
    READ_ENTITY_PROPERTY(PROP_GROUP_CULLED, bool, setGroupCulled);

    // grab a local copy of _animationProperties to avoid multiple locks
    int bytesFromAnimation;
    AnimationPropertyGroup animationProperties;
    withReadLock([&] {
        animationProperties = _animationProperties;
        bytesFromAnimation = animationProperties.readEntitySubclassDataFromBuffer(dataAt, (bytesLeftToRead - bytesRead), args,
            propertyFlags, overwriteLocalData, animationPropertiesChanged);
    });
    if (animationPropertiesChanged) {
        withWriteLock([&] {
            applyNewAnimationProperties(animationProperties);
        });
        somethingChanged = true;
    }

    bytesRead += bytesFromAnimation;
    dataAt += bytesFromAnimation;

    return bytesRead;
}

EntityPropertyFlags ModelEntityItem::getEntityProperties(EncodeBitstreamParams& params) const {
    EntityPropertyFlags requestedProperties = EntityItem::getEntityProperties(params);

    requestedProperties += PROP_SHAPE_TYPE;
    requestedProperties += PROP_COMPOUND_SHAPE_URL;
    requestedProperties += PROP_COLOR;
    requestedProperties += PROP_TEXTURES;

    requestedProperties += PROP_MODEL_URL;
    requestedProperties += PROP_MODEL_SCALE;
    requestedProperties += PROP_JOINT_ROTATIONS_SET;
    requestedProperties += PROP_JOINT_ROTATIONS;
    requestedProperties += PROP_JOINT_TRANSLATIONS_SET;
    requestedProperties += PROP_JOINT_TRANSLATIONS;
    requestedProperties += PROP_RELAY_PARENT_JOINTS;
    requestedProperties += PROP_GROUP_CULLED;
    requestedProperties += _animationProperties.getEntityProperties(params);

    return requestedProperties;
}


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

    bool successPropertyFits = true;

    APPEND_ENTITY_PROPERTY(PROP_SHAPE_TYPE, (uint32_t)getShapeType());
    APPEND_ENTITY_PROPERTY(PROP_COMPOUND_SHAPE_URL, getCompoundShapeURL());
    APPEND_ENTITY_PROPERTY(PROP_COLOR, getColor());
    APPEND_ENTITY_PROPERTY(PROP_TEXTURES, getTextures());

    APPEND_ENTITY_PROPERTY(PROP_MODEL_URL, getModelURL());
    APPEND_ENTITY_PROPERTY(PROP_MODEL_SCALE, getModelScale());
    APPEND_ENTITY_PROPERTY(PROP_JOINT_ROTATIONS_SET, getJointRotationsSet());
    APPEND_ENTITY_PROPERTY(PROP_JOINT_ROTATIONS, getJointRotations());
    APPEND_ENTITY_PROPERTY(PROP_JOINT_TRANSLATIONS_SET, getJointTranslationsSet());
    APPEND_ENTITY_PROPERTY(PROP_JOINT_TRANSLATIONS, getJointTranslations());
    APPEND_ENTITY_PROPERTY(PROP_RELAY_PARENT_JOINTS, getRelayParentJoints());
    APPEND_ENTITY_PROPERTY(PROP_GROUP_CULLED, getGroupCulled());

    withReadLock([&] {
        _animationProperties.appendSubclassData(packetData, params, entityTreeElementExtraEncodeData, requestedProperties,
            propertyFlags, propertiesDidntFit, propertyCount, appendState);
    });
}



// added update function back for property fix
void ModelEntityItem::update(const quint64& now) {
    assert(_lastAnimated > 0);

    // increment timestamp before checking "hold"
    auto interval = now - _lastAnimated;
    _lastAnimated = now;

    // grab a local copy of _animationProperties to avoid multiple locks
    auto animationProperties = getAnimationProperties();

    // bail on "hold"
    if (animationProperties.getHold()) {
        return;
    }

    // increment animation frame
    _currentFrame += (animationProperties.getFPS() * ((float)interval) / (float)USECS_PER_SECOND);
    if (_currentFrame > animationProperties.getLastFrame() + 1.0f) {
        if (animationProperties.getLoop()) {
            _currentFrame = animationProperties.computeLoopedFrame(_currentFrame);
        } else {
            _currentFrame = animationProperties.getLastFrame();
        }
    } else if (_currentFrame < animationProperties.getFirstFrame()) {
        if (animationProperties.getFirstFrame() < 0.0f) {
            _currentFrame = 0.0f;
        } else {
            _currentFrame = animationProperties.getFirstFrame();
        }
    }
    setAnimationCurrentFrame(_currentFrame);

    EntityItem::update(now);
}

void ModelEntityItem::debugDump() const {
    qCDebug(entities) << "ModelEntityItem id:" << getEntityItemID();
    qCDebug(entities) << "    edited ago:" << getEditedAgo();
    qCDebug(entities) << "    position:" << getWorldPosition();
    qCDebug(entities) << "    dimensions:" << getScaledDimensions();
    qCDebug(entities) << "    model URL:" << getModelURL();
    qCDebug(entities) << "    compound shape URL:" << getCompoundShapeURL();
}

void ModelEntityItem::setShapeType(ShapeType type) {
    withWriteLock([&] {
        if (type != _shapeType) {
            if (type == SHAPE_TYPE_STATIC_MESH && _dynamic) {
                // dynamic and STATIC_MESH are incompatible
                // since the shape is being set here we clear the dynamic bit
                _dynamic = false;
                _flags |= Simulation::DIRTY_MOTION_TYPE;
            }
            _shapeType = type;
            _flags |= Simulation::DIRTY_SHAPE | Simulation::DIRTY_MASS;
        }
    });
}

ShapeType ModelEntityItem::getShapeType() const {
    return computeTrueShapeType();
}

ShapeType ModelEntityItem::computeTrueShapeType() const {
    ShapeType type = _shapeType;
    if (type == SHAPE_TYPE_STATIC_MESH && _dynamic) {
        // dynamic is incompatible with STATIC_MESH
        // shouldn't fall in here but just in case --> fall back to COMPOUND
        type = SHAPE_TYPE_COMPOUND;
    }
    if (type == SHAPE_TYPE_COMPOUND && !hasCompoundShapeURL()) {
        // no compoundURL set --> fall back to SIMPLE_COMPOUND
        type = SHAPE_TYPE_SIMPLE_COMPOUND;
    }
    return type;
}

void ModelEntityItem::setModelURL(const QString& url) {
    withWriteLock([&] {
        if (_modelURL != url) {
            _modelURL = url;
            if (_shapeType == SHAPE_TYPE_STATIC_MESH) {
                _flags |= Simulation::DIRTY_SHAPE | Simulation::DIRTY_MASS;
            }
        }
    });
}

glm::vec3 ModelEntityItem::getScaledDimensions() const {
    glm::vec3 parentScale =  getTransform().getScale();
    return _unscaledDimensions * parentScale;
}

void ModelEntityItem::setScaledDimensions(const glm::vec3& value) {
    glm::vec3 parentScale = getTransform().getScale();
    setUnscaledDimensions(value / parentScale);
}

const Transform ModelEntityItem::getTransform() const {
    bool success;
    return getTransform(success);
}

const Transform ModelEntityItem::getTransform(bool& success, int depth) const {
    const Transform parentTransform = getParentTransform(success, depth);
    Transform localTransform = getLocalTransform();
    localTransform.postScale(getModelScale());

    Transform worldTransform;
    Transform::mult(worldTransform, parentTransform, localTransform);

    return worldTransform;
}
void ModelEntityItem::setCompoundShapeURL(const QString& url) {
    withWriteLock([&] {
        if (_compoundShapeURL.get() != url) {
            ShapeType oldType = computeTrueShapeType();
            _compoundShapeURL.set(url);
            if (oldType != computeTrueShapeType()) {
                _flags |= Simulation::DIRTY_SHAPE | Simulation::DIRTY_MASS;
            }
        }
    });
}

void ModelEntityItem::setAnimationURL(const QString& url) {
    _flags |= Simulation::DIRTY_UPDATEABLE;
    withWriteLock([&] {
        _animationProperties.setURL(url);
    });
}

void ModelEntityItem::setAnimationSettings(const QString& value) {
    // NOTE: this method only called for old bitstream format

    AnimationPropertyGroup animationProperties;
    withReadLock([&] {
        animationProperties = _animationProperties;
    });

    // the animations setting is a JSON string that may contain various animation settings.
    // if it includes fps, currentFrame, or running, those values will be parsed out and
    // will over ride the regular animation settings
    QJsonDocument settingsAsJson = QJsonDocument::fromJson(value.toUtf8());
    QJsonObject settingsAsJsonObject = settingsAsJson.object();
    QVariantMap settingsMap = settingsAsJsonObject.toVariantMap();
    if (settingsMap.contains("fps")) {
        float fps = settingsMap["fps"].toFloat();
        animationProperties.setFPS(fps);
    }

    // old settings used frameIndex
    if (settingsMap.contains("frameIndex")) {
        float currentFrame = settingsMap["frameIndex"].toFloat();
        animationProperties.setCurrentFrame(currentFrame);
    }

    if (settingsMap.contains("running")) {
        bool running = settingsMap["running"].toBool();
        if (running != animationProperties.getRunning()) {
            animationProperties.setRunning(running);
        }
    }

    if (settingsMap.contains("firstFrame")) {
        float firstFrame = settingsMap["firstFrame"].toFloat();
        animationProperties.setFirstFrame(firstFrame);
    }

    if (settingsMap.contains("lastFrame")) {
        float lastFrame = settingsMap["lastFrame"].toFloat();
        animationProperties.setLastFrame(lastFrame);
    }

    if (settingsMap.contains("loop")) {
        bool loop = settingsMap["loop"].toBool();
        animationProperties.setLoop(loop);
    }

    if (settingsMap.contains("hold")) {
        bool hold = settingsMap["hold"].toBool();
        animationProperties.setHold(hold);
    }

    if (settingsMap.contains("allowTranslation")) {
        bool allowTranslation = settingsMap["allowTranslation"].toBool();
        animationProperties.setAllowTranslation(allowTranslation);
    }

    withWriteLock([&] {
        applyNewAnimationProperties(animationProperties);
    });
}

void ModelEntityItem::setAnimationIsPlaying(bool value) {
    _flags |= Simulation::DIRTY_UPDATEABLE;
    withWriteLock([&] {
        _animationProperties.setRunning(value);
    });
}

void ModelEntityItem::setAnimationFPS(float value) {
    _flags |= Simulation::DIRTY_UPDATEABLE;
    withWriteLock([&] {
        _animationProperties.setFPS(value);
    });
}

// virtual
bool ModelEntityItem::shouldBePhysical() const {
    return !isDead() && getShapeType() != SHAPE_TYPE_NONE && QUrl(_modelURL).isValid();
}

void ModelEntityItem::resizeJointArrays(int newSize) {
    if (newSize < 0) {
        return;
    }

    _jointDataLock.withWriteLock([&] {
        if (newSize > _localJointData.size()) {
            _localJointData.resize(newSize);
        }
    });
}

void ModelEntityItem::setAnimationJointsData(const QVector<EntityJointData>& jointsData) {
    resizeJointArrays(jointsData.size());
    _jointDataLock.withWriteLock([&] {
        for (auto index = 0; index < jointsData.size(); ++index) {
            const auto& newJointData = jointsData[index];
            auto& localJointData = _localJointData[index];
            if (newJointData.translationSet) {
                localJointData.joint.translation = newJointData.translation;
                localJointData.translationDirty = true;
            }
            if (newJointData.rotationSet) {
                localJointData.joint.rotation = newJointData.rotation;
                localJointData.rotationDirty = true;
            }
        }
    });
}

void ModelEntityItem::setJointRotations(const QVector<glm::quat>& rotations) {
    resizeJointArrays(rotations.size());
    _jointDataLock.withWriteLock([&] {
        _jointRotationsExplicitlySet = rotations.size() > 0;
        for (int index = 0; index < rotations.size(); index++) {
            auto& jointData = _localJointData[index];
            if (jointData.joint.rotationSet) {
                jointData.joint.rotation = rotations[index];
                jointData.rotationDirty = true;
            }
        }
    });
}

void ModelEntityItem::setJointRotationsSet(const QVector<bool>& rotationsSet) {
    resizeJointArrays(rotationsSet.size());
    _jointDataLock.withWriteLock([&] {
        _jointRotationsExplicitlySet = rotationsSet.size() > 0;
        for (int index = 0; index < rotationsSet.size(); index++) {
            _localJointData[index].joint.rotationSet = rotationsSet[index];
        }
    });
}

void ModelEntityItem::setJointTranslations(const QVector<glm::vec3>& translations) {
    resizeJointArrays(translations.size());
    _jointDataLock.withWriteLock([&] {
        _jointTranslationsExplicitlySet = translations.size() > 0;
        for (int index = 0; index < translations.size(); index++) {
            auto& jointData = _localJointData[index];
            if (jointData.joint.translationSet) {
                jointData.joint.translation = translations[index];
                jointData.translationDirty = true;
            }
        }
    });
}

void ModelEntityItem::setJointTranslationsSet(const QVector<bool>& translationsSet) {
    resizeJointArrays(translationsSet.size());
    _jointDataLock.withWriteLock([&] {
        _jointTranslationsExplicitlySet = translationsSet.size() > 0;
        for (int index = 0; index < translationsSet.size(); index++) {
            _localJointData[index].joint.translationSet = translationsSet[index];
        }
    });
}

QVector<glm::quat> ModelEntityItem::getJointRotations() const {
    QVector<glm::quat> result;
    _jointDataLock.withReadLock([&] {
        if (_jointRotationsExplicitlySet) {
            result.resize(_localJointData.size());
            for (auto i = 0; i < _localJointData.size(); ++i) {
                result[i] = _localJointData[i].joint.rotation;
            }
        }
    });
    return result;
}

QVector<bool> ModelEntityItem::getJointRotationsSet() const {
    QVector<bool> result;
    _jointDataLock.withReadLock([&] {
        if (_jointRotationsExplicitlySet) {
            result.resize(_localJointData.size());
            for (auto i = 0; i < _localJointData.size(); ++i) {
                result[i] = _localJointData[i].joint.rotationSet;
            }
        }
    });

    return result;
}

QVector<glm::vec3> ModelEntityItem::getJointTranslations() const {
    QVector<glm::vec3> result;
    _jointDataLock.withReadLock([&] {
        if (_jointTranslationsExplicitlySet) {
            result.resize(_localJointData.size());
            for (auto i = 0; i < _localJointData.size(); ++i) {
                result[i] = _localJointData[i].joint.translation;
            }
        }
    });
    return result;
}

QVector<bool> ModelEntityItem::getJointTranslationsSet() const {
    QVector<bool> result;
    _jointDataLock.withReadLock([&] {
        if (_jointTranslationsExplicitlySet) {
            result.resize(_localJointData.size());
            for (auto i = 0; i < _localJointData.size(); ++i) {
                result[i] = _localJointData[i].joint.translationSet;
            }
        }
    });
    return result;
}

bool ModelEntityItem::hasModel() const { 
    return resultWithReadLock<bool>([&] {
        return !_modelURL.isEmpty();
    });
}
bool ModelEntityItem::hasCompoundShapeURL() const {
    return !_compoundShapeURL.get().isEmpty();
}

QString ModelEntityItem::getModelURL() const {
    return resultWithReadLock<QString>([&] {
        return _modelURL;
    });
}

void ModelEntityItem::setRelayParentJoints(bool relayJoints) {
    withWriteLock([&] {
        _relayParentJoints = relayJoints;
    });
}

bool ModelEntityItem::getRelayParentJoints() const {
    return resultWithReadLock<bool>([&] {
        return _relayParentJoints;
    });
}

void ModelEntityItem::setGroupCulled(bool value) {
    withWriteLock([&] {
        _groupCulled = value;
    });
}

bool ModelEntityItem::getGroupCulled() const {
    return resultWithReadLock<bool>([&] {
        return _groupCulled;
    });
}

QString ModelEntityItem::getCompoundShapeURL() const {
    return _compoundShapeURL.get();
}

QString ModelEntityItem::getCollisionShapeURL() const {
    return getShapeType() == SHAPE_TYPE_COMPOUND ? getCompoundShapeURL() : getModelURL();
}

void ModelEntityItem::setColor(const glm::u8vec3& value) {
    withWriteLock([&] {
        _color = value;
    });
}

glm::u8vec3 ModelEntityItem::getColor() const {
    return resultWithReadLock<glm::u8vec3>([&] {
        return _color;
    });
}

// Animation related items...
AnimationPropertyGroup ModelEntityItem::getAnimationProperties() const { 
    return resultWithReadLock<AnimationPropertyGroup>([&] {
        return _animationProperties;
    });
}

bool ModelEntityItem::hasAnimation() const { 
    return resultWithReadLock<bool>([&] { 
        return !_animationProperties.getURL().isEmpty();
    });
}

QString ModelEntityItem::getAnimationURL() const { 
    return resultWithReadLock<QString>([&] {
        return _animationProperties.getURL();
    });
}

void ModelEntityItem::setAnimationCurrentFrame(float value) {
    withWriteLock([&] {
        _animationProperties.setCurrentFrame(value);
    });
}

void ModelEntityItem::setAnimationAllowTranslation(bool value) {
    withWriteLock([&] {
        _animationProperties.setAllowTranslation(value);
    });
}

bool ModelEntityItem::getAnimationAllowTranslation() const {
    return resultWithReadLock<bool>([&] {
        return _animationProperties.getAllowTranslation();
    });
}

void ModelEntityItem::setAnimationLoop(bool loop) { 
    withWriteLock([&] {
        _animationProperties.setLoop(loop);
    });
}

bool ModelEntityItem::getAnimationLoop() const {
    return resultWithReadLock<bool>([&] {
        return _animationProperties.getLoop();
    });
}


void ModelEntityItem::setAnimationHold(bool hold) { 
    withWriteLock([&] {
        _animationProperties.setHold(hold);
    });
}

bool ModelEntityItem::getAnimationHold() const { 
    return resultWithReadLock<bool>([&] {
        return _animationProperties.getHold();
    });
}

bool ModelEntityItem::getAnimationIsPlaying() const { 
    return resultWithReadLock<bool>([&] {
        return _animationProperties.getRunning();
    });
}

float ModelEntityItem::getAnimationCurrentFrame() const { 
    return resultWithReadLock<float>([&] {
        return _animationProperties.getCurrentFrame();
    });
}

float ModelEntityItem::getAnimationFPS() const {
    return resultWithReadLock<float>([&] {
        return _animationProperties.getFPS();
    });
}

bool ModelEntityItem::isAnimatingSomething() const {
    return resultWithReadLock<bool>([&] {
        return _animationProperties.isValidAndRunning();
    });
}

bool ModelEntityItem::applyNewAnimationProperties(AnimationPropertyGroup newProperties) {
    // call applyNewAnimationProperties() whenever trying to update _animationProperties
    // because there is some reset logic we need to do whenever the animation "config" properties change
    // NOTE: this private method is always called inside withWriteLock()

    // if we hit start animation or change the first or last frame then restart the animation
    if ((newProperties.getFirstFrame() != _animationProperties.getFirstFrame()) ||
        (newProperties.getLastFrame() != _animationProperties.getLastFrame()) ||
        (newProperties.getRunning() && !_animationProperties.getRunning())) {

        // when we start interface and the property is are set then the current frame is initialized to -1
        if (_currentFrame < 0.0f) {
            // don't reset _lastAnimated here because we need the timestamp from the ModelEntityItem constructor for when the properties were set
            _currentFrame = newProperties.getCurrentFrame();
            newProperties.setCurrentFrame(_currentFrame);
        } else {
            _lastAnimated =  usecTimestampNow();
            _currentFrame = newProperties.getFirstFrame();
            newProperties.setCurrentFrame(newProperties.getFirstFrame());
        }
    } else if (!newProperties.getRunning() && _animationProperties.getRunning()) {
        _currentFrame = newProperties.getFirstFrame();
        newProperties.setCurrentFrame(_currentFrame);
    } else if (newProperties.getCurrentFrame() != _animationProperties.getCurrentFrame()) {
        // don't reset _lastAnimated here because the currentFrame was set with the previous setting of _lastAnimated
        _currentFrame = newProperties.getCurrentFrame();
    }

    // finally apply the changes
    bool somethingChanged = newProperties != _animationProperties;
    if (somethingChanged) {
        _animationProperties = newProperties;
        _flags |= Simulation::DIRTY_UPDATEABLE;
    }
    return somethingChanged;
}

glm::vec3 ModelEntityItem::getModelScale() const {
    return resultWithReadLock<glm::vec3>([&] {
        return _modelScale;
    });
}

void ModelEntityItem::setModelScale(const glm::vec3& modelScale) {
    withWriteLock([&] {
        _modelScale = modelScale;
    });
}