/////////////////////////////////////////////////////////////////////////////// 
// 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_PLOTPATHFIGURESTYLE_H_
#define _NW_PLOTPATHFIGURESTYLE_H_
#include "NwObject.h"
#include "NwPlotEnums.h"

/** \details
  This class represents path figure style.

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

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

public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwPlotPathFigureStyle();

public:
  /** \details
   Indicates whether the path of the figure is closed.

   \returns True if the path of the figure is closed, otherwise returns false.
  */
  bool isClosed() const;

  /** \details
   Indicates whether the figure is filled.

   \returns True if the figure is filled, otherwise returns false.
  */
  bool isFilled() const;

  /** \details
    Gets the polyline connection rule.

    \returns A polyline connection rule as one of the item of the NwPlotPolyLineConnectRule enum.

    \remarks
    Returned value can be one of the following:

    <table>
    Name                                                                  Value   Description
    NwPlotPolyLineConnectRule::NW_PLOT_POLYLINE_CONNECT_RULE_LINE_STRIP   0x00    Strip
    NwPlotPolyLineConnectRule::NW_PLOT_POLYLINE_CONNECT_RULE_LINE_LIST    0x01    List
    </table>
  */
  NwPlotPolyLineConnectRule::Enum getPolylineConnectRule() const;
};

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

#endif // _NW_PLOTPATHFIGURESTYLE_H_