overte-HifiExperiments/libraries/entities/src/EntityTree.h

//
//  EntityTree.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_EntityTree_h
#define hifi_EntityTree_h

#include <QSet>

#include <Octree.h>
#include "EntityTreeElement.h"


class Model;
class PhysicsEngine;

class NewlyCreatedEntityHook {
public:
    virtual void entityCreated(const EntityItem& newEntity, const SharedNodePointer& senderNode) = 0;
};

class EntityItemFBXService {
public:
    virtual const FBXGeometry* getGeometryForEntity(const EntityItem* entityItem) = 0;
    virtual const Model* getModelForEntityItem(const EntityItem* entityItem) = 0;    
};


class SendEntitiesOperationArgs {
public:
    glm::vec3 root;
    EntityTree* localTree;
    EntityEditPacketSender* packetSender;
};


class EntityTree : public Octree {
    Q_OBJECT
public:
    EntityTree(bool shouldReaverage = false);
    virtual ~EntityTree();

    /// Implements our type specific root element factory
    virtual EntityTreeElement* createNewElement(unsigned char * octalCode = NULL);

    /// Type safe version of getRoot()
    EntityTreeElement* getRoot() { return static_cast<EntityTreeElement*>(_rootElement); }

    virtual void eraseAllOctreeElements(bool createNewRoot = true);

    // These methods will allow the OctreeServer to send your tree inbound edit packets of your
    // own definition. Implement these to allow your octree based server to support editing
    virtual bool getWantSVOfileVersions() const { return true; }
    virtual PacketType expectedDataPacketType() const { return PacketTypeEntityData; }
    virtual bool canProcessVersion(PacketVersion thisVersion) const { return true; } // we support all versions
    virtual bool handlesEditPacketType(PacketType packetType) const;
    virtual int processEditPacketData(PacketType packetType, const unsigned char* packetData, int packetLength,
                    const unsigned char* editData, int maxLength, const SharedNodePointer& senderNode);

    virtual bool rootElementHasData() const { return true; }
    
    // the root at least needs to store the number of entities in the packet/buffer
    virtual int minimumRequiredRootDataBytes() const { return sizeof(uint16_t); }
    virtual bool suppressEmptySubtrees() const { return false; }
    virtual void releaseSceneEncodeData(OctreeElementExtraEncodeData* extraEncodeData) const;
    virtual bool mustIncludeAllChildData() const { return false; }

    virtual bool versionHasSVOfileBreaks(PacketVersion thisVersion) const 
                    { return thisVersion >= VERSION_ENTITIES_HAS_FILE_BREAKS; }
                    
    virtual void update();

    // The newer API...
    EntityItem* getOrCreateEntityItem(const EntityItemID& entityID, const EntityItemProperties& properties);
    void addEntityInternal(EntityItem* entityItem);
    void emitAddingEntity(EntityItem* entityItem);

    EntityItem* addEntity(const EntityItemID& entityID, const EntityItemProperties& properties);
    bool updateEntity(const EntityItemID& entityID, const EntityItemProperties& properties);
    void deleteEntity(const EntityItemID& entityID);
    void deleteEntities(QSet<EntityItemID> entityIDs);
    void removeEntityFromSimulationLists(const EntityItemID& entityID);

    const EntityItem* findClosestEntity(glm::vec3 position, float targetRadius);
    EntityItem* findEntityByID(const QUuid& id);
    EntityItem* findEntityByEntityItemID(const EntityItemID& entityID);

    EntityItemID assignEntityID(const EntityItemID& entityItemID); /// Assigns a known ID for a creator token ID


    /// finds all entities that touch a sphere
    /// \param center the center of the sphere
    /// \param radius the radius of the sphere
    /// \param foundEntities[out] vector of const EntityItem*
    /// \remark Side effect: any initial contents in foundEntities will be lost
    void findEntities(const glm::vec3& center, float radius, QVector<const EntityItem*>& foundEntities);

    /// finds all entities that touch a cube
    /// \param cube the query cube
    /// \param foundEntities[out] vector of non-const EntityItem*
    /// \remark Side effect: any initial contents in entities will be lost
    void findEntities(const AACube& cube, QVector<EntityItem*>& foundEntities);

    void addNewlyCreatedHook(NewlyCreatedEntityHook* hook);
    void removeNewlyCreatedHook(NewlyCreatedEntityHook* hook);

    bool hasAnyDeletedEntities() const { return _recentlyDeletedEntityItemIDs.size() > 0; }
    bool hasEntitiesDeletedSince(quint64 sinceTime);
    bool encodeEntitiesDeletedSince(OCTREE_PACKET_SEQUENCE sequenceNumber, quint64& sinceTime, 
                                    unsigned char* packetData, size_t maxLength, size_t& outputLength);
    void forgetEntitiesDeletedBefore(quint64 sinceTime);

    int processEraseMessage(const QByteArray& dataByteArray, const SharedNodePointer& sourceNode);
    int processEraseMessageDetails(const QByteArray& dataByteArray, const SharedNodePointer& sourceNode);
    void handleAddEntityResponse(const QByteArray& packet);
    
    EntityItemFBXService* getFBXService() const { return _fbxService; }
    void setFBXService(EntityItemFBXService* service) { _fbxService = service; }
    const FBXGeometry* getGeometryForEntity(const EntityItem* entityItem) {
        return _fbxService ? _fbxService->getGeometryForEntity(entityItem) : NULL;
    }
    const Model* getModelForEntityItem(const EntityItem* entityItem) {
        return _fbxService ? _fbxService->getModelForEntityItem(entityItem) : NULL;
    }
    
    EntityTreeElement* getContainingElement(const EntityItemID& entityItemID)  /*const*/;
    void setContainingElement(const EntityItemID& entityItemID, EntityTreeElement* element);
    void resetContainingElement(const EntityItemID& entityItemID, EntityTreeElement* element);
    void debugDumpMap();
    virtual void dumpTree();
    virtual void pruneTree();

    void sendEntities(EntityEditPacketSender* packetSender, EntityTree* localTree, float x, float y, float z);

    void updateEntityState(EntityItem* entity);
    void clearEntityState(EntityItem* entity);

    void entityChanged(EntityItem* entity);
    void addEntityToPhysicsEngine(EntityItem* entity);
    void removeEntityFromPhysicsEngine(EntityItem* entity);

    void trackDeletedEntity(const EntityItemID& entityID);

    QList<EntityItem*>& getMovingEntities() { return _movingEntities; }

    void setPhysicsEngine(PhysicsEngine* engine);
    
signals:
    void deletingEntity(const EntityItemID& entityID);
    void addingEntity(const EntityItemID& entityID);
    void entityScriptChanging(const EntityItemID& entityItemID);
    void changingEntityID(const EntityItemID& oldEntityID, const EntityItemID& newEntityID);

private:

    void updateChangedEntities(quint64 now, QSet<EntityItemID>& entitiesToDelete);
    void updateMovingEntities(quint64 now, QSet<EntityItemID>& entitiesToDelete);
    void updateMortalEntities(quint64 now, QSet<EntityItemID>& entitiesToDelete);

    static bool findNearPointOperation(OctreeElement* element, void* extraData);
    static bool findInSphereOperation(OctreeElement* element, void* extraData);
    static bool findInCubeOperation(OctreeElement* element, void* extraData);
    static bool sendEntitiesOperation(OctreeElement* element, void* extraData);

    void notifyNewlyCreatedEntity(const EntityItem& newEntity, const SharedNodePointer& senderNode);

    QReadWriteLock _newlyCreatedHooksLock;
    QVector<NewlyCreatedEntityHook*> _newlyCreatedHooks;

    QReadWriteLock _recentlyDeletedEntitiesLock;
    QMultiMap<quint64, QUuid> _recentlyDeletedEntityItemIDs;
    EntityItemFBXService* _fbxService;

    QHash<EntityItemID, EntityTreeElement*> _entityToElementMap;

    QList<EntityItem*> _movingEntities; // entities that need to be updated
    QList<EntityItem*> _mortalEntities; // entities that need to be checked for expiry

    QSet<EntityItem*> _changedEntities; // entities that have changed in the last frame

    PhysicsEngine* _physicsEngine;
};

#endif // hifi_EntityTree_h