overte-JulianGro/libraries/entities/src/SimpleEntitySimulation.cpp

//
//  SimpleEntitySimulation.cpp
//  libraries/entities/src
//
//  Created by Andrew Meadows on 2014.11.24
//  Copyright 2014 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 "SimpleEntitySimulation.h"

#include <DirtyOctreeElementOperator.h>

#include "EntityItem.h"
#include "EntitiesLogging.h"

const uint64_t MAX_OWNERLESS_PERIOD = 2 * USECS_PER_SECOND;

void SimpleEntitySimulation::clearOwnership(const QUuid& ownerID) {
    QMutexLocker lock(&_mutex);
    SetOfEntities::iterator itemItr = _entitiesWithSimulationOwner.begin();
    while (itemItr != _entitiesWithSimulationOwner.end()) {
        EntityItemPointer entity = *itemItr;
        if (entity->getSimulatorID() == ownerID) {
            // the simulator has abandonded this object --> remove from owned list
            itemItr = _entitiesWithSimulationOwner.erase(itemItr);

            if (entity->getDynamic() && entity->hasLocalVelocity()) {
                // it is still moving dynamically --> add to orphaned list
                _entitiesThatNeedSimulationOwner.insert(entity);
                uint64_t expiry = entity->getLastChangedOnServer() + MAX_OWNERLESS_PERIOD;
                _nextOwnerlessExpiry = glm::min(_nextOwnerlessExpiry, expiry);
            }

            // remove ownership and dirty all the tree elements that contain the it
            entity->clearSimulationOwnership();
            entity->markAsChangedOnServer();
            if (auto element = entity->getElement()) {
                DirtyOctreeElementOperator op(element);
                getEntityTree()->recurseTreeWithOperator(&op);
            }
        } else {
            ++itemItr;
        }
    }
}

void SimpleEntitySimulation::updateEntitiesInternal(uint64_t now) {
    expireStaleOwnerships(now);
    stopOwnerlessEntities(now);
}

void SimpleEntitySimulation::addEntityInternal(EntityItemPointer entity) {
    if (entity->getSimulatorID().isNull()) {
        QMutexLocker lock(&_mutex);
        if (entity->getDynamic()) {
            // we don't allow dynamic objects to move without an owner so nothing to do here
        } else if (entity->isMovingRelativeToParent()) {
            SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
            if (itr != _simpleKinematicEntities.end()) {
                _simpleKinematicEntities.insert(entity);
                entity->setLastSimulated(usecTimestampNow());
            }
        }
    } else {
        QMutexLocker lock(&_mutex);
        _entitiesWithSimulationOwner.insert(entity);
        _nextStaleOwnershipExpiry = glm::min(_nextStaleOwnershipExpiry, entity->getSimulationOwnershipExpiry());

        if (entity->isMovingRelativeToParent()) {
            SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
            if (itr != _simpleKinematicEntities.end()) {
                _simpleKinematicEntities.insert(entity);
                entity->setLastSimulated(usecTimestampNow());
            }
        }
    }
}

void SimpleEntitySimulation::removeEntityInternal(EntityItemPointer entity) {
    EntitySimulation::removeEntityInternal(entity);
    _entitiesWithSimulationOwner.remove(entity);
    _entitiesThatNeedSimulationOwner.remove(entity);
}

void SimpleEntitySimulation::changeEntityInternal(EntityItemPointer entity) {
    uint32_t flags = entity->getDirtyFlags();
    if ((flags & Simulation::DIRTY_SIMULATOR_ID) || (flags & Simulation::DIRTY_VELOCITIES)) {
        if (entity->getSimulatorID().isNull()) {
            QMutexLocker lock(&_mutex);
            _entitiesWithSimulationOwner.remove(entity);

            if (entity->getDynamic()) {
                // we don't allow dynamic objects to move without an owner
                SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
                if (itr != _simpleKinematicEntities.end()) {
                    _simpleKinematicEntities.erase(itr);
                }
            } else if (entity->isMovingRelativeToParent()) {
                SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
                if (itr == _simpleKinematicEntities.end()) {
                    _simpleKinematicEntities.insert(entity);
                    entity->setLastSimulated(usecTimestampNow());
                }
            } else {
                SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
                if (itr != _simpleKinematicEntities.end()) {
                    _simpleKinematicEntities.erase(itr);
                }
            }
        } else {
            QMutexLocker lock(&_mutex);
            _entitiesWithSimulationOwner.insert(entity);
            _nextStaleOwnershipExpiry = glm::min(_nextStaleOwnershipExpiry, entity->getSimulationOwnershipExpiry());
            _entitiesThatNeedSimulationOwner.remove(entity);

            if (entity->isMovingRelativeToParent()) {
                SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
                if (itr == _simpleKinematicEntities.end()) {
                    _simpleKinematicEntities.insert(entity);
                    entity->setLastSimulated(usecTimestampNow());
                }
            } else {
                SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
                if (itr != _simpleKinematicEntities.end()) {
                    _simpleKinematicEntities.erase(itr);
                }
            }
        }
    }
    entity->clearDirtyFlags();
}

void SimpleEntitySimulation::clearEntitiesInternal() {
    QMutexLocker lock(&_mutex);
    _entitiesWithSimulationOwner.clear();
    _entitiesThatNeedSimulationOwner.clear();
}

void SimpleEntitySimulation::sortEntitiesThatMoved() {
    SetOfEntities::iterator itemItr = _entitiesToSort.begin();
    while (itemItr != _entitiesToSort.end()) {
        EntityItemPointer entity = *itemItr;
        entity->updateQueryAACube();
        ++itemItr;
    }
    EntitySimulation::sortEntitiesThatMoved();
}

void SimpleEntitySimulation::expireStaleOwnerships(uint64_t now) {
    if (now > _nextStaleOwnershipExpiry) {
        _nextStaleOwnershipExpiry = (uint64_t)(-1);
        SetOfEntities::iterator itemItr = _entitiesWithSimulationOwner.begin();
        while (itemItr != _entitiesWithSimulationOwner.end()) {
            EntityItemPointer entity = *itemItr;
            uint64_t expiry = entity->getSimulationOwnershipExpiry();
            if (now > expiry) {
                itemItr = _entitiesWithSimulationOwner.erase(itemItr);
                if (entity->getDynamic()) {
                    SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity);
                    if (itr != _simpleKinematicEntities.end()) {
                        _simpleKinematicEntities.erase(itr);
                    }
                }

                // remove ownership and dirty all the tree elements that contain the it
                entity->clearSimulationOwnership();
                entity->markAsChangedOnServer();
                DirtyOctreeElementOperator op(entity->getElement());
                getEntityTree()->recurseTreeWithOperator(&op);
            } else {
                _nextStaleOwnershipExpiry = glm::min(_nextStaleOwnershipExpiry, expiry);
                ++itemItr;
            }
        }
    }
}

void SimpleEntitySimulation::stopOwnerlessEntities(uint64_t now) {
    if (now > _nextOwnerlessExpiry) {
        // search for ownerless objects that have expired
        QMutexLocker lock(&_mutex);
        _nextOwnerlessExpiry = (uint64_t)(-1);
        SetOfEntities::iterator itemItr = _entitiesThatNeedSimulationOwner.begin();
        while (itemItr != _entitiesThatNeedSimulationOwner.end()) {
            EntityItemPointer entity = *itemItr;
            uint64_t expiry = entity->getLastChangedOnServer() + MAX_OWNERLESS_PERIOD;
            if (expiry < now) {
                // no simulators have volunteered ownership --> remove from list
                itemItr = _entitiesThatNeedSimulationOwner.erase(itemItr);

                if (entity->getSimulatorID().isNull() && entity->getDynamic() && entity->hasLocalVelocity()) {
                    // zero the derivatives
                    entity->setVelocity(Vectors::ZERO);
                    entity->setAngularVelocity(Vectors::ZERO);
                    entity->setAcceleration(Vectors::ZERO);

                    // dirty all the tree elements that contain it
                    entity->markAsChangedOnServer();
                    DirtyOctreeElementOperator op(entity->getElement());
                    getEntityTree()->recurseTreeWithOperator(&op);
                }
            } else {
                _nextOwnerlessExpiry = glm::min(_nextOwnerlessExpiry, expiry);
                ++itemItr;
            }
        }
    }
}