//
//  Base3DOverlay.h
//  interface/src/ui/overlays
//
//  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
//

#ifndef hifi_Base3DOverlay_h
#define hifi_Base3DOverlay_h

#include <Transform.h>
#include <SpatiallyNestable.h>

#include "Overlay.h"

class Base3DOverlay : public Overlay, public SpatiallyNestable {
    Q_OBJECT

public:
    Base3DOverlay();
    Base3DOverlay(const Base3DOverlay* base3DOverlay);

    virtual OverlayID getOverlayID() const override { return OverlayID(getID().toString()); }
    void setOverlayID(OverlayID overlayID) override { setID(overlayID); }

    virtual QString getName() const override { return QString("Overlay:") + _name; }
    void setName(QString name) { _name = name; }

    // getters
    virtual bool is3D() const override { return true; }

    // TODO: consider implementing registration points in this class
    glm::vec3 getCenter() const { return getPosition(); }

    float getLineWidth() const { return _lineWidth; }
    bool getIsSolid() const { return _isSolid; }
    bool getIsDashedLine() const { return _isDashedLine; }
    bool getIsSolidLine() const { return !_isDashedLine; }
    bool getIgnoreRayIntersection() const { return _ignoreRayIntersection; }
    bool getDrawInFront() const { return _drawInFront; }
    bool getIsGrabbable() const { return _isGrabbable; }

    void setLineWidth(float lineWidth) { _lineWidth = lineWidth; }
    void setIsSolid(bool isSolid) { _isSolid = isSolid; }
    void setIsDashedLine(bool isDashedLine) { _isDashedLine = isDashedLine; }
    void setIgnoreRayIntersection(bool value) { _ignoreRayIntersection = value; }
    void setDrawInFront(bool value) { _drawInFront = value; }
    void setIsGrabbable(bool value) { _isGrabbable = value; }

    virtual AABox getBounds() const override = 0;

    void update(float deltatime) override;
    
    void notifyRenderTransformChange() const;

    void setProperties(const QVariantMap& properties) override;
    QVariant getProperty(const QString& property) override;

    virtual bool findRayIntersection(const glm::vec3& origin, const glm::vec3& direction, float& distance,
                                        BoxFace& face, glm::vec3& surfaceNormal);

    virtual bool findRayIntersectionExtraInfo(const glm::vec3& origin, const glm::vec3& direction,
                                        float& distance, BoxFace& face, glm::vec3& surfaceNormal, QString& extraInfo) {
        return findRayIntersection(origin, direction, distance, face, surfaceNormal);
    }

protected:
    virtual void locationChanged(bool tellPhysics = true) override;
    virtual void parentDeleted() override;

    mutable Transform _renderTransform;
    virtual Transform evalRenderTransform();
    virtual void setRenderTransform(const Transform& transform);
    const Transform& getRenderTransform() const { return _renderTransform; }

    float _lineWidth;
    bool _isSolid;
    bool _isDashedLine;
    bool _ignoreRayIntersection;
    bool _drawInFront;
    bool _isGrabbable { false };
    mutable bool _renderTransformDirty{ true };

    QString _name;
};

#endif // hifi_Base3DOverlay_h