/*
* 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.

// Description : Helper functions to draw some interesting debug shapes.


#ifndef CRYINCLUDE_CRYAISYSTEM_AIDEBUGDRAWHELPERS_H
#define CRYINCLUDE_CRYAISYSTEM_AIDEBUGDRAWHELPERS_H
#pragma once

#include <IRenderer.h>
#include <Cry_Vector3.h>

// Draws a circle constrained on XY-plane.
void DebugDrawCircleOutline(IRenderer* pRend, const Vec3& pos, float rad, ColorB col);

// Draws a capsule constrained on XY-plane.
void DebugDrawCapsuleOutline(IRenderer* pRend, const Vec3& pos0, const Vec3& pos1, float rad, ColorB col);

// Draws a wire frame sphere (circle per plane).
void DebugDrawWireSphere(IRenderer* pRend, const Vec3& pos, float rad, ColorB col);

// Draws a wire frame cone.
void DebugDrawWireFOVCone(IRenderer* pRend, const Vec3& pos, const Vec3& dir, float rad, float fov, ColorB col);

// Draws an arrow constrained on XY-plane along the length-vector.
void DebugDrawArrow(IRenderer* pRend, const Vec3& pos, const Vec3& length, float width, ColorB col);

// Draws a circle constrained on XY-plane with hem.
void DebugDrawRangeCircle(IRenderer* pRend, const Vec3& pos, float rad, float width,
    ColorB colFill, ColorB colOutline, bool drawOutline);

// Draws an arc constrained on XY-plane with hem.
void DebugDrawRangeArc(IRenderer* pRend, const Vec3& pos, const Vec3& dir, float angle, float rad, float width,
    ColorB colFill, ColorB colOutline, bool drawOutline);

// Draws a box constrained on XY-plane with hem.
void DebugDrawRangeBox(IRenderer* pRend, const Vec3& pos, const Vec3& dir, float sizex, float sizey, float width,
    ColorB colFill, ColorB colOutline, bool drawOutline);

// Draws a polygon with a hem constrained on XY-plane.
template<typename containerType>
void DebugDrawRangePolygon(IRenderer* pRend, const containerType& polygon, float width,
    ColorB colFill, ColorB colOutline, bool drawOutline);

// Draw
void DebugDrawLabel(IRenderer* pRenderer, int col, int row, const char* szText, float* pColor);

// Draw agent circles.
void DebugDrawCircles(IRenderer* pRenderer, const Vec3& pos,
    float minRadius, float maxRadius, int numRings,
    const ColorB& insideCol, const ColorB& outsideCol);

// Debug oriented 2d ellipse
void DebugDrawEllipseOutline(IRenderer* pRend, const Vec3& pos, float radx, float rady, float orientation, ColorB col);

/// Returns the z value that should be used for drawing the point, depending on if it should be relative to terrain.
/// If relative to the terrain then if the m_dbgDrawOffsetZ is <= 0, -m_dbgDrawOffsetZ is returned
float GetDebugDrawZ(const Vec3& pt, bool useTerrain);

float GetDebugDrawOffset();

// Returns camera position.
Vec3 GetDebugCameraPos();




#endif // CRYINCLUDE_CRYAISYSTEM_AIDEBUGDRAWHELPERS_H