/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, 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-2025 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 _NW_PLOTFONTSTYLE_H_
#define _NW_PLOTFONTSTYLE_H_
#include "NwObject.h"
#include "NwPlotEnums.h"

/** \details
  This class represents geometry.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwPlotFontStyle : public OdNwObject
{
  ODRX_DECLARE_MEMBERS(OdNwPlotFontStyle);

  /** \details
    Default constructor. Creates an OdNwPlotFontStyle object.
  */
  OdNwPlotFontStyle();

public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwPlotFontStyle();
public:
  /** \details
    Returns the canonical typeface for the font.

    \returns The canonical typeface for the font.
    \remarks Typefaces for vertical fonts are started with an '@'.
  */
  OdString getTypeface() const;
  /** \details
    Returns the point size of the text.

    \returns An OdUInt32 value of point size.
    \remarks This value has no effect on the rendered size of the text. It just
             determines which font is used. The default value for this is 50pt.
  */
  OdInt32 getPointSize() const;
  /** \details
    Returns the character traits (bitfield) for the font.

    \returns OdUInt32 as a set of NwPlotFontStyleCharacterTraits flags.
  */
  OdInt32 getCharacterTraits() const;
  /** \details
    Returns the weight of the font.

    \returns NwPlotFontStyleWeight enumeration with the weight of the font.
  */
  NwPlotFontStyleWeight::Enum getWeight() const;
  /** \details
    Returns the character set of the font.

    \returns NwPlotFontStyleCharacterSet enumeration with the character set of the font.
    \remarks Can be used for font mapping if the font is not present in the system.
  */
  NwPlotFontStyleCharacterSet::Enum getCharacterSet() const;
  /** \details
    Returns the pitch of the font.

    \returns NwPlotFontPitch enumeration with the pitch of the font.
    \remarks Can be used for font mapping if the font is not present in the system.
  */
  NwPlotFontPitch::Enum getPitch() const;
  /** \details
    Returns the pitch of the family.

    \returns NwPlotFontFamily enumeration with the family of the font.
    \remarks Can be used for font mapping if the font is not present in the system.
  */
  NwPlotFontFamily::Enum getFamily() const;
  /** \details
    Returns the embedded font.

    \returns OdNwObjectId object of the embedded font.
  */
  OdNwObjectId getEmbeddedFont() const;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for OdNwPlotFontStyle object pointers.
*/
typedef OdSmartPtr<OdNwPlotFontStyle> OdNwPlotFontStylePtr;

#endif // _NW_PLOTFONTSTYLE_H_