gl2d_text_interface.h

Go to the documentation of this file.

#ifndef SDK_GL2D_TEXT_INTERFACE_H_
#define SDK_GL2D_TEXT_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_base.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <visualizationlayer/inc/vis_const.h>
 
#include "gl2d_texture_interface.h"
#include "gl2d_font_interface.h"
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DText);
 
enum GL2DTextPropertyIDs
{
  kGL2DTextPropertyID_BorderWidth       = 0,
 
  kGL2DTextPropertyID_BorderTextTexture = 1,
};
 
enum GL2DTextType
{
  // Simple text
  // Horizontal one line text only without word-wrapping, etc
  // Arabian language definitely not implemented
  kGL2DTextType_Simple   = 0,
 
  // Bordered text
  // Same as Simple, i.e. horizontal one line text only without word-wrapping, etc
  // but in addition text will be bordered 
  // (with same text but with increased stroke size and using different color)
  // Arabian language definitely not implemented
  kGL2DTextType_Bordered = 1,
};
 
enum GL2DTextPivotPoint
{
  // Unknown pivot point type
  kGL2DTextPivotPoint_Unknown     = 0,
 
  // Text top -----------------> 3------------------4------------------5
  //                             | XXXXXXX  XXXXX X    X XXXXXXX    X  |
  //                             |    X     X      X  X     X      XX  |
  //                             |    X     X       XX      X     X X  |
  //                             2    X     XXXX    10      X       X  6
  //                             |    X     X      X  X     X       X  |
  // Text center line ---------> 1    X     XXXXX X    X    X      XXX |
  //                             |                                     |
  // Text bottom --------------> 9------------------8------------------7
  //                             ^                                     ^
  //                             |                                     |
  //                             |                                     |
  //                             |                                     |
  //                    Text left border                       Text right border
  //                       
 
  // Pivot point at text left border by Ox, at center line by Oy
  // (See 1)
  kGL2DTextPivotPoint_Default     = 1, 
 
  // Pivot point at text left border by Ox, at the middle of height by Oy
  // (See 2)
  kGL2DTextPivotPoint_MidLeft     = 2, 
 
  // Pivot point at text left border by Ox, at text top by Oy
  // (See 3)
  kGL2DTextPivotPoint_TopLeft     = 3,
 
  // Pivot point at the middle of text by width for Ox, at text top by Oy
  // (See 4)
  kGL2DTextPivotPoint_MidTop      = 4,
 
  // Pivot point at text right border by Ox, at text top by Oy
  // (See 5)
  kGL2DTextPivotPoint_TopRight    = 5,
 
  // Pivot point at text right border by Ox, at the middle of height by Oy
  // (See 6)
  kGL2DTextPivotPoint_MidRight    = 6,
 
  // Pivot point at text right border by Ox, at text bottom by Oy
  // (See 7)
  kGL2DTextPivotPoint_BottomRight = 7,
 
  // Pivot point at the middle of text by width for Ox, at text bottom by Oy
  // (See 8)
  kGL2DTextPivotPoint_MidBottom   = 8,
 
  // Pivot point at text left border by Ox, at text bottom by Oy
  // (See 9)
  kGL2DTextPivotPoint_BottomLeft  = 9,
 
  // Pivot point at text center
  // (See 10)
  kGL2DTextPivotPoint_Center      = 10,
};
 
enum GL2DTextReadingDirection
{
  // Left to right reading direction
  kGL2DTextReadingDirection_LeftToRight = 0,
  kGL2DReadDir_LTR                      = kGL2DTextReadingDirection_LeftToRight,
 
  // Right to left reading direction
  kGL2DTextReadingDirection_RightToLeft = 1,
  kGL2DReadDir_RTL                      = kGL2DTextReadingDirection_RightToLeft,
};
 
class IGL2DText : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual GL2DTextType SDK_CALLTYPE GetType() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetVertexCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetTextPositionsCount() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const throw() = 0;
 
  virtual IGL2DFontSP SDK_CALLTYPE GetFont() const throw() = 0;
  inline GL2DFontID SDK_CALLTYPE GetFontID() const
  {
    const IGL2DFontSP font = GetFont();
    return font ? font->GetID() : kGL2DUnknownFontID;
  }
 
  virtual SDKResult SDK_CALLTYPE GetTextString(
    SDKString& text_string) const throw() = 0;
  virtual float SDK_CALLTYPE GetFontSize() const throw() = 0;
  virtual GL2DTextReadingDirection SDK_CALLTYPE GetReadingDirection() const throw() = 0;
  virtual GL2DTextPivotPoint SDK_CALLTYPE GetPivotPoint() const throw() = 0;
  virtual SDKPointF2D SDK_CALLTYPE GetPivotPointOffset() const throw() = 0;
  virtual float SDK_CALLTYPE GetBorderWidth() const throw() = 0;
 
  virtual IGL2DTextureSP SDK_CALLTYPE GetTexture() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetTextCenterLine() const throw() = 0;
  virtual SDKSize SDK_CALLTYPE GetTextSize() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clone(const float* const vertex_data, 
    const SDKUInt32& vertex_data_size, IGL2DTextSP& cloned_text) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DText)
  SDK_END_INTERFACE(IGL2DText)
};
SDK_DECLARE_IID(IGL2DText)
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_TEXT_INTERFACE_H_