/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

#ifndef CRYINCLUDE_EDITOR_INCLUDE_IDISPLAYVIEWPORT_H
#define CRYINCLUDE_EDITOR_INCLUDE_IDISPLAYVIEWPORT_H
#pragma once

struct DisplayContext;
class CBaseObjectsCache;
class QPoint;
class CCamera;
struct AABB;
class CViewport;

// Viewport functionality required for DisplayContext
struct IDisplayViewport
{
    virtual void Update() = 0;
    virtual float GetScreenScaleFactor(const Vec3& position) const = 0;
    virtual float GetScreenScaleFactor(const CCamera& camera, const Vec3& object_position) = 0;
    virtual bool HitTestLine(const Vec3& lineP1, const Vec3& lineP2, const QPoint& hitpoint, int pixelRadius, float* pToCameraDistance = 0) const = 0;

    /**
     * Gets the distance of the point on screen to the line defined by the two points, converted to screenspace.
     * @param lineP1 The first point of the line, in world space.
     * @param lineP2 The second point of the line, in world space.
     * @param point The point to check the distance from the line. This point is in screen space.
     * @return The distance of the point to the line.
    */
    virtual float GetDistanceToLine(const Vec3& lineP1, const Vec3& lineP2, const QPoint& point) const = 0;

    virtual CBaseObjectsCache* GetVisibleObjectsCache() = 0;

    enum EAxis
    {
        AXIS_NONE,
        AXIS_X,
        AXIS_Y,
        AXIS_Z
    };
    virtual void GetPerpendicularAxis(EAxis* axis, bool* is2D) const = 0;

    virtual const Matrix34& GetViewTM() const = 0;
    virtual const Matrix34& GetScreenTM() const = 0;
    virtual QPoint WorldToView(const Vec3& worldPoint) const = 0;
    virtual QPoint WorldToViewParticleEditor(const Vec3& worldPoint, int width, int height) const = 0;
    virtual Vec3 WorldToView3D(const Vec3& worldPoint, int flags = 0) const = 0;
    virtual Vec3 ViewToWorld(const QPoint& vp, bool* collideWithTerrain = nullptr, bool onlyTerrain = false, bool bSkipVegetation = false, bool bTestRenderMesh = false, bool* collideWithObject = nullptr) const = 0;
    virtual void ViewToWorldRay(const QPoint& vp, Vec3& raySrc, Vec3& rayDir) const = 0;
    virtual float GetGridStep() const = 0;
    virtual void setRay(QPoint& vp, Vec3& raySrc, Vec3& rayDir) = 0;
    virtual void setHitcontext(QPoint& vp, Vec3& raySrc, Vec3& rayDir) = 0;

    virtual float GetAspectRatio() const = 0;
    virtual const Plane* GetConstructionPlane() const = 0;

    virtual bool IsBoundsVisible(const AABB& box) const = 0;

    virtual void ScreenToClient(QPoint& pt) const = 0;
    virtual void GetDimensions(int* width, int* height) const = 0;

    virtual CViewport *asCViewport() { return nullptr; }
};

#endif // CRYINCLUDE_EDITOR_INCLUDE_IDISPLAYVIEWPORT_H