// Created on: 2011-07-13
// Created by: Sergey ZERCHANINOV
// Copyright (c) 2011-2013 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef OpenGl_Text_HeaderFile
#define OpenGl_Text_HeaderFile

#include "OpenGl_Element.hxx"

#include "OpenGl_TextBuilder.hxx"

#include "Graphic3d_RenderingParams.hxx"
#include "Graphic3d_Text.hxx"

//! Text rendering
class OpenGl_Text : public OpenGl_Element
{

public:
  //! Creates new text in 3D space.
  Standard_EXPORT OpenGl_Text(const occ::handle<Graphic3d_Text>& theTextParams);

  //! Destructor
  Standard_EXPORT ~OpenGl_Text() override;

  //! Release cached VBO resources and the previous font if height changed.
  //! Cached structures will be refilled by the next render.
  //! Call Reset after modifying text parameters.
  Standard_EXPORT void Reset(const occ::handle<OpenGl_Context>& theCtx);

  //! Returns text parameters
  //! @sa Reset()
  const occ::handle<Graphic3d_Text>& Text() const { return myText; }

  //! Sets text parameters
  //! @sa Reset()
  void SetText(const occ::handle<Graphic3d_Text>& theText) { myText = theText; }

  //! Return true if text is 2D
  bool Is2D() const { return myIs2d; }

  //! Set true if text is 2D
  void Set2D(const bool theEnable) { myIs2d = theEnable; }

  //! Setup new font size
  Standard_EXPORT void SetFontSize(const occ::handle<OpenGl_Context>& theContext,
                                   const int                          theFontSize);

  Standard_EXPORT void Render(const occ::handle<OpenGl_Workspace>& theWorkspace) const override;
  Standard_EXPORT void Release(OpenGl_Context* theContext) override;

  //! Returns estimated GPU memory usage for holding data without considering overheads and
  //! allocation alignment rules.
  Standard_EXPORT size_t EstimatedDataSize() const override;

  //! Increment draw calls statistics.
  Standard_EXPORT void UpdateDrawStats(Graphic3d_FrameStatsDataTmp& theStats,
                                       bool                         theIsDetailed) const override;

public: //! @name methods for compatibility with layers
  //! Empty constructor
  Standard_EXPORT OpenGl_Text();

  //! Create key for shared resource
  Standard_EXPORT static TCollection_AsciiString FontKey(const OpenGl_Aspects& theAspect,
                                                         int                   theHeight,
                                                         unsigned int          theResolution,
                                                         Font_Hinting          theFontHinting);

  //! Find shared resource for specified font or initialize new one
  Standard_EXPORT static occ::handle<OpenGl_Font> FindFont(
    const occ::handle<OpenGl_Context>& theCtx,
    const OpenGl_Aspects&              theAspect,
    int                                theHeight,
    unsigned int                       theResolution,
    Font_Hinting                       theFontHinting,
    const TCollection_AsciiString&     theKey);

  //! Compute text width
  Standard_EXPORT static void StringSize(const occ::handle<OpenGl_Context>& theCtx,
                                         const NCollection_String&          theText,
                                         const OpenGl_Aspects&              theTextAspect,
                                         const float                        theHeight,
                                         const unsigned int                 theResolution,
                                         const Font_Hinting                 theFontHinting,
                                         float&                             theWidth,
                                         float&                             theAscent,
                                         float&                             theDescent);

  //! Perform rendering
  Standard_EXPORT void Render(
    const occ::handle<OpenGl_Context>& theCtx,
    const OpenGl_Aspects&              theTextAspect,
    unsigned int theResolution  = Graphic3d_RenderingParams::THE_DEFAULT_RESOLUTION,
    Font_Hinting theFontHinting = Font_Hinting_Off) const;

  //! Dumps the content of me into the stream
  Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;

  //! @name obsolete methods
public:
  //! Setup new string and position
  Standard_DEPRECATED(
    "Deprecated method Init() with obsolete arguments, use Init() and Text() instead of it")
  Standard_EXPORT void Init(const occ::handle<OpenGl_Context>& theCtx,
                            const char*                        theText,
                            const NCollection_Vec3<float>&     thePoint);

  //! Setup new position
  Standard_DEPRECATED("Deprecated method SetPosition(), use Graphic3d_Text for it")
  Standard_EXPORT void SetPosition(const NCollection_Vec3<float>& thePoint);

protected:
  friend class OpenGl_Trihedron;
  friend class OpenGl_GraduatedTrihedron;

  //! Release cached VBO resources
  Standard_EXPORT void releaseVbos(OpenGl_Context* theCtx);

private:
  //! Setup matrix.
  void setupMatrix(const occ::handle<OpenGl_Context>& theCtx,
                   const OpenGl_Aspects&              theTextAspect,
                   const NCollection_Vec3<float>&     theDVec) const;

  //! Draw arrays of vertices.
  void drawText(const occ::handle<OpenGl_Context>& theCtx,
                const OpenGl_Aspects&              theTextAspect) const;

  //! Draw rectangle from bounding text box.
  void drawRect(const occ::handle<OpenGl_Context>& theCtx,
                const OpenGl_Aspects&              theTextAspect,
                const NCollection_Vec4<float>&     theColorSubs) const;

  //! Main rendering code
  void render(const occ::handle<OpenGl_Context>& theCtx,
              const OpenGl_Aspects&              theTextAspect,
              const NCollection_Vec4<float>&     theColorText,
              const NCollection_Vec4<float>&     theColorSubs,
              unsigned int                       theResolution,
              Font_Hinting                       theFontHinting) const;

protected:
  occ::handle<Graphic3d_Text>              myText; //!< text parameters
  mutable occ::handle<OpenGl_Font>         myFont;
  mutable NCollection_DynamicArray<GLuint> myTextures; //!< textures' IDs
  mutable NCollection_DynamicArray<occ::handle<OpenGl_VertexBuffer>>
    myVertsVbo; //!< VBOs of vertices
                // clang-format off
  mutable NCollection_DynamicArray<occ::handle<OpenGl_VertexBuffer>> myTCrdsVbo;   //!< VBOs of texture coordinates
  mutable occ::handle<OpenGl_VertexBuffer>                     myBndVertsVbo;//!< VBOs of vertices for bounding box
                                                        // clang-format on
  mutable Font_Rect myBndBox;

protected:
  mutable NCollection_Mat4<double> myProjMatrix;
  mutable NCollection_Mat4<double> myModelMatrix;
  mutable NCollection_Mat4<double> myOrientationMatrix;
  mutable NCollection_Vec3<double> myWinXYZ;
  mutable GLdouble                 myScaleHeight;

protected:
  bool myIs2d;

public:
  DEFINE_STANDARD_ALLOC
};

#endif // OpenGl_Text_Header