///////////////////////////////////////////////////////////////////////////////
// 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.
///////////////////////////////////////////////////////////////////////////////


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishInkAnnotation.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_POLYLINE_ANNOTATION_INCLUDED_
#define _PDF_PUBLISH_POLYLINE_ANNOTATION_INCLUDED_

#include "PdfPublishMarkupAnnotation.h"
#include "Ge/GePoint2dArray.h"
#include "OdArray.h"
#include "PdfPublishAnnotationBorderStyle.h"

/** \details
  Contains declarations for Publish SDK.
  <group OdPdfPublish_Classes>
*/
namespace OdPdfPublish {

/** \details
  This class implements a polyline annotation in a .pdf document created with Publish SDK.
  Polyline annotations represent a series of connected line segments, defined by a list of vertices.
*/
class PDFPUBLISH_TOOLKIT OdPolylineAnnotation : public OdMarkupAnnotation
{
  //DOM-IGNORE-BEGIN
protected:
  OdPolylineAnnotation();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdPolylineAnnotation);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END

  /** \details
    Destroys the polyline annotation.
  */
  virtual ~OdPolylineAnnotation();

  /** \details
    Sets the vertices of the polyline annotation.
    \param vertices [in] An array of 2D points that define the vertices of the polyline.
    \remarks
    The points are connected in order to form line segments that make up the polyline.
  */
  void setVertices(const OdGePoint2dArray& vertices);

  /** \details
    Sets the border style for the polyline annotation.
    \param style [in] A smart pointer to an annotation border style object.
  */
  void setLineStyle(const OdAnnotationBorderStylePtr& style);

  /** \details
    Sets the line ending styles for the polyline annotation.
    \param start_le [in] The style of the start line ending.
    \param end_le [in] The style of the end line ending.
    \remarks
    Line endings can define styles such as arrows, circles, or no endings.
  */
  void setEndings(const LineEnding::Style& start_le, const LineEnding::Style& end_le);

  /** \details
    Retrieves the vertices of the polyline annotation.
    \param vertices [out] A placeholder for the array of 2D points that define the vertices of the polyline.
  */
  void getVertices(OdGePoint2dArray& vertices) const;

  /** \details
    Retrieves the border style of the polyline annotation.
    \param style [out] A placeholder for the annotation border style.
  */
  void getLineStyle(OdAnnotationBorderStylePtr& style) const;

  /** \details
    Retrieves the line ending styles for the polyline annotation.
    \param start_le [out] A placeholder for the style of the start line ending.
    \param end_le [out] A placeholder for the style of the end line ending.
  */
  void getEndings(LineEnding::Style& start_le, LineEnding::Style& end_le) const;
};

/** \details
  A data type that represents a smart pointer to an <link OdPdfPublish::OdPolylineAnnotation, OdPolylineAnnotation> object.
*/
SMARTPTR(OdPolylineAnnotation);

} // namespace OdPdfPublish

#endif // _PDF_PUBLISH_POLYLINE_ANNOTATION_INCLUDED_