DebugRenderer.h

#pragma once
 
#include <Foundation/Math/Color.h>
#include <Foundation/Math/Transform.h>
#include <RendererCore/Debug/DebugRendererContext.h>
#include <RendererCore/Declarations.h>
#include <RendererCore/RendererCoreDLL.h>
#include <RendererFoundation/Descriptors/Descriptors.h>
 
template <typename Type>
class plRectTemplate;
using plRectFloat = plRectTemplate<float>;
 
class plFormatString;
class plFrustum;
struct plRenderViewContext;
 
struct plDebugTextHAlign
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    Left,
    Center,
    Right,
 
    Default = Left
  };
};
 
PL_DECLARE_REFLECTABLE_TYPE(PL_RENDERERCORE_DLL, plDebugTextHAlign);
 
struct plDebugTextVAlign
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    Top,
    Center,
    Bottom,
 
    Default = Top
  };
};
 
PL_DECLARE_REFLECTABLE_TYPE(PL_RENDERERCORE_DLL, plDebugTextVAlign);
 
struct plDebugTextPlacement
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    TopLeft,
    TopCenter,
    TopRight,
    BottomLeft,
    BottomCenter,
    BottomRight,
 
    ENUM_COUNT,
 
    Default = TopLeft
  };
};
 
PL_DECLARE_REFLECTABLE_TYPE(PL_RENDERERCORE_DLL, plDebugTextPlacement);
 
class PL_RENDERERCORE_DLL plDebugRenderer
{
public:
  struct Line
  {
    PL_DECLARE_POD_TYPE();
 
    Line();
    Line(const plVec3& vStart, const plVec3& vEnd);
    Line(const plVec3& vStart, const plVec3& vEnd, const plColor& color);
 
    plVec3 m_start;
    plVec3 m_end;
 
    plColor m_startColor = plColor::White;
    plColor m_endColor = plColor::White;
  };
 
  struct Triangle
  {
    PL_DECLARE_POD_TYPE();
 
    Triangle();
    Triangle(const plVec3& v0, const plVec3& v1, const plVec3& v2);
 
    plVec3 m_position[3];
    plColor m_color = plColor::White;
  };
 
  struct TexturedTriangle
  {
    PL_DECLARE_POD_TYPE();
 
    plVec3 m_position[3];
    plVec2 m_texcoord[3];
    plColor m_color = plColor::White;
  };
 
  static void DrawLines(const plDebugRendererContext& context, plArrayPtr<const Line> lines, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void Draw2DLines(const plDebugRendererContext& context, plArrayPtr<const Line> lines, const plColor& color);
 
  static void DrawCross(const plDebugRendererContext& context, const plVec3& vGlobalPosition, float fLineLength, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void DrawLineBox(const plDebugRendererContext& context, const plBoundingBox& box, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void DrawLineBoxCorners(const plDebugRendererContext& context, const plBoundingBox& box, float fCornerFraction, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void DrawLineSphere(const plDebugRendererContext& context, const plBoundingSphere& sphere, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void DrawLineCapsuleZ(const plDebugRendererContext& context, float fLength, float fRadius, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void DrawLineCylinderZ(const plDebugRendererContext& context, float fLength, float fRadius, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void DrawLineFrustum(const plDebugRendererContext& context, const plFrustum& frustum, const plColor& color, bool bDrawPlaneNormals = false);
 
  static void DrawSolidBox(const plDebugRendererContext& context, const plBoundingBox& box, const plColor& color, const plTransform& transform = plTransform::MakeIdentity());
 
  static void DrawSolidTriangles(const plDebugRendererContext& context, plArrayPtr<Triangle> triangles, const plColor& color);
 
  static void DrawTexturedTriangles(const plDebugRendererContext& context, plArrayPtr<TexturedTriangle> triangles, const plColor& color, const plTexture2DResourceHandle& hTexture);
 
  static void Draw2DRectangle(const plDebugRendererContext& context, const plRectFloat& rectInPixel, float fDepth, const plColor& color);
 
  static void Draw2DRectangle(const plDebugRendererContext& context, const plRectFloat& rectInPixel, float fDepth, const plColor& color, const plTexture2DResourceHandle& hTexture, plVec2 vScale = plVec2(1, 1));
 
  static void Draw2DRectangle(const plDebugRendererContext& context, const plRectFloat& rectInPixel, float fDepth, const plColor& color, plGALTextureResourceViewHandle hResourceView, plVec2 vScale = plVec2(1, 1));
 
  static plUInt32 Draw2DText(const plDebugRendererContext& context, const plFormatString& text, const plVec2I32& vPositionInPixel, const plColor& color, plUInt32 uiSizeInPixel = 16, plDebugTextHAlign::Enum horizontalAlignment = plDebugTextHAlign::Left, plDebugTextVAlign::Enum verticalAlignment = plDebugTextVAlign::Top);
 
  static void DrawInfoText(const plDebugRendererContext& context, plDebugTextPlacement::Enum placement, plStringView sGroupName, const plFormatString& text, const plColor& color = plColor::White);
 
  static plUInt32 Draw3DText(const plDebugRendererContext& context, const plFormatString& text, const plVec3& vGlobalPosition, const plColor& color, plUInt32 uiSizeInPixel = 16, plDebugTextHAlign::Enum horizontalAlignment = plDebugTextHAlign::Center, plDebugTextVAlign::Enum verticalAlignment = plDebugTextVAlign::Bottom);
 
  static void AddPersistentCross(const plDebugRendererContext& context, float fSize, const plColor& color, const plTransform& transform, plTime duration);
 
  static void AddPersistentLineSphere(const plDebugRendererContext& context, float fRadius, const plColor& color, const plTransform& transform, plTime duration);
 
  static void AddPersistentLineBox(const plDebugRendererContext& context, const plVec3& vHalfSize, const plColor& color, const plTransform& transform, plTime duration);
 
  static void DrawAngle(const plDebugRendererContext& context, plAngle startAngle, plAngle endAngle, const plColor& solidColor, const plColor& lineColor, const plTransform& transform, plVec3 vForwardAxis = plVec3::MakeAxisX(), plVec3 vRotationAxis = plVec3::MakeAxisZ());
 
  static void DrawOpeningCone(const plDebugRendererContext& context, plAngle halfAngle, const plColor& colorInside, const plColor& colorOutside, const plTransform& transform, plVec3 vForwardAxis = plVec3::MakeAxisX());
 
  static void DrawLimitCone(const plDebugRendererContext& context, plAngle halfAngle1, plAngle halfAngle2, const plColor& solidColor, const plColor& lineColor, const plTransform& transform);
 
  static void DrawCylinder(const plDebugRendererContext& context, float fRadiusStart, float fRadiusEnd, float fLength, const plColor& solidColor, const plColor& lineColor, const plTransform& transform, bool bCapStart = false, bool bCapEnd = false);
 
  static void DrawArrow(const plDebugRendererContext& context, float fSize, const plColor& color, const plTransform& transform, plVec3 vForwardAxis = plVec3::MakeAxisX());
 
  static float GetTextGlyphWidth(plUInt32 uiSizeInPixel = 16);
 
  static float GetTextLineHeight(plUInt32 uiSizeInPixel = 16);
 
  static float GetTextScale();
 
  static void SetTextScale(float fScale);
 
private:
  friend class plSimpleRenderPass;
 
  static void RenderScreenSpace(const plRenderViewContext& renderViewContext);
  static void RenderInternalScreenSpace(const plDebugRendererContext& context, const plRenderViewContext& renderViewContext);
 
  static void RenderWorldSpace(const plRenderViewContext& renderViewContext);
  static void RenderInternalWorldSpace(const plDebugRendererContext& context, const plRenderViewContext& renderViewContext);
 
  static void OnEngineStartup();
  static void OnEngineShutdown();
 
  PL_MAKE_SUBSYSTEM_STARTUP_FRIEND(RendererCore, DebugRenderer);
};
 
class PL_RENDERERCORE_DLL plScriptExtensionClass_Debug
{
public:
  static void DrawCross(const plWorld* pWorld, const plVec3& vPosition, float fSize, const plColor& color, const plTransform& transform);
  static void DrawLineBox(const plWorld* pWorld, const plVec3& vPosition, const plVec3& vHalfExtents, const plColor& color, const plTransform& transform);
  static void DrawLineSphere(const plWorld* pWorld, const plVec3& vPosition, float fRadius, const plColor& color, const plTransform& transform);
 
  static void DrawSolidBox(const plWorld* pWorld, const plVec3& vPosition, const plVec3& vHalfExtents, const plColor& color, const plTransform& transform);
 
  static void Draw2DText(const plWorld* pWorld, plStringView sText, const plVec3& vPositionInPixel, const plColor& color, plUInt32 uiSizeInPixel, plEnum<plDebugTextHAlign> horizontalAlignment);
  static void Draw3DText(const plWorld* pWorld, plStringView sText, const plVec3& vPosition, const plColor& color, plUInt32 uiSizeInPixel);
  static void DrawInfoText(const plWorld* pWorld, plStringView sText, plEnum<plDebugTextPlacement> placement, plStringView sGroupName, const plColor& color);
 
  static void AddPersistentCross(const plWorld* pWorld, const plVec3& vPosition, float fSize, const plColor& color, const plTransform& transform, plTime duration);
  static void AddPersistentLineBox(const plWorld* pWorld, const plVec3& vPosition, const plVec3& vHalfExtents, const plColor& color, const plTransform& transform, plTime duration);
  static void AddPersistentLineSphere(const plWorld* pWorld, const plVec3& vPosition, float fRadius, const plColor& color, const plTransform& transform, plTime duration);
};
 
PL_DECLARE_REFLECTABLE_TYPE(PL_RENDERERCORE_DLL, plScriptExtensionClass_Debug);
 
#include <RendererCore/Debug/Implementation/DebugRenderer_inl.h>