gl2d_texts_coll_interface.h

#ifndef SDK_GL2D_TEXT_COLL_INTERFACE_H_
#define SDK_GL2D_TEXT_COLL_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_text_interface.h"
#include "gl2d_texts_visibility_state_interface.h"
 
SDK_GL2D_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IGL2DCanvas);
FWD_DECL_INTERFACE(IGL2DTextsCollEntryPos);
FWD_DECL_INTERFACE(IGL2DTextsCollEntry);
FWD_DECL_INTERFACE(IGL2DTextsColl);
 
class AutoStartFinishTextsCollEdit;
 
typedef GL2DTextID GL2DTextsCollEntryID;
static const GL2DTextsCollEntryID kGL2DUndefinedTextsCollEntryID = 
  kGL2DUndefinedTextID;
 
enum GL2DTextsCollEntryPosPropertyIDs
{
};
 
class IGL2DTextsCollEntryPos : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetCanvas() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Toggle(const bool& visible) throw() = 0;
  virtual bool SDK_CALLTYPE IsVisible() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetPosition(
    const SDKPointF2D& position) throw() = 0;
  virtual SDKPointF2D SDK_CALLTYPE GetPosition() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetTransform(
    const SDKMatrix3X2& position_transform) throw() = 0;
  virtual SDKMatrix3X2 SDK_CALLTYPE GetTransform() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetTextColor(
    const SDKColorF& text_color) throw() = 0;
  virtual SDKColorF SDK_CALLTYPE GetTextColor() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetTextBorderColor(
    const SDKColorF& border_color) throw() = 0;
  virtual SDKColorF SDK_CALLTYPE GetTextBorderColor() const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DTextsCollEntryPos)
  SDK_END_INTERFACE(IGL2DTextsCollEntryPos)
};
SDK_DECLARE_IID(IGL2DTextsCollEntryPos)
 
enum GL2DTextsCollEntryPropertyIDs
{
};
 
class IGL2DTextsCollEntry : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetCanvas() const throw() = 0;
 
  virtual GL2DTextsCollEntryID SDK_CALLTYPE GetID() const throw() = 0;
 
  virtual GL2DTextType SDK_CALLTYPE GetType() 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 SDKUInt32 SDK_CALLTYPE GetTextCenterLine() const throw() = 0;
  virtual SDKSize SDK_CALLTYPE GetTextSize() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDefaultPositionTransform(
    const SDKMatrix3X2& def_pos_transform) throw() = 0;
  virtual SDKMatrix3X2 SDK_CALLTYPE GetDefaultPositionTransform() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDefaultTextColor(
    const SDKColorF& def_text_color) throw() = 0;
  virtual SDKColorF SDK_CALLTYPE GetDefaultTextColor() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDefaultTextBorderColor(
    const SDKColorF& def_text_border_color) throw() = 0;
  virtual SDKColorF SDK_CALLTYPE GetDefaultTextBorderColor() const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE TogglePositions(const bool& visible) throw() = 0;
  virtual SDKResult SDK_CALLTYPE ApplyPositionTransform(
    const SDKMatrix3X2& pos_transform) throw() = 0;
  virtual SDKResult SDK_CALLTYPE ApplyTextColor(
    const SDKColorF& text_color) throw() = 0;
  virtual SDKResult SDK_CALLTYPE ApplyTextBorderColor(
    const SDKColorF& text_border_color) throw() = 0;
 
  virtual IGL2DTextsCollEntryPosSP SDK_CALLTYPE AddPosition(
    const SDKPointF2D& position) throw() = 0;
  virtual SDKResult SDK_CALLTYPE RemovePosition(
    const SDKUInt32& index) throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetPositionsCount() const throw() = 0;
  virtual IGL2DTextsCollEntryPosSP SDK_CALLTYPE GetPositionByIndex(
    const SDKUInt32& index) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DTextsCollEntry)
  SDK_END_INTERFACE(IGL2DTextsCollEntry)
};
SDK_DECLARE_IID(IGL2DTextsCollEntry)
 
enum GL2DTextsCollPropertyIDs
{
};
 
class IGL2DTextsColl : public ISDKProperties
{
public:
  virtual void SDK_CALLTYPE Dump() const throw() = 0;
 
  virtual IGL2DCanvasSP SDK_CALLTYPE GetParent() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetMemSize() const throw() = 0;
  virtual SDKUInt32 SDK_CALLTYPE GetActiveTextPositionsCount() const throw() = 0;
 
  virtual SDKUInt32 SDK_CALLTYPE GetTextsCount() const throw() = 0;
  virtual IGL2DTextsCollEntrySP SDK_CALLTYPE GetTextByIndex(
    const SDKUInt32& index) const throw() = 0;
  virtual IGL2DTextsCollEntrySP SDK_CALLTYPE GetTextByID(
    const GL2DTextsCollEntryID& id) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE StartEdit() throw() = 0;
  virtual SDKResult SDK_CALLTYPE FinishEdit() throw() = 0;
  virtual bool SDK_CALLTYPE IsEditing() const throw() = 0;
 
protected:
  virtual IGL2DTextsCollEntrySP SDK_CALLTYPE AddText(
    const IGL2DTextSP& text, const SDKColorF& text_color, 
    const SDKColorF& border_color) throw() = 0;
public:
 
  inline IGL2DTextsCollEntrySP SDK_CALLTYPE AddGenericText(
    const IGL2DTextSP& text)
  {
    const SDKColorF inv_clr = { -1.0f, -1.0f, -1.0f, -1.0f };
    return AddText(text, inv_clr, inv_clr);
  }
  inline IGL2DTextsCollEntrySP SDK_CALLTYPE AddSimpleText(
    const IGL2DTextSP& text, const SDKColorF& text_color)
  {
    const SDKColorF inv_border_clr = { -1.0f, -1.0f, -1.0f, -1.0f };
    return AddText(text, text_color, inv_border_clr);
  }
  inline IGL2DTextsCollEntrySP SDK_CALLTYPE AddBorderedText(
    const IGL2DTextSP& text, const SDKColorF& text_color, 
    const SDKColorF& border_color)
  { return AddText(text, text_color, border_color); }
 
  virtual SDKResult SDK_CALLTYPE RemoveText(
    const GL2DTextsCollEntryID& text_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Toggle(
    const IGL2DTextsVisStateSP& texts_visibility_state) throw() = 0;
 
  SDK_IMPLEMENT_IID(IGL2DTextsColl)
  SDK_END_INTERFACE(IGL2DTextsColl)
};
SDK_DECLARE_IID(IGL2DTextsColl)
 
class AutoStartFinishTextsCollEdit
{
public:
  AutoStartFinishTextsCollEdit(const IGL2DTextsCollSP& texts_coll)
    : m_texts_coll(texts_coll), m_started(false)
  {
    if (m_texts_coll)
      m_started = SDK_SUCCEEDED(m_texts_coll->StartEdit());
  }
 
  virtual ~AutoStartFinishTextsCollEdit()
  { if (m_started) m_texts_coll->FinishEdit(); }
 
  inline bool IsEditing() const
  { return m_texts_coll ? m_texts_coll->IsEditing() : false; }
 
private:
  const IGL2DTextsCollSP m_texts_coll;
  bool                   m_started;
};
 
SDK_GL2D_END_NAMESPACE
 
#endif // SDK_GL2D_TEXT_COLL_INTERFACE_H_