TtfDescriptor.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _OdTtfDescriptor_h_Included_
#define _OdTtfDescriptor_h_Included_
 
#include "TD_PackPush.h"
 
#include "Gi/Gi.h"
#include "OdString.h"
#include "OdFont.h"
 
enum TextRenderingMode
{
  kTextRenderingBasedA = 0,
  kTextRenderingBasedM = 1
};

class FIRSTDLL_EXPORT OdTtfDescriptor
{
  // Members
 
        OdUInt32                    m_nFlags;
  OdString                    m_sFontFile;
        OdString                    m_Typeface;
  TextRenderingMode           m_renderingMode;
 
public:
  // Constructor
 
  OdTtfDescriptor() : m_nFlags(0), m_renderingMode(kTextRenderingBasedA)
  {
  }

  OdTtfDescriptor(const OdString& typeface, bool bold, bool italic, int charset, int pitchAndFamily)
    : m_nFlags(0), m_Typeface(typeface), m_renderingMode(kTextRenderingBasedA)
  {
    setTtfFlags(bold, italic, charset, pitchAndFamily);
  }
 
  // Accessors /transformers

  const OdString &fileName() const     { return m_sFontFile; }

  const OdString &typeface() const     { return m_Typeface;  }

  OdUInt32 getTtfFlags() const  { return m_nFlags;    }

  void clearFileName()
  { 
    m_sFontFile.empty();  
  }

  void clearTypeface()
  { 
    m_Typeface.empty();  
  }

  void addTypeface(OdChar typeface)
  { 
    m_Typeface += typeface;
  }

        void getTtfFlags(bool& bold, bool& italic, int& charset, int& pitchAndFamily) const
  {
          bold = isBold();
          italic = isItalic();
          charset = charSet();
          pitchAndFamily = this->pitchAndFamily();
  }

  void setFileName(const OdString& filename)  { m_sFontFile = filename; }
  void setTypeFace(const OdString& typeface)  { m_Typeface = typeface;  }
  void setTtfFlags(OdUInt32 flags)           { m_nFlags = flags;      }
  void setTtfFlags(bool bold, bool italic, int charset, int pitchAndFamily)
  {
    setBold(bold);
    setItalic(italic);
    setCharSet(charset);
    setPitchAndFamily(pitchAndFamily);
  }

   void setBold(bool bold)          { SETBIT(m_nFlags, 0x02000000, bold);  }
   void setItalic(bool italic)        { SETBIT(m_nFlags, 0x01000000, italic);  }
   void setCharSet(int charset)        { m_nFlags = ((m_nFlags & 0xFFFF00FF) | ((charset << 8) & 0x0000FF00)); }
  void setPitchAndFamily(int pitchAndFamily) { m_nFlags = ((m_nFlags & 0xFFFFFF00) | (pitchAndFamily & 0x000000FF));  }

  bool isBold() const             { return GETBIT(m_nFlags, 0x02000000);  }
  bool isItalic() const           { return GETBIT(m_nFlags, 0x01000000);  }
  OdUInt16 charSet() const        { return OdUInt16((m_nFlags & 0x0000ff00) >> 8); }
  int pitchAndFamily() const      { return (m_nFlags & 0x000000ff); }

  int getPitch() const            { return (pitchAndFamily() & 0x00000003); }
  int getFamily() const           { return (pitchAndFamily() & 0x000000f0); }

  TextRenderingMode textRenderingMode() const { return m_renderingMode; }

  void setTextRenderingMode(TextRenderingMode renderingMode) { m_renderingMode = renderingMode; }
 
};
 
#include "TD_PackPop.h"
 
#endif // _OdTtfDescriptor_h_Included_