EntityEditFilters.h

//
//  EntityEditFilters.h
//  libraries/entities/src
//
//  Created by David Kelly on 2/7/2017.
//  Copyright 2017 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_EntityEditFilters_h
#define hifi_EntityEditFilters_h
 
#include <QObject>
#include <QMap>
#include <glm/glm.hpp>
 
#include <functional>
 
#include <ScriptValue.h>
 
#include "EntityItemID.h"
#include "EntityItemProperties.h"
#include "EntityTree.h"
 
class ScriptEngine;
 
class EntityEditFilters : public QObject, public Dependency {
    Q_OBJECT
public:
    struct FilterData {
        ScriptValue filterFn;
        bool wantsOriginalProperties { false };
        bool wantsZoneProperties { false };
 
        bool wantsToFilterAdd { true };
        bool wantsToFilterEdit { true };
        bool wantsToFilterPhysics { true };
        bool wantsToFilterDelete { true };
 
        EntityPropertyFlags includedOriginalProperties;
        EntityPropertyFlags includedZoneProperties;
        bool wantsZoneBoundingBox { false };
 
        std::function<bool()> uncaughtExceptions;
        ScriptEnginePointer engine;
        bool rejectAll;
        
        FilterData(): rejectAll(false) {};
        bool valid() { return (rejectAll || (engine != nullptr && filterFn.isFunction() && uncaughtExceptions)); }
    };
 
    EntityEditFilters() {};
    EntityEditFilters(EntityTreePointer tree ): _tree(tree) {};
 
    void addFilter(EntityItemID entityID, QString filterURL);
    void removeFilter(EntityItemID entityID);
 
    bool filter(glm::vec3& position, EntityItemProperties& propertiesIn, EntityItemProperties& propertiesOut, bool& wasChanged, 
                EntityTree::FilterType filterType, EntityItemID& entityID, const EntityItemPointer& existingEntity);
 
signals:
    void filterAdded(EntityItemID id, bool success);
 
private slots:
    void scriptRequestFinished(EntityItemID entityID);
    
private:
    QList<EntityItemID> getZonesByPosition(glm::vec3& position);
 
    EntityTreePointer _tree {};
    bool _rejectAll {false};
    ScriptValue _nullObjectForFilter{};
    
    QReadWriteLock _lock;
    QMap<EntityItemID, FilterData> _filterDataMap;
};
 
#endif //hifi_EntityEditFilters_h